Skip to main content

ApplicationHeartbeatConfig

Struct ApplicationHeartbeatConfig 

Source
pub struct ApplicationHeartbeatConfig {
    pub interval: Duration,
    pub payload: Message,
    pub send_timeout: Duration,
    pub response_timeout: Option<Duration>,
    pub max_missed_responses: u32,
    pub matcher: Option<ApplicationHeartbeatMatcher>,
    pub receive_options: ReceiveOptions,
    pub failure_action: ApplicationHeartbeatFailureAction,
}
Expand description

Configuration for a fixed-interval application heartbeat loop.

Fields§

§interval: Duration

Delay between heartbeat attempts. The first heartbeat is sent after this delay.

§payload: Message

Text or binary payload sent on every heartbeat attempt.

§send_timeout: Duration

Maximum time allowed for queue admission and the local write.

§response_timeout: Option<Duration>

How long to wait for a matching response after a successful write. None disables response matching and timeout accounting.

§max_missed_responses: u32

Number of consecutive missed responses tolerated before Stop takes effect.

§matcher: Option<ApplicationHeartbeatMatcher>

Optional application response matcher. When absent, writes are observed only.

§receive_options: ReceiveOptions

Receive queue used exclusively by the heartbeat loop when a matcher is set. The default is ReceiveOverflow::DropOldest so unrelated business traffic cannot close the session; selecting Disconnect makes queue overflow a heartbeat receiver failure by design.

§failure_action: ApplicationHeartbeatFailureAction

Failure handling policy for writes, receiver failures, and response timeouts.

Implementations§

Source§

impl ApplicationHeartbeatConfig

Source

pub fn new(interval: Duration, payload: impl Into<Message>) -> Self

Creates a fixed-interval heartbeat configuration with no response matching.

Source

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

Sets the timeout used for queue admission and local WebSocket writing.

Source

pub fn with_response_matcher( self, timeout: Duration, matcher: impl Fn(&IncomingMessage) -> bool + Send + Sync + 'static, ) -> Self

Enables response matching with the supplied timeout and matcher.

Source

pub fn with_max_missed_responses(self, max_missed_responses: u32) -> Self

Sets the maximum number of consecutive response timeouts.

Source

pub fn with_receive_options(self, receive_options: ReceiveOptions) -> Self

Sets the receive queue options used by the heartbeat loop.

Source

pub fn with_failure_action( self, failure_action: ApplicationHeartbeatFailureAction, ) -> Self

Sets whether failures stop or leave the loop running.

Source

pub fn validate(&self) -> Result<()>

Validates values that would otherwise create a busy loop or an unbounded wait.

Trait Implementations§

Source§

impl Clone for ApplicationHeartbeatConfig

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 ApplicationHeartbeatConfig

Source§

fn fmt(&self, formatter: &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<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> 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<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