Struct sbp::messages::system::msg_heartbeat::MsgHeartbeat

pub struct MsgHeartbeat {
    pub sender_id: Option<u16>,
    pub flags: u32,
}

System heartbeat message

The heartbeat message is sent periodically to inform the host or other attached devices that the system is running. It is used to monitor system malfunctions. It also contains status flags that indicate to the host the status of the system and whether it is operating correctly. Currently, the expected heartbeat interval is 1 sec.

The system error flag is used to indicate that an error has occurred in the system. To determine the source of the error, the remaining error flags should be inspected.

Fields

sender_id: Option<u16>

The message sender_id

flags: u32

Status flags

Implementations

impl MsgHeartbeat

pub fn external_antenna_present(&self) -> Result<ExternalAntennaPresent, u8>

Gets the ExternalAntennaPresent stored in the flags bitfield.

Returns Ok if the bitrange contains a known ExternalAntennaPresent variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of ExternalAntennaPresent were added.

pub fn set_external_antenna_present(
    &mut self,
    external_antenna_present: ExternalAntennaPresent
)

Set the bitrange corresponding to the ExternalAntennaPresent of the flags bitfield.

pub fn external_antenna_short(&self) -> Result<ExternalAntennaShort, u8>

Gets the ExternalAntennaShort stored in the flags bitfield.

Returns Ok if the bitrange contains a known ExternalAntennaShort variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of ExternalAntennaShort were added.

pub fn set_external_antenna_short(
    &mut self,
    external_antenna_short: ExternalAntennaShort
)

Set the bitrange corresponding to the ExternalAntennaShort of the flags bitfield.

pub fn sbp_major_protocol_version_number(&self) -> u8

Gets the sbp_major_protocol_version_number stored in flags.

pub fn set_sbp_major_protocol_version_number(
    &mut self,
    sbp_major_protocol_version_number: u8
)

Sets the sbp_major_protocol_version_number bitrange of flags.

pub fn sbp_minor_protocol_version_number(&self) -> u8

Gets the sbp_minor_protocol_version_number stored in flags.

pub fn set_sbp_minor_protocol_version_number(
    &mut self,
    sbp_minor_protocol_version_number: u8
)

Sets the sbp_minor_protocol_version_number bitrange of flags.

pub fn swift_nap_error(&self) -> Result<SwiftNapError, u8>

Gets the SwiftNapError stored in the flags bitfield.

Returns Ok if the bitrange contains a known SwiftNapError variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of SwiftNapError were added.

pub fn set_swift_nap_error(&mut self, swift_nap_error: SwiftNapError)

Set the bitrange corresponding to the SwiftNapError of the flags bitfield.

pub fn io_error(&self) -> Result<IoError, u8>

Gets the IoError stored in the flags bitfield.

Returns Ok if the bitrange contains a known IoError variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of IoError were added.

pub fn set_io_error(&mut self, io_error: IoError)

Set the bitrange corresponding to the IoError of the flags bitfield.

pub fn system_error_flag(&self) -> Result<SystemErrorFlag, u8>

Gets the SystemErrorFlag stored in the flags bitfield.

Returns Ok if the bitrange contains a known SystemErrorFlag variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of SystemErrorFlag were added.

pub fn set_system_error_flag(&mut self, system_error_flag: SystemErrorFlag)

Set the bitrange corresponding to the SystemErrorFlag of the flags bitfield.

Trait Implementations

impl Clone for MsgHeartbeat

fn clone(&self) -> MsgHeartbeat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgHeartbeat

const MESSAGE_TYPE: u16 = 65_535u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_HEARTBEAT"

The message name.

impl Debug for MsgHeartbeat

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

Formats the value using the given formatter.

impl From<MsgHeartbeat> for Sbp

fn from(msg: MsgHeartbeat) -> Self

Converts to this type from the input type.

impl SbpMessage for MsgHeartbeat

fn message_name(&self) -> &'static str

Get the message name.

fn message_type(&self) -> u16

Get the message type.

fn sender_id(&self) -> Option<u16>

Get the sender_id if it is set.

fn set_sender_id(&mut self, new_id: u16)

Set the sender id.

fn encoded_len(&self) -> usize

Number of bytes this message will take on the wire.

impl TryFrom<Sbp> for MsgHeartbeat

type Error = TryFromSbpError

The type returned in the event of a conversion error.

fn try_from(msg: Sbp) -> Result<Self, Self::Error>

Performs the conversion.