Skip to main content

SocketConfigBuilder

nautilus_network::socket::config

Struct SocketConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> SocketConfigBuilder<S>

Source

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

Required.

The URL to connect to.

Source

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

Required.

The connection mode {Plain, TLS}.

Source

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

Required.

The sequence of bytes which separates lines.

Source

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

Optional (Some / Option setters). The optional function to handle incoming messages.

Source

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

Optional (Some / Option setters). The optional function to handle incoming messages.

Source

pub fn heartbeat( self, value: (u64, Vec<u8>), ) -> SocketConfigBuilder<SetHeartbeat<S>>
where S::Heartbeat: IsUnset,

Optional (Some / Option setters). The optional heartbeat with period and beat message.

Source

pub fn maybe_heartbeat( self, value: Option<(u64, Vec<u8>)>, ) -> SocketConfigBuilder<SetHeartbeat<S>>
where S::Heartbeat: IsUnset,

Optional (Some / Option setters). The optional heartbeat with period and beat message.

Source

pub fn reconnect_timeout_ms( self, value: u64, ) -> SocketConfigBuilder<SetReconnectTimeoutMs<S>>
where S::ReconnectTimeoutMs: IsUnset,

Optional (Some / Option setters). The timeout (milliseconds) for reconnection attempts.

Source

pub fn maybe_reconnect_timeout_ms( self, value: Option<u64>, ) -> SocketConfigBuilder<SetReconnectTimeoutMs<S>>
where S::ReconnectTimeoutMs: IsUnset,

Optional (Some / Option setters). The timeout (milliseconds) for reconnection attempts.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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 (default: 5).

Source

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 (default: 5).

Source

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 giving up.

  • None: Unlimited reconnection attempts (default, recommended for production).
  • Some(n): After n failed attempts, transition to CLOSED state.
Source

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 giving up.

  • None: Unlimited reconnection attempts (default, recommended for production).
  • Some(n): After n failed attempts, transition to CLOSED state.
Source

pub fn idle_timeout_ms( self, value: u64, ) -> SocketConfigBuilder<SetIdleTimeoutMs<S>>
where S::IdleTimeoutMs: IsUnset,

Optional (Some / Option setters). The idle timeout (milliseconds) for the read task. When set, the read task will break and trigger reconnection if no data is received within this duration. Useful for detecting silently dead connections where the server stops sending without closing.

Source

pub fn maybe_idle_timeout_ms( self, value: Option<u64>, ) -> SocketConfigBuilder<SetIdleTimeoutMs<S>>
where S::IdleTimeoutMs: IsUnset,

Optional (Some / Option setters). The idle timeout (milliseconds) for the read task. When set, the read task will break and trigger reconnection if no data is received within this duration. Useful for detecting silently dead connections where the server stops sending without closing.

Source

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

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

Source

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.

Source§

impl<S: IsComplete> SocketConfigBuilder<S>

Source

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

Validates and builds the SocketConfig.

§Errors

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more