bundle.website.builtin.components.websocket.base.component

Classes

WebSocketComponentParams	Shared websocket parameters for component instances.
WebSocketBaseComponent	Base websocket component with default params and shared assets.

Module Contents

class bundle.website.builtin.components.websocket.base.component.WebSocketComponentParams(/, **data: Any)

Bases: bundle.core.data.Data

Shared websocket parameters for component instances.

endpoint: str = '/ws/default'

class bundle.website.builtin.components.websocket.base.component.WebSocketBaseComponent(/, **data: Any)

Bases: bundle.website.core.component.Component

Base websocket component with default params and shared assets.

shared_assets: ClassVar[tuple[str, Ellipsis]] = ('websocket/base/component.css',)

params: WebSocketComponentParams = None

classmethod shared_asset_paths() → list[str]

classmethod component_asset_paths_for(component_file: str | pathlib.Path, *, asset_filenames: collections.abc.Iterable[str] | None = None) → list[str]

async handle_websocket(websocket: fastapi.WebSocket) → None

Default websocket handler (keepalive protocol).

build_routers()

Attach the component websocket route using the configured endpoint.