Apama  10.15.3.4
com::apama Namespace Reference

Contains classes for writing client applications for Apama components. More...

Namespaces

 client_status
 Contains the key names for all standard status values within the correlator.
 
 engine
 Contains classes for interacting with the correlator component.
 
 epl
 Contains classes needed for implementing EPL plug-ins in C++.
 
 event
 Contains classes for handling events passed over the client API.
 

Classes

class  EngineException
 An EngineException (or instance of a derived class) is thrown by methods in this library if any problems are encountered. More...
 

Enumerations

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

Functions

AP_ENGINE_CLIENT_API void setLogLevel (LogLevel level)
 Sets the level at which the client library will log information. More...
 
AP_ENGINE_CLIENT_API void 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 int getLogFD ()
 Get the file descriptor of this logger. More...
 
AP_ENGINE_CLIENT_API void reOpenLog ()
 Re-opens the log file. More...
 
AP_ENGINE_CLIENT_API AP_char8 * 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 * 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 char8free (char *string)
 Free any char* string returned from the client API. More...
 

Detailed Description

Contains classes for writing client applications for Apama components.

Enumeration Type Documentation

◆ LogLevel

Available logging levels.

Enumerator
OFF_LEVEL 

Nothing logged.

FORCE_LEVEL 

Startup and other important messages.

CRIT_LEVEL 

Critical messages.

FATAL_LEVEL 

Fatal messages.

ERROR_LEVEL 

Error messages.

WARN_LEVEL 

Warning messages.

INFO_LEVEL 

Information messages (default)

DEBUG_LEVEL 

Debugging messages.

TRACE_LEVEL 

More-verbose debug messages.

Function Documentation

◆ char8free()

AP_ENGINE_CLIENT_API void com::apama::char8free ( char *  string)

Free any char* string returned from the client API.

◆ convertFromUTF8()

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.

◆ convertToUTF8()

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.

◆ getLogFD()

AP_ENGINE_CLIENT_API int com::apama::getLogFD ( )

Get the file descriptor of this logger.

◆ reOpenLog()

AP_ENGINE_CLIENT_API void com::apama::reOpenLog ( )

Re-opens the log file.

Also called if SIGHUP is received.

◆ setLogFile()

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.

Parameters
filenameThe filename to which the library should log. Will log to stderr if the filename cannot be opened.
truncateIf non-zero the log file will be truncated when it is opened. If zero then it will simply be appended to.
utf8Interpret filename as UTF-8, rather than the local character set.

◆ setLogLevel()

AP_ENGINE_CLIENT_API void com::apama::setLogLevel ( LogLevel  level)

Sets the level at which the client library will log information.

Parameters
levelThe level to log at