Class WebSocketData

mitmproxy/websocket.py:155–182

A data container for everything related to a single WebSocket connection. This is typically accessed as `mitmproxy.http.HTTPFlow.websocket`.

@dataclass
class WebSocketData(serializable.SerializableDataclass):
    """
    A data container for everything related to a single WebSocket connection.
    This is typically accessed as `mitmproxy.http.HTTPFlow.websocket`.
    """

    messages: list[WebSocketMessage] = field(default_factory=list)
    """All `WebSocketMessage`s transferred over this connection."""

    closed_by_client: bool | None = None
    """
    `True` if the client closed the connection,
    `False` if the server closed the connection,
    `None` if the connection is active.
    """
    close_code: int | None = None
    """[Close Code](https://tools.ietf.org/html/rfc6455#section-7.1.5)"""
    close_reason: str | None = None
    """[Close Reason](https://tools.ietf.org/html/rfc6455#section-7.1.6)"""

    timestamp_end: float | None = None
    """*Timestamp:* WebSocket connection closed."""

    def __repr__(self):
        return f"<WebSocketData ({len(self.messages)} messages)>"

    def _get_formatted_messages(self) -> bytes:
        return b"\n".join(m._format_ws_message() for m in self.messages)