Skip to main content

SessionCore

Struct SessionCore 

Source
pub struct SessionCore {
Show 14 fields pub state: SessionState, pub negotiation: Negotiation, pub profile: WireProfile, pub s2_connect: bool, pub outbox: VecDeque<Outgoing>, pub acks: AckLedger, pub registry: Registry, pub ack_timeout: Duration, pub out_of_order: OutOfOrderPolicy, pub skew_tolerance: Duration, pub max_message_bytes: usize, pub strictness: Strictness, pub reconnect_attempt: u32, pub stats: Stats, /* private fields */
}
Expand description

The state both engines share.

Fields§

§state: SessionState

Where the session has got to.

§negotiation: Negotiation

How the version is agreed.

§profile: WireProfile

The profile in use, once it is known.

§s2_connect: bool

Whether this session runs under S2 Connect.

§outbox: VecDeque<Outgoing>

Messages waiting to go out.

§acks: AckLedger

What is waiting to be acknowledged.

§registry: Registry

What has been published.

§ack_timeout: Duration

How long to wait for an acknowledgement.

§out_of_order: OutOfOrderPolicy

How the engine answers an out-of-order message.

§skew_tolerance: Duration

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

§max_message_bytes: usize

The size cap applied to inbound text.

§strictness: Strictness

Whether to prune unknown properties instead of refusing the message.

§reconnect_attempt: u32

How many reconnection attempts have already failed, for the back-off.

A session object lives for exactly one connection, so this cannot be counted here: it is what the application carries across reconnections, through RmConfig::after_failed_attempts / CemConfig::after_failed_attempts. Left at zero, every Closed event would recommend the same two-second ceiling for ever, which is a back-off that does not back off.

§stats: Stats

What this session has done.

Implementations§

Source§

impl SessionCore

Source

pub fn poll_timeout(&self) -> Option<Timestamp>

The next instant at which handle_timeout has something to do.

None once the session is over. A closed session still holds unanswered messages in its ledger and possibly a description scheduled for tomorrow, but neither can ever resolve — the transport is gone — so waking a driver for them would keep an idle device’s timer alive for ever.

Source

pub fn poll_transmit(&mut self) -> Option<Outgoing>

The next message to put on the wire.

Trait Implementations§

Source§

impl Clone for SessionCore

Source§

fn clone(&self) -> SessionCore

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 SessionCore

Source§

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

Formats the value using the given formatter. 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