RTI Connext Cert C API  Version 2.4.15
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
UDP_InterfaceFactoryProperty Struct Reference

<<eXtension>> <<cert>> Properties for the UDP Transport. More...

Data Fields

struct REDA_StringSeq allow_interface
 Sequence of allowed interface names.
struct REDA_StringSeq deny_interface
 Sequence of denied interface names. This list is checked after the allow_interface list.
RTI_INT32 max_send_buffer_size
 The size of the send socket buffer.
RTI_INT32 max_receive_buffer_size
 The size of the receive socket buffer.
RTI_INT32 max_message_size
 The maximum size of the message which can be sent or received.
RTI_INT32 max_send_message_size
 The maximum size of the message which can be sent. This is only a hint and not enforced.
RTI_INT32 multicast_ttl
 The maximum TTL.
struct UDP_InterfaceTableEntrySeq if_table
 The interface table if interfaces are added manually.
REDA_String_T multicast_interface
 The network interface to use to send to multicast.
RTI_BOOL is_default_interface
 If this should be considered the default UDP interfaces if no other UDP interface is found to handle a route.
struct OSAPI_ThreadProperty recv_thread
 Thread properties for each receive thread created by this NETIO interface.

Detailed Description

<<eXtension>> <<cert>> Properties for the UDP Transport.


Field Documentation

struct REDA_StringSeq UDP_InterfaceFactoryProperty::allow_interface

Sequence of allowed interface names.

struct REDA_StringSeq UDP_InterfaceFactoryProperty::deny_interface

Sequence of denied interface names. This list is checked after the allow_interface list.

RTI_INT32 UDP_InterfaceFactoryProperty::max_send_buffer_size

The size of the send socket buffer.

RTI_INT32 UDP_InterfaceFactoryProperty::max_receive_buffer_size

The size of the receive socket buffer.

RTI_INT32 UDP_InterfaceFactoryProperty::max_message_size

The maximum size of the message which can be sent or received.

The UDP_InterfaceFactoryProperty::max_message_size resource limit limits the size of the maximum message that can be received.

RTI Connext Micro does not support RTPS fragmentation. Thus, this resource-limit must be at least large enough to receive the largest serialized data-type plus overhead. A reasonable rule-of-thumb for overhead is 256 bytes per sample.

The UDP transport allocated on buffer for each resource in DDS_DomainParticipantResourceLimitsQosPolicy::max_receive_ports. Thus, the total amount of memory is (max_message_size * max_receive_ports)

RTI_INT32 UDP_InterfaceFactoryProperty::max_send_message_size

The maximum size of the message which can be sent. This is only a hint and not enforced.

This parameters is useful to UDP transformation functions which must allocate a buffer to put the result in.

RTI_INT32 UDP_InterfaceFactoryProperty::multicast_ttl

The maximum TTL.

struct UDP_InterfaceTableEntrySeq UDP_InterfaceFactoryProperty::if_table

The interface table if interfaces are added manually.

REDA_String_T UDP_InterfaceFactoryProperty::multicast_interface

The network interface to use to send to multicast.

RTI_BOOL UDP_InterfaceFactoryProperty::is_default_interface

If this should be considered the default UDP interfaces if no other UDP interface is found to handle a route.

struct OSAPI_ThreadProperty UDP_InterfaceFactoryProperty::recv_thread

Thread properties for each receive thread created by this NETIO interface.


RTI Connext Cert C API Version 2.4.15 Copyright © Tue Jan 21 2025 Real-Time Innovations, Inc