Zero Copy v2 API

NETIO Zero Copy v2 interface. More...

Classes
struct	ZCOPY_NotifMechanismProperty
	Notification mechanism property for the default implementation. More...
struct	ZCOPY_NotifInterfaceFactoryProperty
	Notification interface property. More...
struct	ZCOPY_NotifUserInterfaceI
	Notification mechanism user interface. More...

Macros
#define	ZCOPY_NotifInterfaceFactoryProperty_INITIALIZER
	Constant to initialize a ZCOPY_NotifInterfaceFactoryProperty.

Typedefs
typedef NETIO_Interface_T *(*	ZCOPY_NotifUserInterface_createFunc )(NETIO_Interface_T *upstream, void *user_property)
	Create an instance of a user interface with upstream as the owner.
typedef void(*	ZCOPY_NotifUserInterface_deleteFunc )(NETIO_Interface_T *user_intf)
	Delete 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

NETIO Zero Copy v2 interface.

<<eXtension>> The NETIO Zero Copy v2 module implements the RTI Connext DDS Micro Zero Copy v2 interface.

---

Macro Definition Documentation

#define ZCOPY_NotifInterfaceFactoryProperty_INITIALIZER

Value:

{                   \
    NETIO_InterfaceFactoryProperty_INITIALIZER, /* _parent */               \
    1,                                          /* max_samples_per_notif */ \
    NULL,                                       /* user_intf */             \
    NULL,                                       /* user_property */         \
}

Constant to initialize a ZCOPY_NotifInterfaceFactoryProperty.

---

Typedef Documentation

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

Create an instance of a user interface with upstream as the owner.

typedef void(* ZCOPY_NotifUserInterface_deleteFunc)(NETIO_Interface_T *user_intf)

Delete 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.

Instruct the notification mechanism interface specified by user_intf to setup 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.

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.

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

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.

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.

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.

Not available in CERT.

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

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.

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

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.

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.

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.

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

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

Notify a specific receive port.

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