Struct SocketConfigBuilder 

pub struct SocketConfigBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build_inner().

Implementations

impl<S: State> SocketConfigBuilder<S>

pub fn url(self, value: String) -> SocketConfigBuilder<SetUrl<S>>

where S::Url: IsUnset,

Required.

The server address as host:port or a URL.

pub fn mode(self, value: Mode) -> SocketConfigBuilder<SetMode<S>>

where S::Mode: IsUnset,

Required.

The plain or TLS connection mode.

pub fn suffix(self, value: Vec<u8>) -> SocketConfigBuilder<SetSuffix<S>>

where S::Suffix: IsUnset,

Required.

The byte sequence that frames messages in both directions.

pub fn message_handler( self, value: TcpMessageHandler, ) -> SocketConfigBuilder<SetMessageHandler<S>>

where S::MessageHandler: IsUnset,

Optional (Some / Option setters). The function called for each complete incoming message.

pub fn maybe_message_handler( self, value: Option<TcpMessageHandler>, ) -> SocketConfigBuilder<SetMessageHandler<S>>

where S::MessageHandler: IsUnset,

Optional (Some / Option setters). The function called for each complete incoming message.

pub fn heartbeat( self, value: SocketHeartbeat, ) -> SocketConfigBuilder<SetHeartbeat<S>>

where S::Heartbeat: IsUnset,

Optional (Some / Option setters). Optional application keepalive.

When set, the client sends SocketHeartbeat::payload every SocketHeartbeat::interval_secs seconds. A raw socket has no Ping frames, so this type requires a payload; the WebSocket Ping-frame case stays on crate::websocket::WebSocketConfig::heartbeat_payload.

Each timing field carries the coarsest unit that expresses every legitimate value, and quantities compared against each other share a unit: the interval and Self::heartbeat_timeout_secs are bounded below by whole-second cadences, while reconnect delays and jitter have real sub-second values and stay in milliseconds.

pub fn maybe_heartbeat( self, value: Option<SocketHeartbeat>, ) -> SocketConfigBuilder<SetHeartbeat<S>>

where S::Heartbeat: IsUnset,

Optional (Some / Option setters). Optional application keepalive.

When set, the client sends SocketHeartbeat::payload every SocketHeartbeat::interval_secs seconds. A raw socket has no Ping frames, so this type requires a payload; the WebSocket Ping-frame case stays on crate::websocket::WebSocketConfig::heartbeat_payload.

Each timing field carries the coarsest unit that expresses every legitimate value, and quantities compared against each other share a unit: the interval and Self::heartbeat_timeout_secs are bounded below by whole-second cadences, while reconnect delays and jitter have real sub-second values and stay in milliseconds.

pub fn connect_timeout_ms( self, value: u64, ) -> SocketConfigBuilder<SetConnectTimeoutMs<S>>

where S::ConnectTimeoutMs: IsUnset,

Optional (Some / Option setters). The timeout (milliseconds) for establishing a usable connection. Defaults to 10 seconds.

Bounds the initial connection attempt, each reconnect attempt, and how long a send waits for the client to become active again. Keep it above the reconnect backoff so a send does not give up part-way through a normal reconnect.

pub fn maybe_connect_timeout_ms( self, value: Option<u64>, ) -> SocketConfigBuilder<SetConnectTimeoutMs<S>>

where S::ConnectTimeoutMs: IsUnset,

Optional (Some / Option setters). The timeout (milliseconds) for establishing a usable connection. Defaults to 10 seconds.

Bounds the initial connection attempt, each reconnect attempt, and how long a send waits for the client to become active again. Keep it above the reconnect backoff so a send does not give up part-way through a normal reconnect.

pub fn reconnect_delay_initial_ms( self, value: u64, ) -> SocketConfigBuilder<SetReconnectDelayInitialMs<S>>

where S::ReconnectDelayInitialMs: IsUnset,

Optional (Some / Option setters). The initial reconnection delay (milliseconds) for reconnects.

pub fn maybe_reconnect_delay_initial_ms( self, value: Option<u64>, ) -> SocketConfigBuilder<SetReconnectDelayInitialMs<S>>

where S::ReconnectDelayInitialMs: IsUnset,

Optional (Some / Option setters). The initial reconnection delay (milliseconds) for reconnects.

pub fn reconnect_delay_max_ms( self, value: u64, ) -> SocketConfigBuilder<SetReconnectDelayMaxMs<S>>

where S::ReconnectDelayMaxMs: IsUnset,

Optional (Some / Option setters). The maximum reconnect delay (milliseconds) for exponential backoff.

pub fn maybe_reconnect_delay_max_ms( self, value: Option<u64>, ) -> SocketConfigBuilder<SetReconnectDelayMaxMs<S>>

where S::ReconnectDelayMaxMs: IsUnset,

Optional (Some / Option setters). The maximum reconnect delay (milliseconds) for exponential backoff.

pub fn reconnect_backoff_factor( self, value: f64, ) -> SocketConfigBuilder<SetReconnectBackoffFactor<S>>

where S::ReconnectBackoffFactor: IsUnset,

