Struct sbp::messages::system::msg_heartbeat::MsgHeartbeat
source · [−]Expand description
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
sourceimpl MsgHeartbeat
impl MsgHeartbeat
sourcepub fn external_antenna_present(&self) -> Result<ExternalAntennaPresent, u8>
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.
sourcepub fn set_external_antenna_present(
&mut self,
external_antenna_present: ExternalAntennaPresent
)
pub fn set_external_antenna_present(
&mut self,
external_antenna_present: ExternalAntennaPresent
)
Set the bitrange corresponding to the ExternalAntennaPresent of the flags
bitfield.
sourcepub fn external_antenna_short(&self) -> Result<ExternalAntennaShort, u8>
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.
sourcepub fn set_external_antenna_short(
&mut self,
external_antenna_short: ExternalAntennaShort
)
pub fn set_external_antenna_short(
&mut self,
external_antenna_short: ExternalAntennaShort
)
Set the bitrange corresponding to the ExternalAntennaShort of the flags
bitfield.
sourcepub fn sbp_major_protocol_version_number(&self) -> u8
pub fn sbp_major_protocol_version_number(&self) -> u8
Gets the sbp_major_protocol_version_number
stored in flags
.
sourcepub fn set_sbp_major_protocol_version_number(
&mut self,
sbp_major_protocol_version_number: u8
)
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
.
sourcepub fn sbp_minor_protocol_version_number(&self) -> u8
pub fn sbp_minor_protocol_version_number(&self) -> u8
Gets the sbp_minor_protocol_version_number
stored in flags
.
sourcepub fn set_sbp_minor_protocol_version_number(
&mut self,
sbp_minor_protocol_version_number: u8
)
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
.
sourcepub fn swift_nap_error(&self) -> Result<SwiftNapError, u8>
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.
sourcepub fn set_swift_nap_error(&mut self, swift_nap_error: SwiftNapError)
pub fn set_swift_nap_error(&mut self, swift_nap_error: SwiftNapError)
Set the bitrange corresponding to the SwiftNapError of the flags
bitfield.
sourcepub fn io_error(&self) -> Result<IoError, u8>
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.
sourcepub fn set_io_error(&mut self, io_error: IoError)
pub fn set_io_error(&mut self, io_error: IoError)
Set the bitrange corresponding to the IoError of the flags
bitfield.
sourcepub fn system_error_flag(&self) -> Result<SystemErrorFlag, u8>
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.
sourcepub fn set_system_error_flag(&mut self, system_error_flag: SystemErrorFlag)
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
sourceimpl Clone for MsgHeartbeat
impl Clone for MsgHeartbeat
sourcefn clone(&self) -> MsgHeartbeat
fn clone(&self) -> MsgHeartbeat
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl ConcreteMessage for MsgHeartbeat
impl ConcreteMessage for MsgHeartbeat
sourceconst MESSAGE_TYPE: u16
const MESSAGE_TYPE: u16
The message type.
sourceconst MESSAGE_NAME: &'static str
const MESSAGE_NAME: &'static str
The message name.
sourceimpl Debug for MsgHeartbeat
impl Debug for MsgHeartbeat
sourceimpl From<MsgHeartbeat> for Sbp
impl From<MsgHeartbeat> for Sbp
sourcefn from(msg: MsgHeartbeat) -> Self
fn from(msg: MsgHeartbeat) -> Self
Performs the conversion.
sourceimpl SbpMessage for MsgHeartbeat
impl SbpMessage for MsgHeartbeat
sourcefn message_name(&self) -> &'static str
fn message_name(&self) -> &'static str
Get the message name.
sourcefn message_type(&self) -> u16
fn message_type(&self) -> u16
Get the message type.
sourcefn set_sender_id(&mut self, new_id: u16)
fn set_sender_id(&mut self, new_id: u16)
Set the sender id.
sourcefn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Number of bytes this message will take on the wire.
Auto Trait Implementations
impl RefUnwindSafe for MsgHeartbeat
impl Send for MsgHeartbeat
impl Sync for MsgHeartbeat
impl Unpin for MsgHeartbeat
impl UnwindSafe for MsgHeartbeat
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more