Apama public C++ API documentation.

Introduction

This documentation covers the following APIs provided with Apama:

Connectivity Plug-ins

API for writing C++ plug-ins for the connectivity layer. Documentation can be found in the following files:

• com::softwareag::connectivity - All connectivity-related classes and free functions
• sag_connectivity_plugins.hpp - Implementing plug-ins
• sag_connectivity_cpp.hpp - Support for the connectivity data model
• sag_connectivity_threading.h - cross-platform threading primitives. NOTE: if your compiler supports C++11 std::thread et al then you should use those. This is only provided for older compilers which don't have complete C++11 support.

EPL Plug-ins

API for writing C/C++ plug-ins for EPL. Documentation can be found in the following files:

• correlator_plugin.hpp - C++ API for EPL plugins
• correlator_plugin.h - C API for EPL plugins. NOTE: This is based on the C++ API which should be used in preference if possible
• AP_PluginCommon.h - Common types between the C and C++ APIs

Client API

API for writing applications in C/C++ which connect to Apama components. Documentation can be found in the following filse:

• com::apama - All client-related classes and free functions
• com::apama::event - Classes for handling events passed over the client API
• com::apama::engine - Classes for interacting with the correlator component
• engine_client_cpp.hpp - C++ API for Apama clients
• engine_client_c.h - C API for Apama clients. NOTE: This is DEPRECATED. The C++ API should be used in preference