bokeh.client.connection¶

Implements a very low level facility for communicating with a Bokeh Server.

Users will always want to use ClientSession instead for standard usage.

class ClientConnection(session, websocket_url, io_loop=None, arguments=None, max_message_size=20971520)[source]¶

A Bokeh low-level class used to implement ClientSession; use ClientSession to connect to the server.

__init__(session, websocket_url, io_loop=None, arguments=None, max_message_size=20971520)[source]¶: Opens a websocket connection to the server.

force_roundtrip()[source]¶

Force a round-trip request/reply to the server, sometimes needed to avoid race conditions. Mostly useful for testing.

Outside of test suites, this method hurts performance and should not be needed.

loop_until_closed()[source]¶

Execute a blocking loop that runs and executes event callbacks until the connection is closed (e.g. by hitting Ctrl-C).

While this method can be used to run Bokeh application code “outside” the Bokeh server, this practice is HIGHLY DISCOURAGED for any real use case.

pull_doc(document)[source]¶

Pull a document from the server, overwriting the passed-in document

Parameters: document – (Document) The document to overwrite with server content.
Returns: None

push_doc(document)[source]¶

Push a document to the server, overwriting any existing server-side doc.

request_server_info()[source]¶

Ask for information about the server.

property connected¶: Whether we’ve connected the Websocket and have exchanged initial handshake messages.

property error_code¶: If there was an error that caused a disconnect, this property holds the error code. None otherwise.

property error_detail¶: If there was an error that caused a disconnect, this property holds the error detail. Empty string otherwise.

property error_reason¶: The reason of the connection loss encoded as a DISCONNECTED.ErrorReason enum value