AP_Event_Functions Struct Reference

Event functions API. More...

#include <engine_client_c.h>

Public Member Functions
const AP_char8 *AP_ENGINE_CLIENT_CALL *	getText (AP_Event *event)
	Retrieve the event's type and its contents as a string. More...
const AP_char8 *AP_ENGINE_CLIENT_CALL *	getChannel (AP_Event *event)
	Retrieve the event's channel. More...
	double (AP_ENGINE_CLIENT_CALL *getTime)(AP_Event *event)
	Retrieve the event's timestamp. More...

Detailed Description

Event functions API.

Deprecated:

The C++ API should be used in preference

Member Function Documentation

AP_Event_Functions::double

(

AP_ENGINE_CLIENT_CALL *

getTime

)

Retrieve the event's timestamp.

This timestamp currently only has meaning for events which have been sourced from the correlator, in which case it is set to the correlator time at which it was created, or the value it was set to explicitly by code running within the correlator.

Returns

the timestamp of the event, in floating point seconds since the Unix epoch.

Deprecated:

The C++ API should be used in preference

const AP_char8* AP_ENGINE_CLIENT_CALL* AP_Event_Functions::getChannel

(

AP_Event *

event

)

Retrieve the event's channel.

This currently only has meaning for events which have been sourced from the correlator, in which case it is set to the name of the channel the event was emitted from, or "" (the empty string) for the wildcard channel.

Returns

The channel of the event, encoded in UTF-8.

Deprecated:

The C++ API should be used in preference

const AP_char8* AP_ENGINE_CLIENT_CALL* AP_Event_Functions::getText

(

AP_Event *

event

)

Retrieve the event's type and its contents as a string.

Returns

C style string with the event's textual representation. Note that these strings should be encoded in UTF-8.

Deprecated:

The C++ API should be used in preference

---

The documentation for this struct was generated from the following file:

• engine_client_c.h