The EPL Plug-in APIs for C and C++
For reference, this topic provides correlator_plugin.hpp, the header file that provides the functionality of the EPL Plug-in C++ API. The file is located in the include folder of the Apama installation.
The equivalent header file for the EPL Plug-in C API is correlator_plugin.h. This will not explicitly be covered here, as it is broadly identical in functionality to the C++ header file. The only difference is that the functionality presented as class methods in the C++ API is presented as C functions in the C API. This can also be located in the include folder.
The C++ header defines several types. First it defines two enumerations:
AP_TypeDiscriminator - Identifies the type of the data item encapsulated by an
AP_Type “smart union” object. Its values map to EPL types.
AP_ErrorCode – Specifies the error codes that can be returned by plug-in functions that do not throw exceptions. In this release of the API these are just the C-linkage initialization and destructor functions.
Then it defines a number of exceptions. All exception classes inherit from AP_PluginException, and they are AP_TypeException, AP_UnimplementedException, AP_BoundsException and AP_SerialisationException.
Copyright © 2013
Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors.