Notification Interface

ZCOPY Notification Interface. More...

Data Structures
struct	ZCOPY_NotifInterfaceFactoryProperty
	Notification interface factory specific property. More...

Macros
#define	ZCOPY_NotifInterfaceFactoryProperty_INITIALIZER
	Constant to initialize a ZCOPY_NotifInterfaceFactoryProperty.

Functions
RTI_BOOL	ZCOPY_NotifInterface_receive (NETIO_Interface_T *netio_intf, const struct NETIO_Address *port, RTI_BOOL *has_more_data_out)
	Definition of the NETIO_InterfaceI receive method.
RTI_BOOL	ZCOPY_NotifInterfaceFactory_register (RT_Registry_T *registry, const char *name, struct ZCOPY_NotifInterfaceFactoryProperty *property)
	Register the a Notification interface factory with a factory property.
RTI_BOOL	ZCOPY_NotifInterfaceFactory_unregister (RT_Registry_T *registry, const char *name)
	Unregister a Notification interface factory.

---

Detailed Description

ZCOPY Notification Interface.

The Notification Interface is implemented as a NETIO interface and NETIO interface factory.

---

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.

---

Function Documentation

RTI_BOOL ZCOPY_NotifInterface_receive	(	NETIO_Interface_T *	netio_intf,
		const struct NETIO_Address *	port,
		RTI_BOOL *	has_more_data_out
	)

Definition of the NETIO_InterfaceI receive method.

Parameters:

[in]	netio_intf	The Notification interface to receive on
[in]	port	The port to receive on
[out]	has_more_data_out	Whether there is more data to receive

Returns:

RTI_TRUE on success, RTI_FALSE on failure

See Also NETIO_Interface_receive, NETIO_InterfaceI

RTI_BOOL ZCOPY_NotifInterfaceFactory_register	(	RT_Registry_T *	registry,
		const char *	name,
		struct ZCOPY_NotifInterfaceFactoryProperty *	property
	)

Register the a Notification interface factory with a factory property.

Parameters:

[in]	registry	The registry to register the factory with
[in]	name	The name to register the factory with
[in]	property	The property to register the factory with

Returns:

RTI_TRUE if the factory was registered successfully, RTI_FALSE otherwise

RTI_BOOL ZCOPY_NotifInterfaceFactory_unregister	(	RT_Registry_T *	registry,
		const char *	name
	)

Unregister a Notification interface factory.

Parameters:

[in]	registry	The registry to unregister the factory from
[in]	name	The name to unregister the factory from

Returns:

RTI_TRUE if the factory was unregistered successfully, RTI_FALSE otherwise