NETIO Interface API

Data Structures
struct	NETIO_Interface
	Base-class definition for all NETIO interfaces. More...

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

Typedefs
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_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.

Variables
NETIO_DGRAMUserInterface_resolve_addressFunc	NETIO_DGRAM_InterfaceI::resolve_address
	<<eXtension>> <<cert>> Resolve an IPv4 address string to NETIO_Address if possible.
NETIO_Interface_sendFunc	NETIO_DGRAM_InterfaceI::send
NETIO_Interface_get_route_tableFunc	NETIO_DGRAM_InterfaceI::get_route_table
	<<eXtension>> <<cert>> The definition of the::NETIO_InterfaceI get_route_table method.

---

Detailed Description

---

Macro Definition Documentation

#define NETIO_Interface_receive	(		self_,
			src_,
			dst_,
			p_
	)

Value:

((struct NETIO_InterfaceI*)(\
            (self_)->_parent._intf))->receive(self_,src_,dst_,p_)

<<eXtension>> <<cert>> Call receive on a NETIO_Interface.

A NETIO interface receives data from a downstream interface. The data can be in different protocol formats. Depending on the downstream protocol different actions may be taken, but semantically it does not matter where data is coming from. The receive interface is synchronous; all processing takes place in the context of the downstream receive context, such as a thread.

Parameters:

self_	<<in>> The interface receiving data
src_	<<in>> The source address of the data
dst_	<<in>> The destination address of the data
p_	<<in>> A NETIO_Packet with the payload

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

---

Typedef Documentation

typedef struct NETIO_Interface NETIO_Interface_T

<<eXtension>> <<cert>> The abstract NETIO Interface type.

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.

<<eXtension>> <<cert>> The NETIO_Interface resolve_address function.

Parameters:

[in]	self	NETIO interface to send from
[in]	source	The source interface for the packet
[in]	destination	The destination address for the packet
[in]	packet	The packet to send

Returns:

RTI_TRUE on success, RTI_FALSE on failure

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.

<<eXtension>> <<cert>> The NETIO_Interface send function.

Parameters:

[in]	netio_intf	NETIO interface to receive in
[in]	src_addr	The source address of the packet
[in]	dst_addr	The destination address for the packet
[in]	packet	The forwarded packet from downstream

Returns:

RTI_TRUE on success, RTI_FALSE on failure

See Also NETIO_Interface_receive, NETIO_InterfaceI

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.

The implementation of the NETIO resolve_address function. This function is called by resolvers to determine if this interface understands the string address.

Parameters:

netio_intf	<<in>> The interface.
address_string	<<in>> The address to convert.
address_value	<<out>> The converted address on success.
is_invalid	<<out>> Whether the address is valid or not.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

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.

Parameters:

netio_intf	<<in>> The NETIO interface.
address	<<in>> <<out>> The sequence of NETIO addresses this interface understands.
netmask	<<in>> <<out>> The sequence of the corresponding netmasks.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

---

Variable Documentation

NETIO_DGRAMUserInterface_resolve_addressFunc NETIO_DGRAM_InterfaceI::resolve_address

<<eXtension>> <<cert>> Resolve an IPv4 address string to NETIO_Address if possible.

The implementation of the NETIO resolve_address function. This function is called by resolvers to determine if this interface understands the string address.

Parameters:

netio_intf	<<in>> The interface.
address_string	<<in>> The address to convert.
address_value	<<out>> The converted address on success.
is_invalid	<<out>> Whether the address is valid or not.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

NETIO_Interface_sendFunc NETIO_DGRAM_InterfaceI::send

<<eXtension>> <<cert>> The NETIO_Interface resolve_address function.

NETIO_Interface_get_route_tableFunc NETIO_DGRAM_InterfaceI::get_route_table

<<eXtension>> <<cert>> The definition of the::NETIO_InterfaceI get_route_table method.

Parameters:

netio_intf	<<in>> The NETIO interface.
address	<<in>> <<out>> The sequence of NETIO addresses this interface understands.
netmask	<<in>> <<out>> The sequence of the corresponding netmasks.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.