tin  1.5.9
tsm::transport::m2m_frame< MaxBytes > Struct Template Reference

#include <transport.h>

Collaboration diagram for tsm::transport::m2m_frame< MaxBytes >:
Collaboration graph

Public Attributes

std::uint32_t source_id {}
 
std::uint32_t destination_id {}
 
std::uint32_t sequence {}
 
std::uint16_t kind {}
 
bool crc_ok { true }
 
payload_buffer< MaxBytes > payload {}
 

Detailed Description

template<std::size_t MaxBytes>
struct tsm::transport::m2m_frame< MaxBytes >

Embedded machine-to-machine frame.

This covers bounded links such as CAN, CANopen, EtherCAT supervisory frames, framed UART, SPI, I2C, UDP, or custom packets. The adapter checks transport validity that is common enough to model here, then asks the application decoder to map the frame kind and payload to a typed HSM event.

Member Data Documentation

◆ crc_ok

template<std::size_t MaxBytes>
bool tsm::transport::m2m_frame< MaxBytes >::crc_ok { true }

◆ destination_id

template<std::size_t MaxBytes>
std::uint32_t tsm::transport::m2m_frame< MaxBytes >::destination_id {}

◆ kind

template<std::size_t MaxBytes>
std::uint16_t tsm::transport::m2m_frame< MaxBytes >::kind {}

◆ payload

template<std::size_t MaxBytes>
payload_buffer<MaxBytes> tsm::transport::m2m_frame< MaxBytes >::payload {}

◆ sequence

template<std::size_t MaxBytes>
std::uint32_t tsm::transport::m2m_frame< MaxBytes >::sequence {}

◆ source_id

template<std::size_t MaxBytes>
std::uint32_t tsm::transport::m2m_frame< MaxBytes >::source_id {}

The documentation for this struct was generated from the following file: