Apama  10.15.3.4
com::apama::engine Namespace Reference

Contains classes for interacting with the correlator component. More...

Classes

class  EngineConnection
 EngineConnection encapsulates the information related to a connection between two Apama messaging components. More...
 
class  EngineInfo
 Information about the monitors and types currently in an engine. More...
 
class  EngineManagement
 The Engine Management class acts as the interface to the Engine, and allows operations to be carried out on it. More...
 
class  EngineStatus
 EngineStatus represents the operational status of the Engine. More...
 
class  MonitorScript
 A MonitorScript object encapsulates an EPL code fragment, containing package, event and monitor definitions to be injected into an Engine. More...
 
class  NamedAggregateInfo
 Information about an aggregate function returned by an engine inspection. More...
 
class  NamedContextInfo
 Information about a context returned by an engine inspection. More...
 
class  NamedEventTypeInfo
 Information about a event type returned by an engine inspection. More...
 
class  NamedJavaApplicationInfo
 Information about a java application returned by an engine inspection. More...
 
class  NamedMonitorInfo
 Information about a monitor returned by an engine inspection. More...
 
class  NamedPluginReceiverInfo
 Information about a receiver returned by an engine inspection. More...
 
class  NamedReceiverInfo
 Information about a receiver returned by an engine inspection. More...
 
class  NamedTimerInfo
 Information about a timer type returned by an engine inspection. More...
 
class  NameInfo
 Base class for a named object (i.e. More...
 

Functions

std::ostream & operator<< (std::ostream &stream, const EngineStatus &obj)
 Stream output operator for a reference. More...
 
std::ostream & operator<< (std::ostream &stream, const EngineStatus *obj)
 Stream output operator for a pointer. More...
 
AP_ENGINE_CLIENT_API void 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 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 engineShutdown ()
 This function must be called once per process before the application closes down. More...
 
AP_ENGINE_CLIENT_API EngineManagementconnectToEngine (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 EngineManagementconnectToEngineReceiveOnly (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 EngineManagementconnectToEngineMonitorOnly (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 disconnectFromEngine (EngineManagement *corr)
 This function allows disconnection from an Engine. More...
 
AP_ENGINE_CLIENT_API MonitorScriptcreateMonitorScript (const char *monitorString)
 This function allows creation of MonitorScript objects. More...
 
AP_ENGINE_CLIENT_API void deleteMonitorScript (MonitorScript *mon)
 This function allows deletion of MonitorScript objects. More...
 
AP_ENGINE_CLIENT_API void deleteInfo (EngineInfo *info)
 This function allows deletion of an EngineInfo object. More...
 
AP_ENGINE_CLIENT_API void 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 setEngineParams (const char *params)
 Set custom parameters for this instance of the client library. More...
 

Detailed Description

Contains classes for interacting with the correlator component.

Function Documentation

◆ connectToEngine()

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.

It returns an EngineManagement object that can be used to access the Engine.

Parameters
hostThe machine name where an Engine can be located.
portThe port that the Engine is listening on for transport negotiations with the client.
disconnectSlowReceiverDisconnect any receiver if it is slow, defaults to false
processNameif not null, the name of this component.
Returns
An EngineManagement object if an Engine is located and a connection established.
Exceptions
EngineException

◆ connectToEngineMonitorOnly()

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.

If successful, the returned EngineManagement can be used for the getStatus(), inspectEngine() and ping() operations. All other operations will fail.

Parameters
hostThe hostname of the machine the Engine is running on.
portThe port that the Engine is listening on.
processNameif not null, the name of this component.
Returns
An EngineManagement object operating in monitor-only mode.
Exceptions
EngineExceptionIf the connection cannot be established.

◆ connectToEngineReceiveOnly()

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.

If successful, the returned EngineManagement can be used for the connectEventConsumer(), getStatus(), inspectEngine() and ping() operations. All other operations will fail.

Parameters
hostThe hostname of the machine the Engine is running on.
portThe port that the Engine is listening on.
processNameif not null, the name of this component.
Returns
An EngineManagement object operating in receive-only mode.
Exceptions
EngineExceptionIf the connection cannot be established.

◆ createMonitorScript()

AP_ENGINE_CLIENT_API MonitorScript* com::apama::engine::createMonitorScript ( const char *  monitorString)

This function allows creation of MonitorScript objects.

Parameters
monitorStringEPL monitors or event definitions
Returns
A MonitorScript object.

◆ deleteInfo()

AP_ENGINE_CLIENT_API void com::apama::engine::deleteInfo ( EngineInfo info)

This function allows deletion of an EngineInfo object.

All objects returned by any calls to the methods of the EngineInfo object are also deleted, so after calling inspectEngine, deleteInfo is the only method which needs to be called to clean up.

Parameters
infoThe EngineInfo object to delete.

◆ deleteMonitorScript()

AP_ENGINE_CLIENT_API void com::apama::engine::deleteMonitorScript ( MonitorScript mon)

This function allows deletion of MonitorScript objects.

Parameters
monThe MonitorScript object to delete.

◆ deleteWarnings()

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()

Parameters
warningsA list of warnings to be deleted

◆ disconnectFromEngine()

AP_ENGINE_CLIENT_API void com::apama::engine::disconnectFromEngine ( EngineManagement corr)

This function allows disconnection from an Engine.

Any EventSuppliers created from the EngineManagement must be deleted explicitly using deleteEventSupplier in addition to disconnecting the EngineManagement object.

Parameters
corrThe Engine to disconnect from.

◆ engineInit()

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.

Exceptions
EngineException

◆ engineInitMessaging()

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.

Exceptions
EngineException

◆ engineShutdown()

AP_ENGINE_CLIENT_API void com::apama::engine::engineShutdown ( )

This function must be called once per process before the application closes down.

It ensures that communications are shutdown properly and state cleaned up.

◆ operator<<() [1/2]

std::ostream & com::apama::engine::operator<< ( std::ostream &  stream,
const EngineStatus obj 
)
inline

Stream output operator for a reference.

◆ operator<<() [2/2]

std::ostream & com::apama::engine::operator<< ( std::ostream &  stream,
const EngineStatus obj 
)
inline

Stream output operator for a pointer.

◆ setEngineParams()

AP_ENGINE_CLIENT_API void com::apama::engine::setEngineParams ( const char *  params)

Set custom parameters for this instance of the client library.

Must be called before engineInit. The parameters are passed as a set of name, value pairs formatted as

<name1>=<value1>;<name2=value2>;

(i.e. equals sign between name and value, and semicolon separating the name value pairs).

The following parameters are defined so far.

ConfigFile - A filename from which to read a configuration file