GitHub

WebSocketOptions

API reference for WebSocketOptions.

A graphql-transport-ws endpoint: its url and handshake headers; connection_params (run once per connection, needing R) is the connection_init payload. connection_ack_timeout (10s), keep_alive (10s; False for no pings) and idle_timeout (0: close as soon as the last operation ends).

Attributes

AttributeTypeDescription
urlstr
headersHeadersInput | None = None
connection_paramsEffect[Mapping[str, object] | None, object, R_co] | None = None
connection_ack_timeoutDurationInput | None = None
keep_aliveDurationInput | Literal[False] | None = None
idle_timeoutDurationInput | None = None

Functions

__init__

__init__(*, url, headers=None, connection_params=None, connection_ack_timeout=None, keep_alive=None, idle_timeout=None) -> None
ParameterTypeDescription
urlstr
headersHeadersInput | None = None
connection_paramsEffect[Mapping[str, object] | None, object, R_co] | None = None
connection_ack_timeoutDurationInput | None = None
keep_aliveDurationInput | Literal[False] | None = None
idle_timeoutDurationInput | None = None