WebSocket API Documentation

Provide API functions for interacting with WebSockets and managing real-time data providers.

async bedrock_server_manager.api.websocket.broadcast(request: BroadcastRequest, *, app_context: AppContext) → BroadcastResponse

Broadcasts a JSON payload to all WebSocket clients subscribed to a given topic.

async bedrock_server_manager.api.websocket.send_to_user(request: SendToUserRequest, *, app_context: AppContext) → SendToUserResponse

Sends a JSON payload to all active WebSocket connections belonging to a user.

async bedrock_server_manager.api.websocket.send_to_client(request: SendToClientRequest, *, app_context: AppContext) → SendToClientResponse

Sends a JSON payload directly to a specific connected WebSocket client ID.

async bedrock_server_manager.api.websocket.unregister_data_provider(request: UnregisterDataProviderRequest, *, app_context: AppContext) → UnregisterDataProviderResponse

Unregisters a data provider handler for a WebSocket topic.

async bedrock_server_manager.api.websocket.publish_ws_event(request: PublishWsEventRequest, *, app_context: AppContext) → PublishWsEventResponse

Publishes a custom WebSocket event to topic ‘ws_event:{event_name}’.