NETIO Address API

Data Structures
struct	NETIO_AddressUInt32
	<<eXtension>> <<cert>> NETIO_AddressUInt32 More...
union	NETIO_AddressValue
	<<eXtension>> <<cert>> NETIO_AddresValue More...
struct	NETIO_Address
struct	NETIO_Netmask
	<<eXtension>> <<cert>> NETIO_Netmask More...
struct	NETIO_AddressSeq
	<<eXtension>> <<cert>> The NETIO_AddressSeq sequence type. More...
struct	NETIO_NetmaskSeq
	<<eXtension>> <<cert>> The NETIO_NetmaskSeq sequence type. More...

Macros
#define	NETIO_ADDRESS_KIND_UDPv4   1
	<<eXtension>> <<cert>> The UDPv4 NETIO Address.
#define	NETIO_ADDRESS_KIND_UDPv6   2
	<<eXtension>> <<cert>> The UDPv6 NETIO Address.
#define	NETIO_ADDRESS_RTPS_RESERVED_LOW   0x02000000
	<<eXtension>> <<cert>> Addresses in the range [NETIO_ADDRESS_RTPS_RESERVED_LOW, NETIO_ADDRESS_RTPS_RESERVED_HIGH] are reserved by the RTPS standard.
#define	NETIO_ADDRESS_RTPS_RESERVED_HIGH   0x02ffffff
	<<eXtension>> <<cert>> Addresses in the range [NETIO_ADDRESS_RTPS_RESERVED_LOW, NETIO_ADDRESS_RTPS_RESERVED_HIGH] are reserved by the RTPS standard.
#define	NETIO_Netmask_INITIALIZER
	<<eXtension>> <<cert>> Initialize a NETIO_Netmask.
#define	NETIO_Address_INITIALIZER
	<<eXtension>> <<cert>> Initialize a NETIO_Address.

Functions
RTI_BOOL	NETIO_Address_set_multicast (struct NETIO_Address *const addr)
	Mark a NETIO_Address as a multicast address.
void	NETIO_Address_set_ipv4 (struct NETIO_Address *addr, RTI_UINT32 port, RTI_UINT32 address)
	Set the IPv4 address.

---

Detailed Description

---

Macro Definition Documentation

#define NETIO_ADDRESS_KIND_UDPv4   1

<<eXtension>> <<cert>> The UDPv4 NETIO Address.

#define NETIO_ADDRESS_KIND_UDPv6   2

<<eXtension>> <<cert>> The UDPv6 NETIO Address.

#define NETIO_ADDRESS_RTPS_RESERVED_LOW   0x02000000

<<eXtension>> <<cert>> Addresses in the range [NETIO_ADDRESS_RTPS_RESERVED_LOW, NETIO_ADDRESS_RTPS_RESERVED_HIGH] are reserved by the RTPS standard.

#define NETIO_ADDRESS_RTPS_RESERVED_HIGH   0x02ffffff

<<eXtension>> <<cert>> Addresses in the range [NETIO_ADDRESS_RTPS_RESERVED_LOW, NETIO_ADDRESS_RTPS_RESERVED_HIGH] are reserved by the RTPS standard.

#define NETIO_Netmask_INITIALIZER

Value:

{\
    0,\
    {0,0,0,0}\
}

<<eXtension>> <<cert>> Initialize a NETIO_Netmask.

#define NETIO_Address_INITIALIZER

Value:

{\
    NETIO_ADDRESS_KIND_RESERVED, /* kind */ \
    0, /* port */ \
    {{0,0,0,0}} /* value */ \
}

<<eXtension>> <<cert>> Initialize a NETIO_Address.

---

Function Documentation

RTI_BOOL NETIO_Address_set_multicast

(

struct NETIO_Address *const

addr

)

Mark a NETIO_Address as a multicast address.

Parameters:

[in]

addr

Address to set as multicast. Must be non-NULL.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

MT Safety:

This operation is not thread safe.

void NETIO_Address_set_ipv4	(	struct NETIO_Address *	addr,
		RTI_UINT32	port,
		RTI_UINT32	address
	)

Set the IPv4 address.

<<eXtension>> <<cert>>

MT Safety:

This operation is not thread safe. Set the IPv4 address part of a NETIO_Address

Parameters:

[in]	addr	Address to initialize
[in]	port	Address port
[in]	address	IPv4 address in host order