RTI Connext DDS Micro C++ API  Version 4.0.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
UDP Transport API

Classes

class  UDPInterfaceFactory
 <<eXtension>> <<cert>> A UDP transport factory that will be used by a DomainParticipant to create a UDP interface. Only one UDP interface can be registered with the DomainParticipantFactory. More...
class  UDPInterfaceTable
struct  UDP_NatEntry
 <<eXtension>> Properties for a Network Address Translation entry More...
struct  UDP_NatEntrySeq
 <<eXtension>> Declares IDL sequence<UDP_NatEntry> More...
struct  UDP_InterfaceTableEntry
 Generic structure to describe a network interface. More...
struct  UDP_InterfaceTableEntrySeq
 <<eXtension>> Declares IDL sequence<UDP_InterfaceTableEntry> More...
struct  UDP_InterfaceFactoryProperty
 <<eXtension>> <<cert>> Properties for the UDP Transport. More...

Macros

#define UDP_INTERFACE_MAX_IFNAME   64
 Maximum length of a UDP network interface.
#define UDP_INTERFACE_INTERFACE_UP_FLAG   0x1U
 Generic flag to indicate if a network stack is up.
#define UDP_INTERFACE_INTERFACE_MULTICAST_FLAG   0x2U
 Generic flag to indicate if a network stack supports multicast.
#define UDP_INTERFACE_MAX_NETMASK_BITS   (32U)
 The maximum number of bits in a UDP netmask.
#define T   struct UDP_NatEntry
 Generic structure to describe a network interface.
#define T   struct UDP_InterfaceTableEntry
 Generic structure to describe a network interface.
#define T   struct UDP_TransformRule
 Generic structure to describe a network interface.

Functions

static bool UDPInterfaceTable::add_entry (struct UDP_InterfaceTableEntrySeq *seq, RTI_UINT32 address, RTI_UINT32 netmask, const char *ifname, RTI_UINT32 flags)
 Add an entry to the list of available interfaces.

Detailed Description

<<eXtension>> <<cert>> The UDP transport implements the RTI Connext DDS Micro NETIO interface and supports UDPv4. Please refer to the User Manual for information about how to use the UDP transport.


Macro Definition Documentation

#define UDP_INTERFACE_MAX_IFNAME   64

Maximum length of a UDP network interface.

#define UDP_INTERFACE_INTERFACE_UP_FLAG   0x1U

Generic flag to indicate if a network stack is up.

#define UDP_INTERFACE_INTERFACE_MULTICAST_FLAG   0x2U

Generic flag to indicate if a network stack supports multicast.

#define UDP_INTERFACE_MAX_NETMASK_BITS   (32U)

The maximum number of bits in a UDP netmask.

#define T   struct UDP_NatEntry

Generic structure to describe a network interface.

#define T   struct UDP_InterfaceTableEntry

Generic structure to describe a network interface.

#define T   struct UDP_TransformRule

Generic structure to describe a network interface.


Function Documentation

static bool UDPInterfaceTable::add_entry ( struct UDP_InterfaceTableEntrySeq seq,
RTI_UINT32  address,
RTI_UINT32  netmask,
const char *  ifname,
RTI_UINT32  flags 
)
static

Add an entry to the list of available interfaces.

This function can be used to add an interface to the if_table in the UDP_InterfaceFactoryProperty.

Parameters:
[in]seqThe sequence to add the entry to
[in]addressThe UDPv4 interface address to add in host order
[in]netmaskThe interface netmask, maximum of UDP_INTERFACE_MAX_NETMASK_BITS bits.
[in]ifnameThe interface name. Cannot exceed UDP_INTERFACE_MAX_IFNAME including NUL.
[in]flagsBitmap of UDP_INTERFACE_INTERFACE_UP_FLAG and/or UDP_INTERFACE_INTERFACE_MULTICAST_FLAG
Returns:
RTI_TRUE on success, RTI_FALSE on failure

RTI Connext DDS Micro C++ API Version 4.0.1 Copyright © Mon Jun 3 2024 Real-Time Innovations, Inc