UDP Transport API

Data Structures
struct	UDP_InterfaceFactoryProperty
	<<eXtension>> <<cert>> Properties for the UDP Transport. More...

Macros
#define	NETIO_ADDRESS_KIND_UDPv4   1
	Constant reserved for UDPv4 address kinds.

Enumerations
enum	UDP_TransformUdpMode_T { UDP_TRANSFORM_UDP_MODE_DISABLED, UDP_TRANSFORM_UDP_MODE_ENABLED }
	UDP_TransformUdpMode_T values. More...

Functions
RTI_BOOL	UDP_InterfaceTable_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.
RTI_BOOL	UDP_InterfaceFactoryProperty_initialize (struct UDP_InterfaceFactoryProperty *self)
	Initialize a UDP factory property.
RTI_BOOL	UDP_InterfaceFactoryProperty_finalize (struct UDP_InterfaceFactoryProperty *p)
	Finalize a UDP factory property.
RTI_BOOL	UDP_TransformRules_assert_source_rule (struct UDP_TransformRuleSeq *src_rules, RTI_INT32 ipv4_address, RTI_UINT32 ipv4_netmask, const char *transform_name, void *user_data)
	Add a source address rule for incoming payloads.
RTI_BOOL	UDP_TransformRules_assert_destination_rule (struct UDP_TransformRuleSeq *dst_rules, RTI_INT32 ipv4_address, RTI_UINT32 ipv4_netmask, const char *transform_name, void *user_data)
	Add a destination address rule for outgoing payloads.
struct RT_ComponentFactoryI *	UDP_InterfaceFactory_get_interface (void)
	Gets the singleton instance of the UDP interface factory.

---

Detailed Description

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

---

Macro Definition Documentation

#define NETIO_ADDRESS_KIND_UDPv4   1

Constant reserved for UDPv4 address kinds.

---

Enumeration Type Documentation

enum UDP_TransformUdpMode_T

UDP_TransformUdpMode_T values.

Operation mode when UDP transformations are enabled

Enumerator:

UDP_TRANSFORM_UDP_MODE_DISABLED	Disable regular UDP. Disable regular UDP, even when no transforms are enabled
UDP_TRANSFORM_UDP_MODE_ENABLED	Enable regular UDP. Allow regular UDP, even when transforms are enabled

---

Function Documentation

RTI_BOOL UDP_InterfaceTable_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.

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

Parameters:

[in]	seq	The sequence to add the entry to
[in]	address	The UDPv4 interface address to add in host order
[in]	netmask	The interface netmask
[in]	ifname	The interface name. Cannot exceed UDP_INTERFACE_MAX_IFNAME including NUL.
[in]	flags	Bitmap of UDP_INTERFACE_INTERFACE_UP_FLAG and/or UDP_INTERFACE_INTERFACE_MULTICAST_FLAG

Returns:

RTI_TRUE on success, RTI_FALSE on failure

RTI_BOOL UDP_InterfaceFactoryProperty_initialize

(

struct UDP_InterfaceFactoryProperty *

self

)

Initialize a UDP factory property.

Parameters:

[in]

self

Property to initialize

Returns:

RTI_TRUE on success, RTI_FALSE on failure

RTI_BOOL UDP_InterfaceFactoryProperty_finalize

(

struct UDP_InterfaceFactoryProperty *

p

)

Finalize a UDP factory property.

Parameters:

[in]

p

Property to finalize

Returns:

RTI_TRUE on success, RTI_FALSE on failure

RTI_BOOL UDP_TransformRules_assert_source_rule	(	struct UDP_TransformRuleSeq *	src_rules,
		RTI_INT32	ipv4_address,
		RTI_UINT32	ipv4_netmask,
		const char *	transform_name,
		void *	user_data
	)

Add a source address rule for incoming payloads.

This function can be used to add rules to the source_rules sequence in the UDP_InterfaceFactoryProperty.

Parameters:

[in]	src_rules	The sequence to add the rule to.
[in]	ipv4_address	The IPv4 address to compare the source of incoming packets to after applying the netmask.
[in]	ipv4_netmask	The IPv4 netmask to apply to the source address of a UDP payload before comparing with ipv4_address.
[in]	transform_name	The name of the transformation to apply to an incoming payload.
[in]	user_data	user data associated with the rule.

Returns:

RTI_TRUE on success, RTI_FALSE on failure

RTI_BOOL UDP_TransformRules_assert_destination_rule	(	struct UDP_TransformRuleSeq *	dst_rules,
		RTI_INT32	ipv4_address,
		RTI_UINT32	ipv4_netmask,
		const char *	transform_name,
		void *	user_data
	)

Add a destination address rule for outgoing payloads.

This function can be used to add rules to the destination_rules in the UDP_InterfaceFactoryProperty.

Parameters:

[in]	dst_rules	The sequence to add the rule to.
[in]	ipv4_address	The IPv4 address to compare the destination of outgoing packets to after applying the netmask.
[in]	ipv4_netmask	The IPv4 netmask to apply to the destination address of a UDP payload before comparing with ipv4_address.
[in]	transform_name	The name of the transformation to apply to an outgoing payload.
[in]	user_data	user data associated with the rule.

Returns:

RTI_TRUE on success, RTI_FALSE on failure

struct RT_ComponentFactoryI* UDP_InterfaceFactory_get_interface ( void  )

read

Gets the singleton instance of the UDP interface factory.

This function gets the singleton instance of the UDP factory that is used by the middleware to create a UDP transport instance.

Returns:

Pointer to UDP factory instance