Apama public C++ API documentation.

Introduction

This documentation covers the following APIs provided with Apama:

Connectivity Plug-ins

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

• sag_connectivity_plugins.hpp - Classes and free functions for building connectivity plug-ins
• sag_connectivity_chain_managers.hpp - Support for transports that dynamically create and manage their own chain instances
• sag_plugin_logging.hpp - Support for logging from customer plugins
• 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++ plug-ins for EPL. Documentation can be found in the following files, in addition to those used in the connectivity layer for the type system used for passing data to and from plugins. This API was introduced in 10.0 replacing and deprecating the previous EPL plugin API in C and C++.

• com::apama::epl - All EPL plugin-related classes and free functions
• epl_plugin.hpp - API for writing EPL plugins

Client API

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

• 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 EngineManagement clients

IAF API

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

• EventTransport.h - Transport API classes and functions.
• EventCodec.h - Event codec information.
• SemanticMapper.h - Mapping message contents to EPL Event fields
• NormalisedEvent.h - Event container for IAF applications.
• AP_Logger.h - Logging Support
• AP_TimestampSet.h - Hires timestamp functions
• IAF_TimestampConfig.h - Hires timestamp configuration