RoadRunner logging routines. More...

Functions
C_DECL_SPEC bool rrcCallConv	enableLoggingToConsole (void)
	Enable logging to console. More...

C_DECL_SPEC bool rrcCallConv	disableLoggingToConsole (void)
	Disable logging to console. More...

C_DECL_SPEC bool rrcCallConv	enableLoggingToFile ()
	Enable logging to logFile. More...

C_DECL_SPEC bool rrcCallConv	enableLoggingToFileWithPath (const char *path)
	Enable logging to a log file with the specified path. More...

C_DECL_SPEC bool rrcCallConv	disableLoggingToFile ()
	Disable logging to logFile. More...

C_DECL_SPEC bool rrcCallConv	setLogLevel (const char *lvl)
	Set the logging status level The logging level is determined by the following strings. More...

C_DECL_SPEC char *rrcCallConv	getLogLevel (void)
	Get the logging status level as a pointer to a string. More...

C_DECL_SPEC char *rrcCallConv	getLogFileName (void)
	Get a pointer to the string that holds the logging file name path. More...

C_DECL_SPEC void rrcCallConv	logMsg (enum CLogLevel lvl, const char *msg)
	Create a log message. More...

Detailed Description

RoadRunner logging routines.

Function Documentation

◆ disableLoggingToConsole()

C_DECL_SPEC bool rrcCallConv disableLoggingToConsole ( void )

Disable logging to console.

Returns: Returns true if successful, false otherwise

◆ disableLoggingToFile()

C_DECL_SPEC bool rrcCallConv disableLoggingToFile ( )

Disable logging to logFile.

Returns: Returns true if successful, false otherwise

◆ enableLoggingToConsole()

C_DECL_SPEC bool rrcCallConv enableLoggingToConsole ( void )

Enable logging to console.

Returns: Returns true if successful, false otherwise

◆ enableLoggingToFile()

C_DECL_SPEC bool rrcCallConv enableLoggingToFile ( )

Enable logging to logFile.

Returns: Returns true if successful, false otherwise

◆ enableLoggingToFileWithPath()

C_DECL_SPEC bool rrcCallConv enableLoggingToFileWithPath ( const char * path )

Enable logging to a log file with the specified path.

Returns: Returns true if successful, false otherwise

◆ getLogFileName()

C_DECL_SPEC char* rrcCallConv 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

◆ getLogLevel()

C_DECL_SPEC char* rrcCallConv 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:

str = getLogLevel (void)

getLogLevel

C_DECL_SPEC char *rrcCallConv getLogLevel(void)

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

Returns: Returns null if it fails else returns a pointer to the logging string

◆ logMsg()

C_DECL_SPEC void rrcCallConv logMsg	(	enum CLogLevel	lvl,
		const char *	msg
	)

Create a log message.

Parameters

lvl	Loglevel for message
msg	Log message

◆ setLogLevel()

C_DECL_SPEC bool rrcCallConv setLogLevel ( const char * lvl )

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