Skip to content

Models

WebSocket Message

datadivr.transport.models.WebSocketMessage

Bases: BaseModel

A model representing a WebSocket message.

This model defines the structure of messages sent between WebSocket clients and servers. It includes fields for event identification, payload data, routing information, and optional text messages.

Attributes:

Name Type Description
event_name str

The name of the event this message represents
payload Any | None

Optional data associated with the message
to str

The recipient identifier (defaults to "others")
from_id str

The sender identifier (defaults to "server")
message str | None

Optional text message content
websocket WebSocket | None

Optional WebSocket reference
Example 
message = WebSocketMessage(
    event_name="data_update",
    payload={"value": 42},
    to="client_123",
    from_id="server",
    message="Updated data value"
)
Source code in datadivr/transport/models.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class WebSocketMessage(BaseModel):
    """A model representing a WebSocket message.

    This model defines the structure of messages sent between WebSocket clients and servers.
    It includes fields for event identification, payload data, routing information, and optional
    text messages.

    Attributes:
        event_name: The name of the event this message represents
        payload: Optional data associated with the message
        to: The recipient identifier (defaults to "others")
        from_id: The sender identifier (defaults to "server")
        message: Optional text message content
        websocket: Optional WebSocket reference

    Example:
        ```python
        message = WebSocketMessage(
            event_name="data_update",
            payload={"value": 42},
            to="client_123",
            from_id="server",
            message="Updated data value"
        )
        ```
    """

    event_name: str
    payload: Any | None = None
    to: str = Field(default="others")
    from_id: str = Field(default="server")
    message: str | None = None
    websocket: WebSocket | None = Field(default=None, exclude=True)

    model_config = ConfigDict(
        arbitrary_types_allowed=True,  # Allow WebSocket type
        populate_by_name=True,
        json_schema_extra={
            "example": {
                "event_name": "sum_event",
                "payload": {"numbers": [1, 2, 3]},
                "to": "all",
                "from": "client1",
                "message": "Calculate sum",
            }
        },
    )

options: show_root_heading: true show_source: true