netio_interface.h File Reference

Generic NETIO_Interface functions. More...

Data Structures
struct	NETIO_Packet
	Implementation of the abstract NETIO_Packet type. More...
struct	NETIO_Interface
	Base-class definition for all NETIO interfaces. More...
struct	NETIO_InterfaceI

Macros
#define	NETIO_Interface_receive(self_, src_, dst_, p_)
	<<eXtension>> <<cert>> Call receive on a NETIO_Interface.

Typedefs
typedef struct NETIO_Packet	NETIO_Packet_T
	A NETIO Packet.
typedef struct NETIO_Interface	NETIO_Interface_T
typedef RTI_BOOL(*	NETIO_Interface_sendFunc )(NETIO_Interface_T *self, struct NETIO_Interface *source, struct NETIO_Address *destination, NETIO_Packet_T *packet)
	Definition of the NETIO_InterfaceI send method.
typedef RTI_BOOL(*	NETIO_Interface_receiveFunc )(NETIO_Interface_T *netio_intf, struct NETIO_Address *src_addr, struct NETIO_Address *dst_addr, NETIO_Packet_T *packet)
	Definition of the NETIO_InterfaceI receive method.
typedef RTI_BOOL(*	NETIO_Interface_reserve_addressFunc )(NETIO_Interface_T *self, struct NETIO_AddressSeq *req_address, struct NETIO_AddressSeq *rsvd_address, struct NETIOBindProperty *property)
	<<eXtension>> <<cert>> The definition of the NETIO_InterfaceI reserve_address method.
typedef RTI_BOOL(*	NETIO_Interface_release_addressFunc )(NETIO_Interface_T *self, struct NETIO_Address *src_addr)
	<<eXtension>> <<cert>> The definition of the NETIO_InterfaceI release_address method.
typedef RTI_BOOL(*	NETIO_Interface_resolve_addressFunc )(NETIO_Interface_T *netio_intf, const char *address_string, struct NETIO_Address *address_value, RTI_BOOL *invalid)
	<<eXtension>> <<cert>> Resolve an IPv4 address string to NETIO_Address if possible.
typedef RTI_BOOL(*	NETIO_Interface_get_route_tableFunc )(NETIO_Interface_T *netio_intf, struct NETIO_AddressSeq *address, struct NETIO_NetmaskSeq *netmask)
	<<eXtension>> <<cert>> The definition of the::NETIO_InterfaceI get_route_table method.

Functions
void *	NETIO_Packet_get_head (const NETIO_Packet_T *const packet)
	Get a pointer to the current head.
RTI_BOOL	NETIO_Packet_set_payload (NETIO_Packet_T *const packet, void *buffer, RTI_INT32 buffer_length)
	Initialize a packet with a payload.
RTI_SIZE_T	NETIO_Packet_get_payload_length (const NETIO_Packet_T *const packet)
	Get the length the packet payload.

Variables
const char *const	NETIO_DEFAULT_UDP_NAME
	Default name for the automatically registered UDP transport.
const char *const	NETIO_DEFAULT_INTRA_NAME
	Default name for the automatically registered INTRA transport.
const char *const	NETIO_DEFAULT_RTPS_NAME
	Default name for the automatically registered RTPS interface.

---

Detailed Description

Generic NETIO_Interface functions.

This file contains generic NETIO interface functions. A NETIO_Interface is a base-class and is typically not instantiated on its own. Derived classes call methods here to initialize/finalize a base-class. This file also defines the NETIO interface structure as well as the NETIO_Packet structure and protocol types.

---

Typedef Documentation

typedef RTI_BOOL(* NETIO_Interface_reserve_addressFunc)(NETIO_Interface_T *self, struct NETIO_AddressSeq *req_address, struct NETIO_AddressSeq *rsvd_address, struct NETIOBindProperty *property)

<<eXtension>> <<cert>> The definition of the NETIO_InterfaceI reserve_address method.

Parameters:

self	<<in>> The NETIO interface to reserve addresses on.
req_address	<<in>> The list of requested addresses.
rsvd_address	<<in>> <<out>> The downstream interface.
property	<<in>> Properties to use to listen on the reserved addresses.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

typedef RTI_BOOL(* NETIO_Interface_release_addressFunc)(NETIO_Interface_T *self, struct NETIO_Address *src_addr)

<<eXtension>> <<cert>> The definition of the NETIO_InterfaceI release_address method.

Parameters:

self	<<in>> The NETIO interface to release addresses on.
src_addr	<<in>> The address to release.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

---

Variable Documentation

const char* const NETIO_DEFAULT_UDP_NAME

Default name for the automatically registered UDP transport.

const char* const NETIO_DEFAULT_INTRA_NAME

Default name for the automatically registered INTRA transport.

const char* const NETIO_DEFAULT_RTPS_NAME

Default name for the automatically registered RTPS interface.