Skip to main content

CemConfig

Struct CemConfig 

Source
#[non_exhaustive]
pub struct CemConfig { pub negotiation: Negotiation, pub supported_versions: Vec<ProtocolVersion>, pub ack_timeout: Duration, pub out_of_order: OutOfOrderPolicy, pub skew_tolerance: Duration, pub max_message_bytes: usize, pub strictness: Strictness, pub s2_connect: bool, pub validate_outbound: bool, pub enforce_transitions: bool, pub reconnect_attempt: u32, }
Expand description

How a CemSession behaves.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§negotiation: Negotiation

How the protocol version is agreed.

§supported_versions: Vec<ProtocolVersion>

The versions this manager can speak, most preferred first.

§ack_timeout: Duration

How long to wait for an acknowledgement.

§out_of_order: OutOfOrderPolicy

What to do about a message that is not allowed in the current state.

§skew_tolerance: Duration

How far a peer’s clock may differ before it is worth reporting.

§max_message_bytes: usize

The largest inbound message that will be parsed.

§strictness: Strictness

Whether to prune unknown properties rather than refuse the message.

§s2_connect: bool

Whether the session runs under S2 Connect.

§validate_outbound: bool

Whether to validate outbound messages and refuse to send an invalid one.

§enforce_transitions: bool

Whether to refuse an instruction whose transition is blocked by a timer.

Off by default: the S2 documentation, Operation modes says a Resource Manager may change mode without the CEM asking and even without a described transition, so the manager’s picture of the timers is always slightly stale. Refusing to send on a stale picture is worse than sending and being told no.

§reconnect_attempt: u32

How many reconnection attempts have already failed.

A session is one connection, so it cannot count these itself. Carry the number across: the reconnect_after on a Closed event is Backoff::ceiling for this attempt, and a session that always starts at zero always recommends two seconds — a back-off that does not back off.

Implementations§

Source§

impl CemConfig

Source

pub fn without_outbound_validation(self) -> Self

Stop checking outbound messages before they go.

On by default, because learning at the call site beats earning an INVALID_CONTENT from a peer. Turn it off for a bridge that must forward exactly what it was handed, or for a test that needs a peer’s refusal rather than its own.

Source

pub fn pre_negotiated(self, profile: WireProfile) -> Self

Use a version that was already agreed, as S2 Connect does.

Source

pub fn supporting( self, versions: impl IntoIterator<Item = ProtocolVersion>, ) -> Self

Support exactly these versions.

Source

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

Start this session knowing that attempts reconnections have already failed.

What makes the reconnect_after on a Closed event grow. The application owns the reconnection loop (D36), so it also owns the counter: reset it to zero after a session that reached Connected, and increment it after one that did not.

Trait Implementations§

Source§

impl Clone for CemConfig

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 CemConfig

Source§

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

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

impl Default for CemConfig

Source§

fn default() -> Self

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> PolicyExt for T
where T: ?Sized,

Source§

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

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

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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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