NETIO Interface API

Data Structures
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_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>> 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>> Definition of the NETIO_InterfaceI release_address 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:

[in]	self_	The interface receiving data
[in]	src_	The source address of the data
[in]	dst_	The destination address of the data
[in]	p_	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>> 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>> 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>> 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_reserve_addressFunc)(NETIO_Interface_T *self, struct NETIO_AddressSeq *req_address, struct NETIO_AddressSeq *rsvd_address, struct NETIOBindProperty *property)

<<eXtension>> <<cert>> Definition of the NETIO_InterfaceI reserve_address method

Parameters:

[in]	self	NETIO interface to reserve addresses on
[in]	req_address	List of requested addresses
[in,out]	rsvd_address	The downstream interface
[in]	property	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>> Definition of the NETIO_InterfaceI release_address method

Parameters:

[in]	self	NETIO interface to release addresses on
[in]	src_addr	Address to release

Returns:

RTI_TRUE on success, RTI_FALSE on failure.