User notification mechanism interface

Notification mechanism definitions. More...

Data Structures
struct	ZCOPY_NotifUserInterfaceI
	Notification mechanism user interface. More...

Typedefs
typedef NETIO_Interface_T *(*	ZCOPY_NotifUserInterface_createFunc )(NETIO_Interface_T *upstream, void *user_property)
	Create an instance of a user interface.
typedef RTI_BOOL(*	ZCOPY_NotifUserInterface_reserve_addressFunc )(NETIO_Interface_T *user_intf, struct NETIO_Address *src_addr, void **port_entry_out)
	Reserve an address on a user interface.
typedef RTI_BOOL(*	ZCOPY_NotifUserInterface_release_addressFunc )(NETIO_Interface_T *user_intf, struct NETIO_Address *src_addr, void *port_entry)
	Release an address on a user interface.
typedef RTI_BOOL(*	ZCOPY_NotifUserInterface_add_routeFunc )(NETIO_Interface_T *user_intf, struct NETIO_Address *source, struct NETIO_Address *destination, void **route_entry_out)
	Add a route on a user interface.
typedef RTI_BOOL(*	ZCOPY_NotifUserInterface_delete_routeFunc )(NETIO_Interface_T *user_intf, struct NETIO_Address *source, struct NETIO_Address *destination, void *route_entry)
	Delete a route on a user interface.
typedef RTI_BOOL(*	ZCOPY_NotifUserInterface_sendFunc )(NETIO_Interface_T *self, struct NETIO_Address *source, struct NETIO_Address *destination, void *route_entry)
	Send a notification on a user interface.
typedef RTI_BOOL(*	ZCOPY_NotifUserInterface_bindFunc )(NETIO_Interface_T *user_intf, struct NETIO_Address *src_addr, struct NETIO_Address *dst_addr, void *port_entry, void **bind_entry_out)
	Bind an address on a user interface.
typedef RTI_BOOL(*	ZCOPY_NotifUserInterface_unbindFunc )(NETIO_Interface_T *user_intf, struct NETIO_Address *src_addr, struct NETIO_Address *dst_addr, void *port_entry, void *bind_entry)
	Unbind an address on a user interface.
typedef RTI_BOOL(*	ZCOPY_NotifUserInterface_notify_portFunc )(NETIO_Interface_T *user_intf, void *port_entry)
	Notify a specific receive port.

---

Detailed Description

Notification mechanism definitions.

---

Typedef Documentation

typedef NETIO_Interface_T*(* ZCOPY_NotifUserInterface_createFunc)(NETIO_Interface_T *upstream, void *user_property)

Create an instance of a user interface.

Parameters:

[in]	upstream	The upstream notification interface
[in]	user_property	The user property

Returns:

The user interface instance or NULL if an error occurred

typedef RTI_BOOL(* ZCOPY_NotifUserInterface_reserve_addressFunc)(NETIO_Interface_T *user_intf, struct NETIO_Address *src_addr, void **port_entry_out)

Reserve an address on a user interface.

Parameters:

[in]	user_intf	The user interface instance
[in]	src_addr	The address to reserve
[out]	port_entry_out	The port entry associated with the address

typedef RTI_BOOL(* ZCOPY_NotifUserInterface_release_addressFunc)(NETIO_Interface_T *user_intf, struct NETIO_Address *src_addr, void *port_entry)

Release an address on a user interface.

Parameters:

[in]	user_intf	The user interface instance
[in]	src_addr	The address to release
[in]	port_entry	The port entry associated with the address

Returns:

RTI_TRUE on success, RTI_FALSE otherwise

typedef RTI_BOOL(* ZCOPY_NotifUserInterface_add_routeFunc)(NETIO_Interface_T *user_intf, struct NETIO_Address *source, struct NETIO_Address *destination, void **route_entry_out)

Add a route on a user interface.

Parameters:

[in]	user_intf	The user interface instance
[in]	source	The source address
[in]	destination	The destination address
[out]	route_entry_out	The route entry associated with the route

Returns:

RTI_TRUE on success, RTI_FALSE otherwise

typedef RTI_BOOL(* ZCOPY_NotifUserInterface_delete_routeFunc)(NETIO_Interface_T *user_intf, struct NETIO_Address *source, struct NETIO_Address *destination, void *route_entry)

Delete a route on a user interface.

Parameters:

[in]	user_intf	The user interface instance
[in]	source	The source address
[in]	destination	The destination address
[in]	route_entry	The route entry associated with the route

Returns:

RTI_TRUE on success, RTI_FALSE otherwise

typedef RTI_BOOL(* ZCOPY_NotifUserInterface_sendFunc)(NETIO_Interface_T *self, struct NETIO_Address *source, struct NETIO_Address *destination, void *route_entry)

Send a notification on a user interface.

Parameters:

[in]	user_intf	The user interface instance
[in]	source	The source address
[in]	destination	The destination address
[in]	route_entry	The route entry associated with the route

Returns:

RTI_TRUE on success, RTI_FALSE otherwise

typedef RTI_BOOL(* ZCOPY_NotifUserInterface_bindFunc)(NETIO_Interface_T *user_intf, struct NETIO_Address *src_addr,struct NETIO_Address *dst_addr,void *port_entry, void **bind_entry_out)

Bind an address on a user interface.

Parameters:

[in]	user_intf	The user interface instance
[in]	src_addr	The remote address
[in]	dst_addr	The local address
[in]	port_entry	The port entry associated with the local address
[out]	bind_entry_out	The bind entry associated with the bind

Returns:

RTI_TRUE on success, RTI_FALSE otherwise

typedef RTI_BOOL(* ZCOPY_NotifUserInterface_unbindFunc)(NETIO_Interface_T *user_intf, struct NETIO_Address *src_addr,struct NETIO_Address *dst_addr,void *port_entry, void *bind_entry)

Unbind an address on a user interface.

Parameters:

[in]	user_intf	The user interface instance
[in]	src_addr	The remote address
[in]	dst_addr	The local address
[in]	port_entry	The port entry associated with the local address
[in]	bind_entry	The bind entry associated with the bind

Returns:

RTI_TRUE on success, RTI_FALSE otherwise

typedef RTI_BOOL(* ZCOPY_NotifUserInterface_notify_portFunc)(NETIO_Interface_T *user_intf, void *port_entry)

Notify a specific receive port.

Used by the reader to send notification on a specific receive port.

Parameters:

[in]	user_intf	The user interface instance
[in]	port_entry	The port entry to notify

Returns:

RTI_TRUE on success, RTI_FALSE otherwise