libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Logging functionality

RoadRunner logging routines. More...

Functions

bool enableLoggingToConsole (void)
 Enable logging to console. More...
 
bool disableLoggingToConsole (void)
 Disable logging to console. More...
 
bool enableLoggingToFile ()
 Enable logging to logFile. More...
 
bool enableLoggingToFileWithPath (const char *path)
 Enable logging to a log file with the specified path. More...
 
bool disableLoggingToFile ()
 Disable logging to logFile. More...
 
bool setLogLevel (const char *lvl)
 Set the logging status level The logging level is determined by the following strings. More...
 
char * getLogLevel (void)
 Get the logging status level as a pointer to a string. More...
 
char * getLogFileName (void)
 Get a pointer to the string that holds the logging file name path. More...
 
void logMsg (enum CLogLevel lvl, const char *msg)
 Create a log message. More...
 

Detailed Description

RoadRunner logging routines.

Function Documentation

bool disableLoggingToConsole ( void  )

Disable logging to console.

Returns
Returns true if successful, false otherwise
bool disableLoggingToFile ( )

Disable logging to logFile.

Returns
Returns true if successful, false otherwise
bool enableLoggingToConsole ( void  )

Enable logging to console.

Returns
Returns true if successful, false otherwise
bool enableLoggingToFile ( )

Enable logging to logFile.

Returns
Returns true if successful, false otherwise
bool enableLoggingToFileWithPath ( const char *  path)

Enable logging to a log file with the specified path.

Returns
Returns true if successful, false otherwise
char* getLogFileName ( void  )

Get a pointer to the string that holds the logging file name path.

Example: str = getLogFileName (void)

Returns
Returns null if it fails otherwise returns the full path to the logging file name
char* getLogLevel ( void  )

Get the logging status level as a pointer to a string.

The logging level can be one of the following strings

"ANY", "DEBUG5", "DEBUG4", "DEBUG3", "DEBUG2", "DEBUG1", "DEBUG", "INFO", "WARNING", "ERROR"

Example:

1 str = getLogLevel (void)
Returns
Returns null if it fails else returns a pointer to the logging string
void logMsg ( enum CLogLevel  lvl,
const char *  msg 
)

Create a log message.

Parameters
lvlLoglevel for message
msgLog message
bool setLogLevel ( const char *  lvl)

Set the logging status level The logging level is determined by the following strings.

"ANY", "DEBUG5", "DEBUG4", "DEBUG3", "DEBUG2", "DEBUG1", "DEBUG", "INFO", "WARNING", "ERROR"

Example:

1 setLogLevel ("DEBUG4")

Will show log messages with levels DEBUG4, DEBUG3 -> Error

Parameters
lvlPointer to the logging level string.
Returns
Returns true if successful