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

Go to the source code of this file.

Macros

#define AP_INIT_FUNCTION_NAME   InitLibrary
 
#define AP_SHUTDOWN_FUNCTION_NAME   ShutdownLibrary
 
#define AP_LIBRARY_VERSION_FUNCTION_NAME   LibraryVersion
 
#define AP_PLUGIN_VERSION_FUNCTION_NAME   PluginVersion
 

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
}
 
enum  AP_ErrorCode { AP_NO_ERROR, AP_UNKNOWN_ERROR, AP_VERSION_MISMATCH_ERROR }
 
enum  AP_Capabilities { AP_CAPABILITIES_NONE = 0, AP_CAPABILITIES_NON_BLOCKING = 4 }
 

Detailed Description

Deprecated:
This API is deprecated in favour of the C++ API defined in epl_plugin.hpp

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

Macro Definition Documentation

#define AP_INIT_FUNCTION_NAME   InitLibrary
Deprecated:
The name of the initialization function which must be exported from a plugin library
#define AP_LIBRARY_VERSION_FUNCTION_NAME   LibraryVersion
Deprecated:
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
Deprecated:
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
Deprecated:
The name of the shutdown function which must be exported from a plugin library

Enumeration Type Documentation

Deprecated:

Plugin capabilities. these are returned OR'd together from AP_PLUGIN_GET_CAPABILITIES_FUNCTION_NAME

Enumerator
AP_CAPABILITIES_NONE 
Deprecated:
none of the below capabilities
AP_CAPABILITIES_NON_BLOCKING 
Deprecated:
plugin functions will not block (blocking includes calling sendEventTo)
Deprecated:

A typed error code discriminator

Enumerator
AP_NO_ERROR 
Deprecated:
Success
AP_UNKNOWN_ERROR 
Deprecated:
Any other problem
AP_VERSION_MISMATCH_ERROR 
Deprecated:
Plugin and API versions are incompatible
Deprecated:

A typed discriminator for the contents of an AP_Type object

Enumerator
AP_NULL_TYPE 
Deprecated:
No type yet (e.g.

uninitialised return value)

AP_CHUNK_TYPE 
Deprecated:
Plugin private data, opaque to EPL
AP_INTEGER_TYPE 
Deprecated:
EPL integer
AP_FLOAT_TYPE 
Deprecated:
EPL float
AP_BOOLEAN_TYPE 
Deprecated:
EPL boolean
AP_STRING_TYPE 
Deprecated:
EPL string
AP_SEQUENCE_TYPE 
Deprecated:
EPL sequence (of any supported type)
AP_DECIMAL_TYPE 
Deprecated:
EPL decimal