bokeh.client.connection

实现了一个非常底层的工具，用于与 Bokeh 服务器通信。

对于标准用法，用户始终应该使用 ClientSession。

class ClientConnection(session: ClientSession, websocket_url: str, io_loop: IOLoop | None = None, arguments: dict[str, str] | None = None, max_message_size: int = 20971520)

一个用于连接到 Bokeh 服务器的底层类。

__init__(session: ClientSession, websocket_url: str, io_loop: IOLoop | None = None, arguments: dict[str, str] | None = None, max_message_size: int = 20971520) → None

打开与服务器的 WebSocket 连接。

close(why: str = 'closed') → None

关闭 WebSocket 连接。

force_roundtrip() → None

强制与服务器进行往返请求/响应，有时需要避免竞争条件。主要用于测试。

在测试套件之外，此方法会降低性能，并且通常不需要。

返回:

无

loop_until_closed() → None

执行一个阻塞循环，该循环运行并执行事件回调，直到连接关闭（例如，通过按下 Ctrl-C）。

虽然此方法可以用于在 Bokeh 服务器“外部”运行 Bokeh 应用程序代码，但对于任何实际用例，都强烈建议不要这样做。

pull_doc(document: Document) → None

从服务器拉取文档，覆盖传入的文档

参数:

document – (文档) 要使用服务器内容覆盖的文档。

返回:

无

push_doc(document: Document) → Message[Any]

将文档推送到服务器，覆盖任何现有的服务器端文档。

参数:

document – (文档) 要推送到服务器的文档

返回:

服务器回复

request_server_info() → ServerInfo

请求服务器信息。

返回:

服务器属性的字典。

property connected: bool

我们是否已连接 WebSocket 并已交换初始握手消息。

property error_code: int | None

如果发生导致断开连接的错误，则此属性保存错误代码。否则为 None。

property error_detail: str

如果发生导致断开连接的错误，则此属性保存错误详细信息。否则为空字符串。

property error_reason: ErrorReason | None

连接丢失的原因，编码为 DISCONNECTED.ErrorReason 枚举值

property io_loop: IOLoop

此连接正在使用的 Tornado IOLoop。

property url: str

此连接所连接到的 websocket 的 URL。