Apama 10.15.0 | Connecting Apama Applications to External Components | Working with IAF Plug-ins | C/C++ Codec Plug-in Development | The C/C++ codec plug-in development specification
 
The C/C++ codec plug-in development specification
 
Codec functions to implement
Defining the codec function tables
The codec constructor, destructor and info functions
Other codec definitions
Codec utilities
Communication with other layers
Working with normalized events
A codec plug-in needs to be structured as a dynamic shared library. In order for the IAF to be able to load and use it, it must comply with Apama's codec plug-in development specification. This describes the overall format of a codec plug-in and the C/C++ functions it needs to implement so that its functionality is accessible by the IAF. The specification also provides a mechanism for startup and configuration parameters to be passed to the plug-in from the IAF's configuration file.
Property names and values used by codec plug-ins must be in UTF-8 format.
A codec plug-in implementation must include the C header file EventCodec.h. As a codec also needs to communicate both with a transport layer plug-in (or event transport) and with the Semantic Mapper, EventTransport.h and SemanticMapper.h also need to be included. You can find these files in the include directory of your Apama installation.