Struct Heartbeat

pub struct Heartbeat<S> { /* private fields */ }

Wrapper for a muxado TypedSession that adds heartbeating over a dedicated typed stream.

Implementations

impl<S> Heartbeat<S>

where S: TypedSession + 'static,

pub async fn start( sess: S, cfg: HeartbeatConfig, ) -> Result<(Self, HeartbeatCtl), Error>

Wrap a typed session and start the heartbeat task. Returns an error if the stream can’t be opened.

Trait Implementations

impl<S> TypedAccept for Heartbeat<S>

where S: TypedAccept + Send,

fn accept_typed<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<TypedStream, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Accept a typed stream.

impl<S> TypedOpenClose for Heartbeat<S>

where S: TypedOpenClose + Send,

fn open_typed<'life0, 'async_trait>( &'life0 mut self, typ: StreamType, ) -> Pin<Box<dyn Future<Output = Result<TypedStream, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Open a typed stream with the given type.

fn close<'life0, 'async_trait>( &'life0 mut self, error: Error, msg: String, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Close the session by sending a GOAWAY

impl<S> TypedSession for Heartbeat<S>

where S: TypedSession + Send, S::TypedAccept: Send, S::TypedOpen: Send,

type TypedAccept = Heartbeat<<S as TypedSession>::TypedAccept>

The component implementing TypedAccept.

type TypedOpen = Heartbeat<<S as TypedSession>::TypedOpen>

The component implementing [TypedOpen].

fn split_typed(self) -> (Self::TypedOpen, Self::TypedAccept)

Split the typed session into open/accept components.