Struct Heartbeat

pub struct Heartbeat { /* private fields */ }

Socket heartbeating configuration.

Example

use libzmq::Heartbeat;
use std::time::Duration;

let duration = Duration::from_millis(300);

let hb = Heartbeat::new(duration)
    .add_timeout(2 * duration);

Implementations

impl Heartbeat

pub fn new<D>(interval: D) -> Self

where D: Into<Duration>,

Create a new Heartbeat from the given interval.

This interval specifies the duration between each heartbeat.

pub fn interval(&self) -> Duration

Returns the interval between each heartbeat.

pub fn add_timeout<D>(self, timeout: D) -> Self

where D: Into<Duration>,

Set a timeout for the Heartbeat.

This timeout specifies how long to wait before timing out a connection with a peer for not receiving any traffic.

pub fn timeout(&self) -> Period

Returns the heartbeat timeout.

pub fn add_ttl<D>(self, ttl: D) -> Self

where D: Into<Duration>,

Set a ttl for the Heartbeat

This ttl is equivalent to a heartbeat_timeout for the remote side for this specific connection.

pub fn ttl(&self) -> Period

Returns the heartbeat ttl.

Trait Implementations

impl Clone for Heartbeat

fn clone(&self) -> Heartbeat

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Heartbeat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Heartbeat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a Heartbeat> for Heartbeat

fn from(hb: &'a Heartbeat) -> Self

Converts to this type from the input type.

impl Hash for Heartbeat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Heartbeat

fn eq(&self, other: &Heartbeat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Heartbeat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Heartbeat

impl StructuralPartialEq for Heartbeat