libroadrunner C API
rrc_logging_api.h
Go to the documentation of this file.
1 
42 #ifndef rrc_logging_apiH
43 #define rrc_logging_apiH
44 #include "rrc_exporter.h"
45 #include "rrc_types.h"
46 //---------------------------------------------------------------------------
47 
48 #if defined(__cplusplus)
49 namespace rrc
50 {
51 extern "C"
52 {
53 #endif
54 
59  {
60  CL_PRIO_CURRENT = 0,
69  };
70 
71 enum
72 {
73  clError = CL_PRIO_ERROR,
74  clInfo = CL_PRIO_INFORMATION,
75  clDebug = CL_PRIO_DEBUG,
76  clWarning = CL_PRIO_WARNING
77 };
83 C_DECL_SPEC bool rrcCallConv enableLoggingToConsole(void);
84 
90 C_DECL_SPEC bool rrcCallConv disableLoggingToConsole(void);
91 
97 C_DECL_SPEC bool rrcCallConv enableLoggingToFile();
98 
104 C_DECL_SPEC bool rrcCallConv enableLoggingToFileWithPath(const char* path);
105 
111 C_DECL_SPEC bool rrcCallConv disableLoggingToFile();
112 
128 C_DECL_SPEC bool rrcCallConv setLogLevel(const char* lvl);
129 
143 C_DECL_SPEC char* rrcCallConv getLogLevel(void);
144 
153 C_DECL_SPEC char* rrcCallConv getLogFileName(void);
154 
155 C_DECL_SPEC void rrcCallConv logMsg(enum CLogLevel lvl, const char* msg);
162 
163 
164 #if defined(__cplusplus)
165 } //Extern "C"
166 
167 } //rrc namespace
168 #endif
169 
170 #endif
171 
C_DECL_SPEC char *rrcCallConv getLogFileName(void)
Get a pointer to the string that holds the logging file name path.
C_DECL_SPEC char *rrcCallConv getLogLevel(void)
Get the logging status level as a pointer to a string.
C_DECL_SPEC bool rrcCallConv enableLoggingToConsole(void)
Enable logging to console.
C_DECL_SPEC bool rrcCallConv setLogLevel(const char *lvl)
Set the logging status level The logging level is determined by the following strings.
C_DECL_SPEC bool rrcCallConv enableLoggingToFile()
Enable logging to logFile.
C_DECL_SPEC bool rrcCallConv enableLoggingToFileWithPath(const char *path)
Enable logging to a log file with the specified path.
C_DECL_SPEC bool rrcCallConv disableLoggingToConsole(void)
Disable logging to console.
C_DECL_SPEC void rrcCallConv logMsg(enum CLogLevel lvl, const char *msg)
Create a log message.
C_DECL_SPEC bool rrcCallConv disableLoggingToFile()
Disable logging to logFile.
roadRunner C wrappers 2012
CLogLevel
Log level enum.
Definition: rrc_logging_api.h:59
@ CL_PRIO_CRITICAL
A fatal error. The application will most likely terminate. This is the highest priority.
Definition: rrc_logging_api.h:62
@ CL_PRIO_NOTICE
A warning. An operation completed with an unexpected result.
Definition: rrc_logging_api.h:65
@ CL_PRIO_FATAL
Use the current level – don't change the level from what it is.
Definition: rrc_logging_api.h:61
@ CL_PRIO_WARNING
An error. An operation did not complete successfully, but the application as a whole is not affected.
Definition: rrc_logging_api.h:64
@ CL_PRIO_TRACE
A debugging message.
Definition: rrc_logging_api.h:68
@ CL_PRIO_DEBUG
An informational message, usually denoting the successful completion of an operation.
Definition: rrc_logging_api.h:67
@ CL_PRIO_INFORMATION
A notice, which is an information with just a higher priority.
Definition: rrc_logging_api.h:66
@ CL_PRIO_ERROR
A critical error. The application might not be able to continue running successfully.
Definition: rrc_logging_api.h:63
roadRunner C wrappers 2012