engine_client_cpp.hpp File Reference

This is the header file for the Apama C++ EngineManagement API. More...

#include <AP_Types.h>
#include <AP_Platform.h>
#include <iostream>
#include <sstream>
#include <exception>
#include <iterator>
#include <algorithm>
#include <utility>
#include <string>
#include <assert.h>
#include <sag_internal/engine_client_c.h>
#include <iomanip>
#include <vector>

Go to the source code of this file.

Classes
class	com::apama::EngineException
	An EngineException is thrown by methods in this library if any problems are encountered. More...
class	com::apama::event::Event
	An Event object represents an event instance. More...
class	com::apama::event::EventSupplier
	An EventSupplier represents the resources created by the Engine to service a connection to an external sink of events. More...
class	com::apama::event::EventConsumer
	An EventConsumer can connect to the Engine through an EventSupplier and register to receive events. More...
class	com::apama::event::DisconnectableEventConsumer
	Derived class from EventConsumer which implements the disconnect API. More...
class	com::apama::engine::MonitorScript
	A MonitorScript object encapsulates an EPL code fragment, containing package, event and monitor definitions to be injected into an Engine. More...
class	com::apama::engine::EngineStatus
	EngineStatus represents the operational status of the Engine. More...
class	com::apama::engine::EngineStatus::StatusIterator
	A class used for the iterating through all status items. More...
class	com::apama::engine::NameInfo
	Base class for a named object (i.e. More...
class	com::apama::engine::NamedMonitorInfo
	Information about a monitor returned by an engine inspection. More...
class	com::apama::engine::NamedJavaApplicationInfo
	Information about a java application returned by an engine inspection. More...
class	com::apama::engine::NamedContextInfo
	Information about a context returned by an engine inspection. More...
class	com::apama::engine::NamedReceiverInfo
	Information about a receiver returned by an engine inspection. More...
class	com::apama::engine::NamedPluginReceiverInfo
	Information about a receiver returned by an engine inspection. More...
class	com::apama::engine::NamedEventTypeInfo
	Information about a event type returned by an engine inspection. More...
class	com::apama::engine::NamedTimerInfo
	Information about a timer type returned by an engine inspection. More...
class	com::apama::engine::NamedAggregateInfo
	Information about an aggregate function returned by an engine inspection. More...
class	com::apama::engine::EngineInfo
	Information about the monitors and types currently in an engine. More...
class	com::apama::engine::EngineManagement
	The Engine Management class acts as the interface to the Engine, and allows operations to be carried out on it. More...
class	com::apama::engine::EngineConnection
	EngineConnection encapsulates the information related to a connection between two Apama messaging components. More...

Namespaces
	com::apama
	Contains classes for writing client applications for Apama components.
	com::apama::event
	Contains classes for handling events passed over the client API.
	com::apama::engine
	Contains classes for interacting with the correlator component.

Enumerations
enum	com::apama::LogLevel {   com::apama::OFF_LEVEL, com::apama::FORCE_LEVEL, com::apama::CRIT_LEVEL, com::apama::FATAL_LEVEL,   com::apama::ERROR_LEVEL, com::apama::WARN_LEVEL, com::apama::INFO_LEVEL, com::apama::DEBUG_LEVEL,   com::apama::TRACE_LEVEL }
	Available logging levels. More...

Functions
AP_ENGINE_CLIENT_API void	com::apama::setLogLevel (LogLevel level)
	Sets the level at which the client library will log information. More...
AP_ENGINE_CLIENT_API void	com::apama::setLogFile (const AP_char8 *filename, bool truncate, bool utf8=false)
	Sets the file to which the client library should log information. More...
AP_ENGINE_CLIENT_API void	com::apama::setLogFD (int fd)
	Sets the file descriptor to which the client library should log information. More...
AP_ENGINE_CLIENT_API void	com::apama::reOpenLog ()
	Re-opens the log file. More...
AP_ENGINE_CLIENT_API AP_char8 *	com::apama::convertToUTF8 (const AP_char8 *s)
	Convert a string in local encoding to UTF-8, as required by most of the Apama API. More...
AP_ENGINE_CLIENT_API AP_char8 *	com::apama::convertFromUTF8 (const AP_char8 *s)
	Convert a string in UTF-8 to the local encoding, since most of the Apama API returns UTF-8. More...
AP_ENGINE_CLIENT_API void	com::apama::char8free (char *string)
	Free any char* string returned from the client API. More...
AP_ENGINE_CLIENT_API Event *	com::apama::event::createEvent (const char *eventString, const char *channelString)
	This function allows creation of an Event object. More...
AP_ENGINE_CLIENT_API void	com::apama::event::deleteEvent (Event *ev)
	This function allows deletion of an Event object. More...
AP_ENGINE_CLIENT_API void	com::apama::event::deleteEventSupplier (EventSupplier *evsup)
	This function disconnects and deletes an EventSupplier object. More...
std::ostream &	com::apama::engine::operator<< (std::ostream &stream, const EngineStatus &obj)
	Stream output operator for a reference. More...
std::ostream &	com::apama::engine::operator<< (std::ostream &stream, const EngineStatus *obj)
	Stream output operator for a pointer. More...
AP_ENGINE_CLIENT_API void	com::apama::engine::engineInit (const char *processName="C++ Client")
	This function must be called once per process first before any other Engine operations are carried out. More...
AP_ENGINE_CLIENT_API void	com::apama::engine::engineInitMessaging (const char *processName, bool initMessaging=true)
	This function (or engineInit) must be called once per process first before any other Engine operations are carried out. More...
AP_ENGINE_CLIENT_API void	com::apama::engine::engineShutdown ()
	This function must be called once per process before the application closes down. More...
AP_ENGINE_CLIENT_API EngineManagement *	com::apama::engine::connectToEngine (const char *host, unsigned short port, bool disconnectSlowReceiver=false, const char *processName=nullptr)
	This function attempts to establish a connection to an Engine. More...
AP_ENGINE_CLIENT_API EngineManagement *	com::apama::engine::connectToEngineReceiveOnly (const char *host, unsigned short port, const char *processName=nullptr)
	Attempt to establish a receive-only connection to an Engine listening on the named host and port. More...
AP_ENGINE_CLIENT_API EngineManagement *	com::apama::engine::connectToEngineMonitorOnly (const char *host, unsigned short port, const char *processName=nullptr)
	Attempt to establish a monitor-only connection to an Engine listening on the named host and port. More...
AP_ENGINE_CLIENT_API void	com::apama::engine::disconnectFromEngine (EngineManagement *corr)
	This function allows disconnection from an Engine. More...
AP_ENGINE_CLIENT_API MonitorScript *	com::apama::engine::createMonitorScript (const char *monitorString)
	This function allows creation of MonitorScript objects. More...
AP_ENGINE_CLIENT_API void	com::apama::engine::deleteMonitorScript (MonitorScript *mon)
	This function allows deletion of MonitorScript objects. More...
AP_ENGINE_CLIENT_API void	com::apama::engine::deleteInfo (EngineInfo *info)
	This function allows deletion of an EngineInfo object. More...
AP_ENGINE_CLIENT_API void	com::apama::engine::deleteWarnings (const char *const *warnings)
	This function allows deletion of the lists of warnings returned by injectMonitorScriptWithWarnings(), injectCDPWithWarnings() and injectJavaWithWarnings() More...
AP_ENGINE_CLIENT_API void	com::apama::engine::setEngineParams (const char *params)
	Set custom parameters for this instance of the client library. More...

Detailed Description

This is the header file for the Apama C++ EngineManagement API.