The client software development kits

Apama provides Client Software Development Kits (SDKs) for C, C++, .NET, and Java. These allow software written either in C, C++ or Java to interface with the event correlator. Apama also provides engine client libraries for .NET applications. The .NET client library documentation is located here:

.NET documentation in HTML format.

The SDKs for C, C++ and Java are located in the lib folder of the Apama installation. For C and C++ this consists of the libraries libengine_client.so.5.3 (on Solaris or Linux), or engine_client5.3.lib (on Windows). The equivalent Java classes are provided within engine_client5.3.jar and are documented in doc\javadoc. The .NET engine client libraries, engine_client5.3.dll and engine_client_dotnet5.3.dll libraries are located in the Apama installation’s bin directory.

In order to program against the C/C++ SDKs a developer must use the definitions from the engine_client_c.h header file for C or engine_client_cpp.hpp header file for C++ located in the include folder of the Apama installation.

C++ compilers vary extensively in their support for the ISO C++ standard and in how they support linking. For this reason Apama supports only specific C/C++ compilers and development environments. For a list of the supported C++ compilers, see Software AG's Knowledge Center in Empower at https://empower.softwareag.com.

On the other hand, C has been standardized for several years, and for this reason the C development kit should work with the majority of modern C/C++ compilers on all platforms. However, note that when using a C compiler and linker you still need to link against the standard C++ library since Apama’s underlying libraries contain C++ code.

To configure the build for an Apama client:

On Linux, copying and customizing an Apama makefile from a sample application is the easiest method.

On Windows, you might find it easiest to copy an Apama sample project. If you prefer to use a project you already have, be sure to add $(APAMA_HOME)\include as an include directory. To do this in Visual Studio, select your project and then select Project Properties > C/C++ > General > Additional Include Directories.

Also, link against engine_client$(APAMA_LIBRARY_VERSION).lib. To do this in Visual Studio, select your project and then select Project Properties > Linker > Input > Additional Dependencies and add:

Finally, select Project Properties > Linker > General > Additional Library Directories, and add $(APAMA_HOME)\lib.

To develop, build, and test an Apama application, the recommendation is that you use Oracle JDK 8. The minimum you can use is JDK 7.

To deploy an Apama application, the recommendation is that you use Oracle JRE 8, which is the version that Apama provides. Use of any JRE other than the one that Apama ships with is discouraged.