 |
Apama
9.12.0.5
|
|
Apama
9.12.0.5
|
PluginContext function API. More...
#include <correlator_plugin.h>
Public Member Functions | |
| AP_uint32 (AP_PLUGIN_CALL *version)(const AP_PluginContext *ctx) | |
| Return active plugin API version. More... | |
| AP_PluginChunk *AP_PLUGIN_CALL * | createChunk (const AP_PluginContext *ctx, const struct AP_PluginChunk_Callbacks *callbacks, void *userData) |
| Create a chunk. More... | |
| AP_bool (AP_PLUGIN_CALL *checkException)(const AP_PluginContext *ctx) | |
| Returns true if an exception has occurred since the last time that clearException was called. More... | |
| AP_CorrelatorPluginExceptionType (AP_PLUGIN_CALL *getExceptionType)(const AP_PluginContext *ctx) | |
| Returns the type of the most recent exception. More... | |
| const AP_char8 *AP_PLUGIN_CALL * | getExceptionMessage (const AP_PluginContext *ctx) |
| Returns the message of the most recent exception. More... | |
| void (AP_PLUGIN_CALL *clearException)(const AP_PluginContext *ctx) | |
| Clears the flag of whether an exception has occurred. More... | |
| AP_PluginCorrelatorInterface *AP_PLUGIN_CALL * | getCorrelator (const AP_PluginContext *ctx) |
| Return the correlator implementation. More... | |
| void (AP_PLUGIN_CALL *char8free)(AP_char8 *ptr) | |
| Free the memory occupied by a string created by the plugin API. More... | |
| AP_uint64 (AP_PLUGIN_CALL *getContextId)(const AP_PluginContext *ctx) | |
| Return the identifier of the EPL (parallelism) context associated with this plugin execution context. More... | |
PluginContext function API.
| AP_PluginContext_Functions::AP_bool | ( | AP_PLUGIN_CALL * | checkException | ) | const |
Returns true if an exception has occurred since the last time that clearException was called.
| AP_PluginContext_Functions::AP_CorrelatorPluginExceptionType | ( | AP_PLUGIN_CALL * | getExceptionType | ) | const |
Returns the type of the most recent exception.
| AP_PluginContext_Functions::AP_uint32 | ( | AP_PLUGIN_CALL * | version | ) | const |
Return active plugin API version.
| AP_PluginContext_Functions::AP_uint64 | ( | AP_PLUGIN_CALL * | getContextId | ) | const |
Return the identifier of the EPL (parallelism) context associated with this plugin execution context.
| AP_PluginChunk* AP_PLUGIN_CALL* AP_PluginContext_Functions::createChunk | ( | const AP_PluginContext * | ctx, |
| const struct AP_PluginChunk_Callbacks * | callbacks, | ||
| void * | userData | ||
| ) |
Create a chunk.
userData will always be freed using the supplied callback after using this in a call. You should not explicitly delete this chunk or the supplied userData.
| userData | a void pointer to your data to be held in the chunk |
| callbacks | a function pointer structure to free or copy userData |
| AP_PluginCorrelatorInterface* AP_PLUGIN_CALL* AP_PluginContext_Functions::getCorrelator | ( | const AP_PluginContext * | ctx | ) |
Return the correlator implementation.
| const AP_char8* AP_PLUGIN_CALL* AP_PluginContext_Functions::getExceptionMessage | ( | const AP_PluginContext * | ctx | ) |
Returns the message of the most recent exception.
| AP_PluginContext_Functions::void | ( | AP_PLUGIN_CALL * | clearException | ) | const |
Clears the flag of whether an exception has occurred.
| AP_PluginContext_Functions::void | ( | AP_PLUGIN_CALL * | char8free | ) |
Free the memory occupied by a string created by the plugin API.
| s | The source string to be freed. |
1.8.8 
