pub struct WebSocketConfigBuilder<S: State = Empty> { /* private fields */ }Expand description
Use builder syntax to set the inputs and finish with build_inner().
Implementations§
Source§impl<S: State> WebSocketConfigBuilder<S>
impl<S: State> WebSocketConfigBuilder<S>
Sourcepub fn url(self, value: String) -> WebSocketConfigBuilder<SetUrl<S>>where
S::Url: IsUnset,
pub fn url(self, value: String) -> WebSocketConfigBuilder<SetUrl<S>>where
S::Url: IsUnset,
Required.
The URL to connect to.
Sourcepub fn headers(
self,
value: Vec<(String, String)>,
) -> WebSocketConfigBuilder<SetHeaders<S>>where
S::Headers: IsUnset,
pub fn headers(
self,
value: Vec<(String, String)>,
) -> WebSocketConfigBuilder<SetHeaders<S>>where
S::Headers: IsUnset,
Sourcepub fn maybe_headers(
self,
value: Option<Vec<(String, String)>>,
) -> WebSocketConfigBuilder<SetHeaders<S>>where
S::Headers: IsUnset,
pub fn maybe_headers(
self,
value: Option<Vec<(String, String)>>,
) -> WebSocketConfigBuilder<SetHeaders<S>>where
S::Headers: IsUnset,
Sourcepub fn heartbeat_interval_secs(
self,
value: u64,
) -> WebSocketConfigBuilder<SetHeartbeatIntervalSecs<S>>where
S::HeartbeatIntervalSecs: IsUnset,
pub fn heartbeat_interval_secs(
self,
value: u64,
) -> WebSocketConfigBuilder<SetHeartbeatIntervalSecs<S>>where
S::HeartbeatIntervalSecs: IsUnset,
Optional (Some / Option setters). The optional heartbeat interval (seconds).
Each timing field carries the coarsest unit that expresses every legitimate value, and
quantities compared against each other share a unit: this 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.
Sourcepub fn maybe_heartbeat_interval_secs(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetHeartbeatIntervalSecs<S>>where
S::HeartbeatIntervalSecs: IsUnset,
pub fn maybe_heartbeat_interval_secs(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetHeartbeatIntervalSecs<S>>where
S::HeartbeatIntervalSecs: IsUnset,
Optional (Some / Option setters). The optional heartbeat interval (seconds).
Each timing field carries the coarsest unit that expresses every legitimate value, and
quantities compared against each other share a unit: this 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.
Sourcepub fn heartbeat_payload(
self,
value: String,
) -> WebSocketConfigBuilder<SetHeartbeatPayload<S>>where
S::HeartbeatPayload: IsUnset,
pub fn heartbeat_payload(
self,
value: String,
) -> WebSocketConfigBuilder<SetHeartbeatPayload<S>>where
S::HeartbeatPayload: IsUnset,
Sourcepub fn maybe_heartbeat_payload(
self,
value: Option<String>,
) -> WebSocketConfigBuilder<SetHeartbeatPayload<S>>where
S::HeartbeatPayload: IsUnset,
pub fn maybe_heartbeat_payload(
self,
value: Option<String>,
) -> WebSocketConfigBuilder<SetHeartbeatPayload<S>>where
S::HeartbeatPayload: IsUnset,
Sourcepub fn connect_timeout_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetConnectTimeoutMs<S>>where
S::ConnectTimeoutMs: IsUnset,
pub fn connect_timeout_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetConnectTimeoutMs<S>>where
S::ConnectTimeoutMs: IsUnset,
Optional (Some / Option setters). The timeout (milliseconds) for establishing a usable connection. Defaults to 10 seconds.
Bounds three things: the initial connection attempt, each reconnect attempt, and how long a send waits for the client to become active again. A short value therefore makes sends give up early during a reconnect as well as failing a connection attempt faster; keep it above the reconnect backoff.
Only applies to handler mode and must be non-zero when set. Stream mode ignores this field and bounds its connection attempt at 10 seconds.
Sourcepub fn maybe_connect_timeout_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetConnectTimeoutMs<S>>where
S::ConnectTimeoutMs: IsUnset,
pub fn maybe_connect_timeout_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetConnectTimeoutMs<S>>where
S::ConnectTimeoutMs: IsUnset,
Optional (Some / Option setters). The timeout (milliseconds) for establishing a usable connection. Defaults to 10 seconds.
Bounds three things: the initial connection attempt, each reconnect attempt, and how long a send waits for the client to become active again. A short value therefore makes sends give up early during a reconnect as well as failing a connection attempt faster; keep it above the reconnect backoff.
Only applies to handler mode and must be non-zero when set. Stream mode ignores this field and bounds its connection attempt at 10 seconds.
Sourcepub fn reconnect_delay_initial_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetReconnectDelayInitialMs<S>>where
S::ReconnectDelayInitialMs: IsUnset,
pub fn reconnect_delay_initial_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetReconnectDelayInitialMs<S>>where
S::ReconnectDelayInitialMs: IsUnset,
Sourcepub fn maybe_reconnect_delay_initial_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetReconnectDelayInitialMs<S>>where
S::ReconnectDelayInitialMs: IsUnset,
pub fn maybe_reconnect_delay_initial_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetReconnectDelayInitialMs<S>>where
S::ReconnectDelayInitialMs: IsUnset,
Sourcepub fn reconnect_delay_max_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetReconnectDelayMaxMs<S>>where
S::ReconnectDelayMaxMs: IsUnset,
pub fn reconnect_delay_max_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetReconnectDelayMaxMs<S>>where
S::ReconnectDelayMaxMs: IsUnset,
Sourcepub fn maybe_reconnect_delay_max_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetReconnectDelayMaxMs<S>>where
S::ReconnectDelayMaxMs: IsUnset,
pub fn maybe_reconnect_delay_max_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetReconnectDelayMaxMs<S>>where
S::ReconnectDelayMaxMs: IsUnset,
Sourcepub fn reconnect_backoff_factor(
self,
value: f64,
) -> WebSocketConfigBuilder<SetReconnectBackoffFactor<S>>where
S::ReconnectBackoffFactor: IsUnset,
pub fn reconnect_backoff_factor(
self,
value: f64,
) -> WebSocketConfigBuilder<SetReconnectBackoffFactor<S>>where
S::ReconnectBackoffFactor: IsUnset,
Sourcepub fn maybe_reconnect_backoff_factor(
self,
value: Option<f64>,
) -> WebSocketConfigBuilder<SetReconnectBackoffFactor<S>>where
S::ReconnectBackoffFactor: IsUnset,
pub fn maybe_reconnect_backoff_factor(
self,
value: Option<f64>,
) -> WebSocketConfigBuilder<SetReconnectBackoffFactor<S>>where
S::ReconnectBackoffFactor: IsUnset,
Sourcepub fn reconnect_jitter_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetReconnectJitterMs<S>>where
S::ReconnectJitterMs: IsUnset,
pub fn reconnect_jitter_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetReconnectJitterMs<S>>where
S::ReconnectJitterMs: IsUnset,
Sourcepub fn maybe_reconnect_jitter_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetReconnectJitterMs<S>>where
S::ReconnectJitterMs: IsUnset,
pub fn maybe_reconnect_jitter_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetReconnectJitterMs<S>>where
S::ReconnectJitterMs: IsUnset,
Sourcepub fn reconnect_max_attempts(
self,
value: u32,
) -> WebSocketConfigBuilder<SetReconnectMaxAttempts<S>>where
S::ReconnectMaxAttempts: IsUnset,
pub fn reconnect_max_attempts(
self,
value: u32,
) -> WebSocketConfigBuilder<SetReconnectMaxAttempts<S>>where
S::ReconnectMaxAttempts: IsUnset,
Optional (Some / Option setters). The maximum number of reconnection attempts before giving up.
Only applies to handler mode. Stream mode ignores this field.
None: Unlimited reconnection attempts (default, recommended for production).Some(n): Transitions to CLOSED oncenconsecutive reconnect attempts have either failed or established connections active for less than 10 seconds.
Sourcepub fn maybe_reconnect_max_attempts(
self,
value: Option<u32>,
) -> WebSocketConfigBuilder<SetReconnectMaxAttempts<S>>where
S::ReconnectMaxAttempts: IsUnset,
pub fn maybe_reconnect_max_attempts(
self,
value: Option<u32>,
) -> WebSocketConfigBuilder<SetReconnectMaxAttempts<S>>where
S::ReconnectMaxAttempts: IsUnset,
Optional (Some / Option setters). The maximum number of reconnection attempts before giving up.
Only applies to handler mode. Stream mode ignores this field.
None: Unlimited reconnection attempts (default, recommended for production).Some(n): Transitions to CLOSED oncenconsecutive reconnect attempts have either failed or established connections active for less than 10 seconds.
Sourcepub fn heartbeat_timeout_secs(
self,
value: u64,
) -> WebSocketConfigBuilder<SetHeartbeatTimeoutSecs<S>>where
S::HeartbeatTimeoutSecs: IsUnset,
pub fn heartbeat_timeout_secs(
self,
value: u64,
) -> WebSocketConfigBuilder<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
Self::heartbeat_interval_secs: it can never sensibly sit below one heartbeat cycle.
When set, the read task stops and triggers reconnection if no inbound frame of any kind
arrives within this duration. Ping and Pong both refresh it, so this detects a peer that has
gone silent rather than one whose feed is merely quiet. Set it above
Self::heartbeat_interval_secs so a healthy connection cannot trip it; three intervals is
the usual choice, tolerating two lost replies.
None derives three heartbeat intervals when a heartbeat is configured, and disables
detection otherwise. Some(0) is rejected.
Only applies to handler mode; stream mode ignores this field.
Sourcepub fn maybe_heartbeat_timeout_secs(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetHeartbeatTimeoutSecs<S>>where
S::HeartbeatTimeoutSecs: IsUnset,
pub fn maybe_heartbeat_timeout_secs(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<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
Self::heartbeat_interval_secs: it can never sensibly sit below one heartbeat cycle.
When set, the read task stops and triggers reconnection if no inbound frame of any kind
arrives within this duration. Ping and Pong both refresh it, so this detects a peer that has
gone silent rather than one whose feed is merely quiet. Set it above
Self::heartbeat_interval_secs so a healthy connection cannot trip it; three intervals is
the usual choice, tolerating two lost replies.
None derives three heartbeat intervals when a heartbeat is configured, and disables
detection otherwise. Some(0) is rejected.
Only applies to handler mode; stream mode ignores this field.
Sourcepub fn idle_timeout_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetIdleTimeoutMs<S>>where
S::IdleTimeoutMs: IsUnset,
pub fn idle_timeout_ms(
self,
value: u64,
) -> WebSocketConfigBuilder<SetIdleTimeoutMs<S>>where
S::IdleTimeoutMs: IsUnset,
Optional (Some / Option setters). The idle timeout (milliseconds) for the read task.
When set, the read task stops and triggers reconnection if no Text or Binary frame arrives
within this duration. Ping and Pong deliberately do not refresh it, so this detects a feed
that has stopped flowing even while the transport is provably alive. Contrast
Self::heartbeat_timeout_secs, which any inbound frame refreshes.
None disables this timeout. Some(0) is rejected. Adapters that expose a required integer
map 0 to None rather than passing it through.
The raw-socket client has no equivalent: TCP carries no control frames, so there is no transport-level way to tell keepalive traffic from data.
A venue answering the keepalive with a text payload refreshes this timer exactly like real
data does, so on those venues the window must sit below
Self::heartbeat_interval_secs to mean anything. Prefer
Self::heartbeat_timeout_secs unless the venue guarantees periodic inbound data.
Only applies to handler mode; stream mode ignores this field.
Sourcepub fn maybe_idle_timeout_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetIdleTimeoutMs<S>>where
S::IdleTimeoutMs: IsUnset,
pub fn maybe_idle_timeout_ms(
self,
value: Option<u64>,
) -> WebSocketConfigBuilder<SetIdleTimeoutMs<S>>where
S::IdleTimeoutMs: IsUnset,
Optional (Some / Option setters). The idle timeout (milliseconds) for the read task.
When set, the read task stops and triggers reconnection if no Text or Binary frame arrives
within this duration. Ping and Pong deliberately do not refresh it, so this detects a feed
that has stopped flowing even while the transport is provably alive. Contrast
Self::heartbeat_timeout_secs, which any inbound frame refreshes.
None disables this timeout. Some(0) is rejected. Adapters that expose a required integer
map 0 to None rather than passing it through.
The raw-socket client has no equivalent: TCP carries no control frames, so there is no transport-level way to tell keepalive traffic from data.
A venue answering the keepalive with a text payload refreshes this timer exactly like real
data does, so on those venues the window must sit below
Self::heartbeat_interval_secs to mean anything. Prefer
Self::heartbeat_timeout_secs unless the venue guarantees periodic inbound data.
Only applies to handler mode; stream mode ignores this field.
Sourcepub fn backend(
self,
value: TransportBackend,
) -> WebSocketConfigBuilder<SetBackend<S>>where
S::Backend: IsUnset,
pub fn backend(
self,
value: TransportBackend,
) -> WebSocketConfigBuilder<SetBackend<S>>where
S::Backend: IsUnset,
Optional (Some / Option setters).
Default: <TransportBackend as Default>::default().
The transport backend to use for the WebSocket connection.
Defaults to TransportBackend::Sockudo when the transport-sockudo
Cargo feature is enabled (the default), otherwise TransportBackend::Tungstenite.
When the feature is disabled, connect_with_server returns an error if
Sockudo is selected. Both backends pass headers into the HTTP
upgrade request and both honour Self::proxy_url.
Sourcepub fn maybe_backend(
self,
value: Option<TransportBackend>,
) -> WebSocketConfigBuilder<SetBackend<S>>where
S::Backend: IsUnset,
pub fn maybe_backend(
self,
value: Option<TransportBackend>,
) -> WebSocketConfigBuilder<SetBackend<S>>where
S::Backend: IsUnset,
Optional (Some / Option setters).
Default: <TransportBackend as Default>::default().
The transport backend to use for the WebSocket connection.
Defaults to TransportBackend::Sockudo when the transport-sockudo
Cargo feature is enabled (the default), otherwise TransportBackend::Tungstenite.
When the feature is disabled, connect_with_server returns an error if
Sockudo is selected. Both backends pass headers into the HTTP
upgrade request and both honour Self::proxy_url.
Sourcepub fn proxy_url(self, value: String) -> WebSocketConfigBuilder<SetProxyUrl<S>>where
S::ProxyUrl: IsUnset,
pub fn proxy_url(self, value: String) -> WebSocketConfigBuilder<SetProxyUrl<S>>where
S::ProxyUrl: IsUnset,
Sourcepub fn maybe_proxy_url(
self,
value: Option<String>,
) -> WebSocketConfigBuilder<SetProxyUrl<S>>where
S::ProxyUrl: IsUnset,
pub fn maybe_proxy_url(
self,
value: Option<String>,
) -> WebSocketConfigBuilder<SetProxyUrl<S>>where
S::ProxyUrl: IsUnset,
Source§impl<S: IsComplete> WebSocketConfigBuilder<S>
impl<S: IsComplete> WebSocketConfigBuilder<S>
Sourcepub fn build(self) -> NetworkConfigResult<WebSocketConfig>
pub fn build(self) -> NetworkConfigResult<WebSocketConfig>
Validates and builds the WebSocketConfig.
§Errors
Returns a NetworkConfigError if any field fails validation
(see WebSocketConfig::validate).