Apama  9.12.0.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AP_PluginCommon.h File Reference

Shared definitions for the C and C++ plugin APIs. More...

Go to the source code of this file.

Macros

#define AP_INIT_FUNCTION_NAME   InitLibrary
 The name of the initialization function which must be exported from a plugin library. More...
 
#define AP_SHUTDOWN_FUNCTION_NAME   ShutdownLibrary
 The name of the shutdown function which must be exported from a plugin library. More...
 
#define AP_LIBRARY_VERSION_FUNCTION_NAME   LibraryVersion
 The name of the version function which must be exported from a plugin library in C++ plugins. More...
 
#define AP_PLUGIN_VERSION_FUNCTION_NAME   PluginVersion
 The name of the version function which must be exported from a plugin library in C plugins. More...
 

Enumerations

enum  AP_TypeDiscriminator {
  AP_NULL_TYPE, AP_CHUNK_TYPE, AP_INTEGER_TYPE, AP_FLOAT_TYPE,
  AP_BOOLEAN_TYPE, AP_STRING_TYPE, AP_SEQUENCE_TYPE, AP_DECIMAL_TYPE
}
 A typed discriminator for the contents of an AP_Type object. More...
 
enum  AP_ErrorCode { AP_NO_ERROR, AP_UNKNOWN_ERROR, AP_VERSION_MISMATCH_ERROR }
 A typed error code discriminator. More...
 
enum  AP_Capabilities { AP_CAPABILITIES_NONE = 0, AP_CAPABILITIES_NON_BLOCKING = 4 }
 Plugin capabilities. More...
 

Detailed Description

Shared definitions for the C and C++ plugin APIs.

Macro Definition Documentation

#define AP_INIT_FUNCTION_NAME   InitLibrary

The name of the initialization function which must be exported from a plugin library.

#define AP_LIBRARY_VERSION_FUNCTION_NAME   LibraryVersion

The name of the version function which must be exported from a plugin library in C++ plugins.

Existence of this function name determines that this is a C++ plugin not a C plugin. For a C plugin use AP_PLUGIN_VERSION_FUNCTION_NAME

#define AP_PLUGIN_VERSION_FUNCTION_NAME   PluginVersion

The name of the version function which must be exported from a plugin library in C plugins.

Existence of this function name determines that this is a C plugin not a C++ plugin. For a C++ plugin use AP_LIBRARY_VERSION_FUNCTION_NAME

#define AP_SHUTDOWN_FUNCTION_NAME   ShutdownLibrary

The name of the shutdown function which must be exported from a plugin library.

Enumeration Type Documentation

Plugin capabilities.

these are returned OR'd together from AP_PLUGIN_GET_CAPABILITIES_FUNCTION_NAME

Enumerator
AP_CAPABILITIES_NONE 

none of the below capabilities

AP_CAPABILITIES_NON_BLOCKING 

plugin functions will not block (blocking includes calling sendEventTo)

A typed error code discriminator.

Enumerator
AP_NO_ERROR 

Success.

AP_UNKNOWN_ERROR 

Any other problem.

AP_VERSION_MISMATCH_ERROR 

Plugin and API versions are incompatible.

A typed discriminator for the contents of an AP_Type object.

Enumerator
AP_NULL_TYPE 

No type yet (e.g.

uninitialised return value)

AP_CHUNK_TYPE 

Plugin private data, opaque to MonitorScript.

AP_INTEGER_TYPE 

MonitorScript integer.

AP_FLOAT_TYPE 

MonitorScript float.

AP_BOOLEAN_TYPE 

MonitorScript boolean.

AP_STRING_TYPE 

MonitorScript string.

AP_SEQUENCE_TYPE 

MonitorScript sequence (of any supported type)

AP_DECIMAL_TYPE 

MonitorScript decimal.