bokeh.server.session

Provides the ServerSession class.

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

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

Public Data Attributes:

document
id
token	A JWT token to authenticate the session.
destroyed
expiration_requested
expiration_blocked
expiration_blocked_count
connection_count
milliseconds_since_last_unsubscribe

Public Methods:

__init__(session_id, document[, io_loop, token])
destroy()
request_expiration()	Used in test suite for now.
block_expiration()
unblock_expiration()
subscribe(connection)	This should only be called by ServerConnection.subscribe_session or our book-keeping will be broken
unsubscribe(connection)	This should only be called by ServerConnection.unsubscribe_session or our book-keeping will be broken
with_document_locked(*args, **kwargs)
pull(message, connection)	Handle a PULL-DOC, return a Future with work to be scheduled.
push(message, connection)	Handle a PUSH-DOC, return a Future with work to be scheduled.
patch(message, connection)	Handle a PATCH-DOC, return a Future with work to be scheduled.

---

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

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

classmethod pull(message: msg.pull_doc_req, connection: ServerConnection) → msg.pull_doc_reply

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

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

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

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

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.

previous

bokeh.server.server

next

bokeh.server.tornado