Struct MTBHeartbeat

pub struct MTBHeartbeat {
    pub version: ProtocolVersion,
    pub total_elapsed: u64,
    pub n_events: u64,
    pub evq_num_events_last: u64,
    pub evq_num_events_avg: u64,
    pub n_ev_unsent: u64,
    pub n_ev_missed: u64,
    pub trate: u64,
    pub lost_trate: u64,
    pub prescale_track: f32,
    pub prescale_gaps: f32,
}

Fields

version: ProtocolVersion

total_elapsed: u64

n_events: u64

evq_num_events_last: u64

evq_num_events_avg: u64

n_ev_unsent: u64

n_ev_missed: u64

trate: u64

lost_trate: u64

prescale_track: f32

prescale_gaps: f32

Implementations

impl MTBHeartbeat

pub fn new() -> Self

pub fn get_sent_packet_rate(&self) -> f64

pub fn get_prescale_track(&self) -> f64

pub fn get_prescale_gaps(&self) -> f64

pub fn to_string(&self) -> String

Trait Implementations

impl Clone for MTBHeartbeat

fn clone(&self) -> MTBHeartbeat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MTBHeartbeat

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

Formats the value using the given formatter.

impl Default for MTBHeartbeat

fn default() -> Self

Returns the “default value” for a type.

impl Display for MTBHeartbeat

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

Formats the value using the given formatter.

impl FromRandom for MTBHeartbeat

fn from_random() -> Self

impl Packable for MTBHeartbeat

const PACKET_TYPE: PacketType = PacketType::MTBHeartbeat

fn pack(&self) -> TofPacket

where Self: Serialization,

Wrap myself in a TofPacket

impl PartialEq for MTBHeartbeat

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

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 68usize

The SIZE is the size of the serialized bytestream INCLUDING 4 bytes for head and tail bytes. In case the struct does NOT HAVE a fixed size, SIZE will be 0 (so default value of the trait

fn from_bytestream( stream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>

Decode a serializable from a bytestream

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

Encode a serializable to a bytestream

fn verify_fixed( stream: &Vec<u8>, pos: &mut usize, ) -> Result<(), SerializationError>

Verify that the serialized representation of the struct has the correct size, including header + footer.

fn from_tofpacket(packet: &TofPacket) -> Result<Self, SerializationError>

where Self: Sized,

Decode a serializable directly from a TofPacket

fn from_slice( _slice: &[u8], _start_pos: usize, ) -> Result<Self, SerializationError>

where Self: Sized,

fn to_slice(&self) -> &[u8]

where Self: Sized,

Construct byte slice out of self.

impl Copy for MTBHeartbeat

impl StructuralPartialEq for MTBHeartbeat