Notification mechanism user interface. More...

#include <netio_zcopy_notif_mechanism_intf.h>

Public Attributes
ZCOPY_NotifUserInterface_createFunc	create_instance
	Create an instance of the notification mechanism interface with upstream as the owner.

ZCOPY_NotifUserInterface_deleteFunc	delete_instance
	Delete an instance of the notification mechanism interface.

NETIO_Interface_resolve_addressFunc	resolve_address
	Resolve an address string from the notification mechanism interface.

NETIO_Interface_get_route_tableFunc	get_route_table
	Get the notification mechanism interface route table.

ZCOPY_NotifUserInterface_reserve_addressFunc	reserve_address
	Reserve an address with the notification mechanism interface.

ZCOPY_NotifUserInterface_release_addressFunc	release_address
	Release addresses to the notification mechanism interface.

ZCOPY_NotifUserInterface_add_routeFunc	add_route
	Add a route on the notification mechanism interface.

ZCOPY_NotifUserInterface_delete_routeFunc	delete_route
	Delete a route on the notification mechanism interface.

ZCOPY_NotifUserInterface_bindFunc	bind
	Bind on the notification mechanism interface.

ZCOPY_NotifUserInterface_unbindFunc	unbind
	Unbind on the notification mechanism interface.

ZCOPY_NotifUserInterface_sendFunc	send
	Send a notification using the notification mechanism interface.

ZCOPY_NotifUserInterface_notify_portFunc	notify_recv_port
	Notify the receive port.

Detailed Description

Notification mechanism user interface.

Interface functions for the notification mechanism user interface. This allows the user to specify custom implementations of the notification mechanism. The Default Notification Mechanism provided with /ndds can be accessed using ::DDSZCOPY_NotifUserInterface::get_interface.

See also: ::DDSZCOPY_NotifMechanism::register

Member Data Documentation

◆ create_instance

ZCOPY_NotifUserInterface_createFunc ZCOPY_NotifUserInterfaceI::create_instance

Create an instance of the notification mechanism interface with upstream as the owner.

Parameters

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

Returns: The user interface instance or NULL if an error occurred

◆ delete_instance

ZCOPY_NotifUserInterface_deleteFunc ZCOPY_NotifUserInterfaceI::delete_instance

Delete an instance of the notification mechanism interface.

Not available in CERT.

Parameters

user_intf[in] The user interface instance.

◆ resolve_address

NETIO_Interface_resolve_addressFunc ZCOPY_NotifUserInterfaceI::resolve_address

Resolve an address string from the notification mechanism interface.

Instruct the notification mechanism interface specified by user_intf to determine if the address string address_string is a valid address and return the result in address_value.

Parameters

[in]	netio_intf	Interface.
[in]	netio_intf	The interface entry requested to resolve the address.
[in]	address_string	The address to convert.
[out]	address_value	The converted address.
[out]	invalid	If the address is valid or not.

Returns: RTI_TRUE on success, RTI_FALSE on failure.

◆ get_route_table

NETIO_Interface_get_route_tableFunc ZCOPY_NotifUserInterfaceI::get_route_table

Get the notification mechanism interface route table.

Instruct the notification mechanism interface netio_intf to return a sequence of address and netmask pairs this interface can send to.

Parameters

[in]	netio_intf	The Notif interface.
[in,out]	address	Sequence of NETIO addresses this interface understands.
[in,out]	netmask	Sequence of the corresponding netmasks.

Returns: RTI_TRUE on success, RTI_FALSE on failure.;

◆ reserve_address

ZCOPY_NotifUserInterface_reserve_addressFunc ZCOPY_NotifUserInterfaceI::reserve_address

Reserve an address with the notification mechanism interface.

Instruct the notification mechanism interface specified by user_intf to set up resources for listening to messages on the address src_addr and return a port_entry_out. The port_entry_out will be provided to a bind call.

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.

◆ release_address

ZCOPY_NotifUserInterface_release_addressFunc ZCOPY_NotifUserInterfaceI::release_address

Release addresses to the notification mechanism interface.

Instruct the notification mechanism interface specified by user_intf to release resources for listening to messages on the address src_addr.

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

◆ add_route

ZCOPY_NotifUserInterface_add_routeFunc ZCOPY_NotifUserInterfaceI::add_route

Add a route on the notification mechanism interface.

Instruct the notification mechanism interface specified by user_intf to add a route from the source to the destination. The route_entry_out will be provided to the user later when calling send.

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

◆ delete_route

ZCOPY_NotifUserInterface_delete_routeFunc ZCOPY_NotifUserInterfaceI::delete_route

Delete a route on the notification mechanism interface.

Instruct the notification mechanism interface specified by user_intf to remove a route from the source to the destination.

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.

◆ bind

ZCOPY_NotifUserInterface_bindFunc ZCOPY_NotifUserInterfaceI::bind

Bind on the notification mechanism interface.

Instruct the notification mechanism interface specified by user_intf to start listening for messages on the address specified by src_addr on the given port_entry.

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

◆ unbind

ZCOPY_NotifUserInterface_unbindFunc ZCOPY_NotifUserInterfaceI::unbind

Unbind on the notification mechanism interface.

Instruct the notification mechanism interface specified by user_intf to stop listening for messages on the address specified by src_addr.

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.

◆ send

ZCOPY_NotifUserInterface_sendFunc ZCOPY_NotifUserInterfaceI::send

Send a notification using the notification mechanism interface.

Instruct the notification mechanism interface specified by user_intf to send a notification to the destination using the route_entry.

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.

◆ notify_recv_port

ZCOPY_NotifUserInterface_notify_portFunc ZCOPY_NotifUserInterfaceI::notify_recv_port

Notify the receive port.

Instruct the notification mechanism interface specified by user_intf to notify the receive port specified by port_entry.

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.

Public Attributes

Detailed Description

Member Data Documentation

◆ create_instance

◆ delete_instance

◆ resolve_address

◆ get_route_table

◆ reserve_address

◆ release_address

◆ add_route

◆ delete_route

◆ bind

◆ unbind

◆ send

◆ notify_recv_port