bokeh.server.session

Provides the ServerSession class.

class ServerSession(session_id: ID, document: Document, io_loop: Loop | None = None, token: str | None = None, executor: _ServerExecutor | None = None)

Hosts an application “instance” (an instantiated Document) for one or more connections.

classmethod patch(message: msg.patch_doc, connection: ServerConnection) → Awaitable[msg.ok]

Handle a PATCH-DOC, return a Future with work to be scheduled.

classmethod pull(message: msg.pull_doc_req, connection: ServerConnection) → Awaitable[None]

Handle a PULL-DOC, return a Future with work to be scheduled.

classmethod push(message: msg.push_doc, connection: ServerConnection) → Awaitable[msg.ok]

Handle a PUSH-DOC, return a Future with work to be scheduled.

notify_connection_lost() → None

Notify the document that the connection was lost.

request_expiration() → None

Used in test suite for now. Forces immediate expiration if no connections.

subscribe(connection: ServerConnection) → None

This should only be called by ServerConnection.subscribe_session or our book-keeping will be broken

unsubscribe(connection: ServerConnection) → None

This should only be called by ServerConnection.unsubscribe_session or our book-keeping will be broken

async with_document_locked(func: Callable[[...], T], *args: Any, **kwargs: Any) → T

Asynchronously locks the document and runs the function with it locked.

property token: str

A JWT token to authenticate the session.

current_time() → float

Return the time in milliseconds since the epoch as a floating point number.