Apama  10.3.1.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AP_PluginContext_Functions Struct Reference

[DEPRECATED]
PluginContext function API. More...

#include <correlator_plugin.h>

Public Member Functions

 AP_uint32 (AP_PLUGIN_CALL *version)(const AP_PluginContext *ctx)
 
AP_PluginChunk *AP_PLUGIN_CALL * createChunk (const AP_PluginContext *ctx, const struct AP_PluginChunk_Callbacks *callbacks, void *userData)
 
 void (AP_PLUGIN_CALL *deleteChunk)(const AP_PluginContext *ctx
 
 AP_bool (AP_PLUGIN_CALL *checkException)(const AP_PluginContext *ctx)
 
 AP_CorrelatorPluginExceptionType (AP_PLUGIN_CALL *getExceptionType)(const AP_PluginContext *ctx)
 
const AP_char8 *AP_PLUGIN_CALL * getExceptionMessage (const AP_PluginContext *ctx)
 
 void (AP_PLUGIN_CALL *clearException)(const AP_PluginContext *ctx)
 
AP_PluginCorrelatorInterface
*AP_PLUGIN_CALL * 
getCorrelator (const AP_PluginContext *ctx)
 
 void (AP_PLUGIN_CALL *char8free)(AP_char8 *ptr)
 
 AP_uint64 (AP_PLUGIN_CALL *getContextId)(const AP_PluginContext *ctx)
 

Detailed Description

[DEPRECATED]
PluginContext function API.

Deprecated:
This class has been deprecated.

Member Function Documentation

AP_PluginContext_Functions::AP_bool ( AP_PLUGIN_CALL *  checkException) const
Deprecated:
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
Deprecated:
Returns the type of the most recent exception
AP_PluginContext_Functions::AP_uint32 ( AP_PLUGIN_CALL *  version) const
Deprecated:
  Return active plugin API version
Parameters
versionthis function.
AP_PluginContext_Functions::AP_uint64 ( AP_PLUGIN_CALL *  getContextId) const
Deprecated:
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 
)
Deprecated:
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.

Parameters
ctxthe plug-in context.
userDataa void pointer to your data to be held in the chunk
callbacksa function pointer structure to free or copy userData
AP_PluginCorrelatorInterface* AP_PLUGIN_CALL* AP_PluginContext_Functions::getCorrelator ( const AP_PluginContext *  ctx)
Deprecated:
Return the correlator implementation.
const AP_char8* AP_PLUGIN_CALL* AP_PluginContext_Functions::getExceptionMessage ( const AP_PluginContext *  ctx)
Deprecated:
Returns the message of the most recent exception
AP_PluginContext_Functions::void ( AP_PLUGIN_CALL *  deleteChunk) const
AP_PluginContext_Functions::void ( AP_PLUGIN_CALL *  clearException) const
Deprecated:
Clears the flag of whether an exception has occurred
AP_PluginContext_Functions::void ( AP_PLUGIN_CALL *  char8free)
Deprecated:
Free the memory occupied by a string created by the plugin API.

ptr is the source string to be freed.

Parameters
char8freeThis function.

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