RTI Connext DDS Micro C API  Version 4.1.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
NETIO_DGRAM_InterfaceTableEntry Struct Reference

<<eXtension>> <<cert>> . More...

#include <netio_dgram.h>

Data Fields

RTI_INT32 locator_kind
 Locator type supported by the interface, such as UDPv4.
RTI_UINT32 flags
 The flags attribute is a bitmap used to indicate capabilities of the transport.
RTI_UINT32 mtu
 The maximum message size that can be sent and received by the transport.
struct NETIO_Address address
 The address of the interface.
struct
NETIO_DGRAM_InterfaceMultiCastGroup 
multicast_group
 An optional multicast group for the interface.
const char * ifname
 The interface name is not used by RTI Connext DDS Micro.

Detailed Description


Field Documentation

RTI_INT32 NETIO_DGRAM_InterfaceTableEntry::locator_kind

Locator type supported by the interface, such as UDPv4.

The locator_kind describes the transport protocol. For example, a locator_kind equal to 1 is reserved for DDS UDPv4 transport. Note the locator_kind is used discovery and if a locator_kind is discovered, but unsupported, no communication will take place using locators of that kind.

Note that the locator_kind must be less than NETIO_ADDRESS_RTPS_RESERVED_LOW and greater than NETIO_ADDRESS_RTPS_RESERVED_HIGH.

RTI_UINT32 NETIO_DGRAM_InterfaceTableEntry::flags

The flags attribute is a bitmap used to indicate capabilities of the transport.

RTI_UINT32 NETIO_DGRAM_InterfaceTableEntry::mtu

The maximum message size that can be sent and received by the transport.

The mtu should be set to the maximum number of octets that can be sent and received in a message over the transport, excluding overhead required by the transport. RTI Connext DDS Micro uses the smallest mtu across all available transports to determine the maximum numher of octets that can be sent in a single message.

struct NETIO_Address NETIO_DGRAM_InterfaceTableEntry::address

The address of the interface.

This is the address that is announced to other DDS DomainParticipants that this transport can receive messages on.

Note: This address must not be within the multicast group.

struct NETIO_DGRAM_InterfaceMultiCastGroup NETIO_DGRAM_InterfaceTableEntry::multicast_group

An optional multicast group for the interface.

This attribute can be used to specify a group of addresses that should be considered multicast addresses. Multicast addresses are address that is sent to once, but received by many and can be a more efficient mechanism to distribute data. RTI Connext DDS Micro will prioritize sending to multicast addresses over unciast addresses.

Note the following restrictions:

  • All the multicast_group.netmask.mask array elements must be 0
  • The multicast_group.netmask.bits must be in the range [0,128]
const char* NETIO_DGRAM_InterfaceTableEntry::ifname

The interface name is not used by RTI Connext DDS Micro.


RTI Connext DDS Micro C API Version 4.1.0 Copyright © Sun Dec 8 2024 Real-Time Innovations, Inc