Skip to main content

ConnectionOptions

Struct ConnectionOptions 

Source
pub struct ConnectionOptions { /* private fields */ }
Expand description

Tunable behaviour of a Connection.

Implementations§

Source§

impl ConnectionOptions

Source

pub fn new() -> Self

Starts from the default options.

Source

pub fn timeout(self, timeout: Duration) -> Self

Sets the time allowed between sending a request and receiving its response.

A duration below one millisecond is raised to one millisecond.

Source

pub fn heartbeat_interval(self, interval: Duration) -> Self

Sets the pause after the last write before a heartbeat is sent.

A duration below one millisecond is raised to one millisecond.

Source

pub fn command_capacity(self, capacity: usize) -> Self

Sets the number of requests that may wait in the command channel.

Zero is raised to one and a number above MAX_COMMAND_CAPACITY is lowered to it.

Source

pub fn event_capacity(self, capacity: usize) -> Self

Sets the number of events kept for a subscriber that falls behind.

Zero is raised to one and a number above MAX_EVENT_CAPACITY is lowered to it.

Source

pub fn reconnect_delay(self, delay: Duration) -> Self

Sets the pause before the first reconnection attempt; it doubles before every further attempt up to RECONNECT_DELAY_LIMIT.

A duration below one millisecond is raised to one millisecond.

Source

pub const fn reconnect_attempts(self, attempts: Option<u32>) -> Self

Sets how many times in a row the task tries to connect again before it gives up.

None keeps trying, which is the default; Some(0) turns reconnection off.

Source

pub fn request_limit(self, limit: u32) -> Self

Sets the number of requests sent per second, historical data excluded; at least one.

Source

pub fn historical_limit(self, limit: u32) -> Self

Sets the number of requests for historical data sent per second; at least one.

Source

pub const fn retries(self, retries: u32) -> Self

Sets how often a request is sent again after the server answered that a limit was exceeded; zero hands the error to the caller at once.

Source

pub fn backoff(self, backoff: Duration) -> Self

Sets the pause after the server answered that a limit was exceeded; it doubles with every retry of the same request up to BACKOFF_LIMIT.

A duration below one millisecond is raised to one millisecond.

Source

pub fn inbound_timeout(self, period: Duration) -> Self

Sets how long the server may stay silent before the connection counts as lost.

Every frame the server sends, heartbeats included, starts the period anew. When it runs out the task reports Event::Disconnected with TransportError::Idle and connects again. Left unset, the period is DEFAULT_INBOUND_TIMEOUT. It follows from the pace of the server alone, which sends a heartbeat of its own every SERVER_HEARTBEAT_INTERVAL on a connection that is otherwise quiet, and from nothing the client is set to do: neither the heartbeat interval nor the time allowed for a response changes it. A period shorter than the pace of the server gives up connections that are in order.

A duration below one millisecond is raised to one millisecond. Duration::MAX turns the watch off: the server may then stay silent for as long as it likes.

Trait Implementations§

Source§

impl Clone for ConnectionOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ConnectionOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ConnectionOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for ConnectionOptions

Source§

impl From<&ConfigurationOpenApi> for ConnectionOptions

Source§

fn from(configuration: &ConfigurationOpenApi) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ConnectionOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ConnectionOptions

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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