Skip to main content

Module realtime

Module realtime 

Source
Expand description

Realtime WebSocket RPC transport for Inline protocol calls.

Structs§

RealtimeClient
Stateful realtime connection for issuing Inline RPC calls.
RealtimeClientBuilder
Builder for RealtimeClient.
RealtimeEventReceiver
Receiver for pushed events from a multiplexed RealtimeSession.
RealtimeSession
Cloneable realtime session that multiplexes concurrent RPCs and pushed events over one WebSocket connection.

Enums§

RealtimeError
Error returned by realtime connection and RPC operations.
RealtimeEvent
Server-pushed realtime event received outside a direct RPC result.

Constants§

DEFAULT_CONNECT_TIMEOUT
Default timeout for opening a realtime connection.
DEFAULT_HEARTBEAT_INTERVAL
Default interval between protocol heartbeat pings.
DEFAULT_HEARTBEAT_TIMEOUT
Default deadline for a matching protocol pong.
DEFAULT_RPC_TIMEOUT
Default timeout for a single realtime RPC invocation.
DEFAULT_SESSION_COMMAND_CAPACITY
Default number of queued commands accepted by a multiplexed realtime session.
DEFAULT_SESSION_EVENT_CAPACITY
Default number of pushed events retained for each realtime session subscriber.
DEFAULT_SESSION_MAX_IN_FLIGHT_RPCS
Default maximum number of RPCs awaiting responses on one realtime session.

Traits§

RpcRequest
Typed Inline realtime RPC request.