pips_event_new_data_handler_t

Updated: May 06, 2022

Prototype of handlers for new data events

Synopsis:

#include <pips/event.h>
typedef int pips_event_new_data_handler_t(void *user_data,
                                          pips_publication_t *const publication,
                                          const pips_guid_t *const writer_guid);

Arguments:

user_data
A pointer to the user data that was supplied when the callback was registered
publication
A pointer to the publication for which new data was received
writer_guid
The GUID associated with the writer of the new data sample. This argument may be NULL if the writer's GUID is not known.

Library:

pips-client

Description:

This data type describes the prototype for callback functions that can be registered by clients to handle new data events from the PiPS framework.

Returns:

The event framework expects that the handler will return a negative value and set errno if it encounters an error condition, and return a value greater than or equal to zero on success.