Struct SYN_XRCE_Config

ClassList > SYN_XRCE_Config

Micro XRCE-DDS Client configuration.

• #include <syn_xrce_dds.h>

Public Attributes

Type	Name
uint32_t	client_key
uint32_t	heartbeat_period_ms
SYN_XRCE_DataCb	on_data
SYN_XRCE_StatusCb	on_status
uint8_t *	rx_buf
size_t	rx_buf_size
uint8_t	session_id
SYN_Transport *	transport
uint8_t *	tx_buf
size_t	tx_buf_size
void *	user_data

Public Attributes Documentation

variable client_key

uint32_t SYN_XRCE_Config::client_key;

32-bit unique client identifier

---

variable heartbeat_period_ms

uint32_t SYN_XRCE_Config::heartbeat_period_ms;

Keep-alive ping interval in ms

---

variable on_data

SYN_XRCE_DataCb SYN_XRCE_Config::on_data;

Incoming message callback

---

variable on_status

SYN_XRCE_StatusCb SYN_XRCE_Config::on_status;

Command status callback

---

variable rx_buf

uint8_t* SYN_XRCE_Config::rx_buf;

RX scratch buffer

---

variable rx_buf_size

size_t SYN_XRCE_Config::rx_buf_size;

RX buffer size (>= 256 bytes)

---

variable session_id

uint8_t SYN_XRCE_Config::session_id;

Session ID (default 0x81)

---

variable transport

SYN_Transport* SYN_XRCE_Config::transport;

Transport adapter

---

variable tx_buf

uint8_t* SYN_XRCE_Config::tx_buf;

TX scratch buffer

---

variable tx_buf_size

size_t SYN_XRCE_Config::tx_buf_size;

TX buffer size (>= 256 bytes)

---

variable user_data

void* SYN_XRCE_Config::user_data;

Context pointer for callbacks

---

---

The documentation for this class was generated from the following file src/syntropic/proto/syn_xrce_dds.h