Struct Ping 

pub struct Ping {
    pub availability: i32,
    pub power_reserve: f32,
    pub mailbox_backlog: f32,
    pub sticky_client_ids: Vec<String>,
}

========================================================================= Heartbeat

Periodic liveness and load indicators. NOTE: Currently measures Node-to-Signaling latency only. For P2P latency-based routing, consider adding:

• optional uint64 signaling_rtt_ms = 4; // Node-to-Signaling RTT
• LatencyReport message for P2P measurements See RouteCandidatesRequest.LOWEST_LATENCY for design discussion.

Fields

availability: i32

power_reserve: f32

mailbox_backlog: f32

sticky_client_ids: Vec<String>

Sticky session support: list of client IDs that must route to this instance. Used by LoadBalancer’s CLIENT_AFFINITY factor for session persistence. Actor instances report their currently connected sticky clients.

Implementations

impl Ping

pub fn availability(&self) -> ServiceAvailabilityState

Returns the enum value of availability, or the default if the field is set to an invalid enum value.

pub fn set_availability(&mut self, value: ServiceAvailabilityState)

Sets availability to the provided enum value.

Trait Implementations

impl Clone for Ping

fn clone(&self) -> Ping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ping

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

Formats the value using the given formatter.

impl Default for Ping

fn default() -> Self

Returns the “default value” for a type.

impl Message for Ping

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Ping

fn eq(&self, other: &Ping) -> 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 StructuralPartialEq for Ping