Safe API Framework 0.1.0 build 384e6ae
Layered API framework for safety-related applications (ERTMS RBC reference targeting CENELEC EN 50128 SIL 4)
Loading...
Searching...
No Matches
rte_protocol_config_t Struct Reference

Configuration passed to open a protocol adapter instance. More...

#include <rte_protocol_adapter.h>

Data Fields

rte_protocol_type_t protocol_type
rte_protocol_role_t role
char host [RTE_PROTOCOL_ENDPOINT_STR_MAX]
 Host address (UDP/TCP) or domain partition.
uint16_t port
 Port (UDP/TCP).
char topic [RTE_PROTOCOL_ENDPOINT_STR_MAX]
 Topic name (DDS).
uint32_t domain_id
 Domain ID (DDS).
size_t max_message_size
 Maximum expected message payload size.
rte_duration_ms_t open_timeout_ms
 Open / handshake timeout in milliseconds.
rte_duration_ms_t default_timeout_ms
 Default read/write timeout in milliseconds.
bool use_handshake
 Enable handshake (HELLO/ACK) for raw UDP.

Detailed Description

Configuration passed to open a protocol adapter instance.

Definition at line 62 of file rte_protocol_adapter.h.

Field Documentation

◆ protocol_type

rte_protocol_type_t rte_protocol_config_t::protocol_type

Definition at line 64 of file rte_protocol_adapter.h.

◆ role

rte_protocol_role_t rte_protocol_config_t::role

Definition at line 65 of file rte_protocol_adapter.h.

◆ host

char rte_protocol_config_t::host[RTE_PROTOCOL_ENDPOINT_STR_MAX]

Host address (UDP/TCP) or domain partition.

Definition at line 68 of file rte_protocol_adapter.h.

◆ port

uint16_t rte_protocol_config_t::port

Port (UDP/TCP).

Definition at line 71 of file rte_protocol_adapter.h.

◆ topic

char rte_protocol_config_t::topic[RTE_PROTOCOL_ENDPOINT_STR_MAX]

Topic name (DDS).

Definition at line 74 of file rte_protocol_adapter.h.

◆ domain_id

uint32_t rte_protocol_config_t::domain_id

Domain ID (DDS).

Definition at line 77 of file rte_protocol_adapter.h.

◆ max_message_size

size_t rte_protocol_config_t::max_message_size

Maximum expected message payload size.

Definition at line 80 of file rte_protocol_adapter.h.

◆ open_timeout_ms

rte_duration_ms_t rte_protocol_config_t::open_timeout_ms

Open / handshake timeout in milliseconds.

Definition at line 83 of file rte_protocol_adapter.h.

◆ default_timeout_ms

rte_duration_ms_t rte_protocol_config_t::default_timeout_ms

Default read/write timeout in milliseconds.

Definition at line 86 of file rte_protocol_adapter.h.

◆ use_handshake

bool rte_protocol_config_t::use_handshake

Enable handshake (HELLO/ACK) for raw UDP.

Definition at line 89 of file rte_protocol_adapter.h.


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