Skip to main content

Ready

Struct Ready 

Source
pub struct Ready {
    pub session_id: String,
    pub epoch: u32,
    pub ping_interval_ms: u32,
    pub pong_timeout_ms: u32,
    pub max_missed_pongs: u32,
    pub idle_timeout_ms: u32,
    pub jitter_ms: u32,
    pub max_payload_bytes: u32,
    pub max_topics_per_connection: u32,
    pub max_send_queue_bytes: u32,
    pub server_time: i64,
}
Expand description

Server Ready frame – spec §5.5.

The Ready frame is the final handshake frame. It is sent by the server after the session is fully established (and any resume exchange is complete). It carries the runtime parameters the client needs to operate correctly on this connection.

After receiving Ready the client may begin publishing and subscribing to topics.

Fields§

§session_id: String

Unique session identifier assigned by the server.

§epoch: u32

Monotonically increasing epoch counter for this session.

§ping_interval_ms: u32

Minimum interval in milliseconds between consecutive Ping frames the client must send.

§pong_timeout_ms: u32

Maximum time in milliseconds the client should wait for a Pong reply before considering the Ping missed.

§max_missed_pongs: u32

Number of consecutive missed Pongs that triggers connection teardown on the client side.

§idle_timeout_ms: u32

Idle timeout in milliseconds; the connection will be closed if no frames are received within this window.

§jitter_ms: u32

Maximum random jitter in milliseconds to add to the effective ping interval, used to prevent heartbeat synchronization across many clients.

§max_payload_bytes: u32

Maximum payload size in bytes for a single frame on this connection.

§max_topics_per_connection: u32

Maximum number of topics this connection may subscribe to simultaneously.

§max_send_queue_bytes: u32

Maximum size in bytes of the client’s outbound send queue before the server will apply back-pressure or close the connection.

§server_time: i64

Server wall-clock time in milliseconds since the Unix epoch at the moment the Ready frame was generated.

Trait Implementations§

Source§

impl Clone for Ready

Source§

fn clone(&self) -> Ready

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 Ready

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Ready

§

impl RefUnwindSafe for Ready

§

impl Send for Ready

§

impl Sync for Ready

§

impl Unpin for Ready

§

impl UnsafeUnpin for Ready

§

impl UnwindSafe for Ready

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> 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> 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 = 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.
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