Optional (Some / Option setters). The exponential backoff factor for reconnection delays.

pub fn maybe_reconnect_backoff_factor( self, value: Option<f64>, ) -> SocketConfigBuilder<SetReconnectBackoffFactor<S>>

where S::ReconnectBackoffFactor: IsUnset,

Optional (Some / Option setters). The exponential backoff factor for reconnection delays.

pub fn reconnect_jitter_ms( self, value: u64, ) -> SocketConfigBuilder<SetReconnectJitterMs<S>>

where S::ReconnectJitterMs: IsUnset,

Optional (Some / Option setters). The maximum jitter (milliseconds) added to reconnection delays.

pub fn maybe_reconnect_jitter_ms( self, value: Option<u64>, ) -> SocketConfigBuilder<SetReconnectJitterMs<S>>

where S::ReconnectJitterMs: IsUnset,

Optional (Some / Option setters). The maximum jitter (milliseconds) added to reconnection delays.

pub fn connection_max_retries( self, value: u32, ) -> SocketConfigBuilder<SetConnectionMaxRetries<S>>

where S::ConnectionMaxRetries: IsUnset,

Optional (Some / Option setters). The maximum number of initial connection attempts. Defaults to 5.

pub fn maybe_connection_max_retries( self, value: Option<u32>, ) -> SocketConfigBuilder<SetConnectionMaxRetries<S>>

where S::ConnectionMaxRetries: IsUnset,

Optional (Some / Option setters). The maximum number of initial connection attempts. Defaults to 5.

pub fn reconnect_max_attempts( self, value: u32, ) -> SocketConfigBuilder<SetReconnectMaxAttempts<S>>

where S::ReconnectMaxAttempts: IsUnset,

Optional (Some / Option setters). The maximum number of reconnection attempts before closing the client.

• None: Unlimited reconnection attempts (default, recommended for production).
• Some(n): Transitions to CLOSED once n consecutive reconnect attempts have either failed or established connections active for less than 10 seconds.

pub fn maybe_reconnect_max_attempts( self, value: Option<u32>, ) -> SocketConfigBuilder<SetReconnectMaxAttempts<S>>

where S::ReconnectMaxAttempts: IsUnset,

Optional (Some / Option setters). The maximum number of reconnection attempts before closing the client.

• None: Unlimited reconnection attempts (default, recommended for production).
• Some(n): Transitions to CLOSED once n consecutive reconnect attempts have either failed or established connections active for less than 10 seconds.

pub fn heartbeat_timeout_secs( self, value: u64, ) -> SocketConfigBuilder<SetHeartbeatTimeoutSecs<S>>

where S::HeartbeatTimeoutSecs: IsUnset,

Optional (Some / Option setters). The dead-peer timeout (seconds) for the read task.

Seconds rather than milliseconds because this is a multiple of the heartbeat interval: it can never sensibly sit below one heartbeat cycle.

When set, the read task stops and triggers reconnection if no bytes at all arrive within this duration. A raw socket has no control frames, so any inbound byte refreshes it, including the venue’s reply to a heartbeat. That makes this the byte-level equivalent of the WebSocket client’s heartbeat_timeout_secs, not of its idle_timeout_ms: there is no transport-level way to tell keepalive traffic from data here.

None derives three heartbeat intervals when Self::heartbeat is set, and disables detection otherwise. Some(0) is rejected. Set an explicit value above the heartbeat interval so a healthy connection cannot trip it.

pub fn maybe_heartbeat_timeout_secs( self, value: Option<u64>, ) -> SocketConfigBuilder<SetHeartbeatTimeoutSecs<S>>

where S::HeartbeatTimeoutSecs: IsUnset,

Optional (Some / Option setters). The dead-peer timeout (seconds) for the read task.

Seconds rather than milliseconds because this is a multiple of the heartbeat interval: it can never sensibly sit below one heartbeat cycle.

When set, the read task stops and triggers reconnection if no bytes at all arrive within this duration. A raw socket has no control frames, so any inbound byte refreshes it, including the venue’s reply to a heartbeat. That makes this the byte-level equivalent of the WebSocket client’s heartbeat_timeout_secs, not of its idle_timeout_ms: there is no transport-level way to tell keepalive traffic from data here.

None derives three heartbeat intervals when Self::heartbeat is set, and disables detection otherwise. Some(0) is rejected. Set an explicit value above the heartbeat interval so a healthy connection cannot trip it.

pub fn certs_dir(self, value: String) -> SocketConfigBuilder<SetCertsDir<S>>

where S::CertsDir: IsUnset,

Optional (Some / Option setters). The path to the certificates directory.

pub fn maybe_certs_dir( self, value: Option<String>, ) -> SocketConfigBuilder<SetCertsDir<S>>

where S::CertsDir: IsUnset,

Optional (Some / Option setters). The path to the certificates directory.

impl<S: IsComplete> SocketConfigBuilder<S>

pub fn build(self) -> NetworkConfigResult<SocketConfig>

Validates and builds the SocketConfig.

Errors

Returns a NetworkConfigError if any field fails validation (see SocketConfig::validate).