GitHub

SocketOptions

API reference for SocketOptions.

How a socket protocol keeps its connection: a ping every ping_interval (dropping the connection when nothing came back within ping_timeout), reconnecting by retry_policy. retry_transient_errors keeps requests waiting while the socket cannot open (reporting each error to on_transient_error).

Attributes

AttributeTypeDescription
ping_intervalDurationInput = '5 seconds'
ping_timeoutDurationInput | None = None
retry_transient_errorsbool = False
retry_policySchedule[Any, Any, Never, Never] | None = None
on_transient_errorCallable[[RpcClientError], Effect[None]] | None = None
on_ping_timeoutEffect[None] | None = None

Functions

__init__

__init__(ping_interval='5 seconds', ping_timeout=None, retry_transient_errors=False, retry_policy=None, on_transient_error=None, on_ping_timeout=None) -> None
ParameterTypeDescription
ping_intervalDurationInput = '5 seconds'
ping_timeoutDurationInput | None = None
retry_transient_errorsbool = False
retry_policySchedule[Any, Any, Never, Never] | None = None
on_transient_errorCallable[[RpcClientError], Effect[None]] | None = None
on_ping_timeoutEffect[None] | None = None