libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Enumerations | Functions
rrc_logging_api.h File Reference

roadRunner C API 2012 More...

#include "rrc_exporter.h"
#include "rrc_types.h"

Go to the source code of this file.

Enumerations

enum  CLogLevel {
  CL_PRIO_CURRENT = 0, CL_PRIO_FATAL = 1, CL_PRIO_CRITICAL, CL_PRIO_ERROR,
  CL_PRIO_WARNING, CL_PRIO_NOTICE, CL_PRIO_INFORMATION, CL_PRIO_DEBUG,
  CL_PRIO_TRACE
}
 Log level enum. More...
 
enum  { clError = CL_PRIO_ERROR, clInfo = CL_PRIO_INFORMATION, clDebug = CL_PRIO_DEBUG, clWarning = CL_PRIO_WARNING }
 

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 C API 2012

Author
Totte Karlsson & Herbert M Sauro

<-----------------------------------------------------------— This file is part of cRoadRunner. See http://code.google.com/p/roadrunnerlib for more details.

Copyright (C) 2012-2013 University of Washington, Seattle, WA, USA

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

In plain english this means:

You CAN freely download and use this software, in whole or in part, for personal, company internal, or commercial purposes;

You CAN use the software in packages or distributions that you create.

You SHOULD include a copy of the license in any redistribution you may make;

You are NOT required include the source of software, or of any modifications you may have made to it, in any redistribution you may assemble that includes it.

YOU CANNOT:

redistribute any piece of this software without proper attribution;

Enumeration Type Documentation

enum CLogLevel

Log level enum.

Enumerator
CL_PRIO_FATAL 

Use the current level – don't change the level from what it is.

CL_PRIO_CRITICAL 

A fatal error. The application will most likely terminate. This is the highest priority.

CL_PRIO_ERROR 

A critical error. The application might not be able to continue running successfully.

CL_PRIO_WARNING 

An error. An operation did not complete successfully, but the application as a whole is not affected.

CL_PRIO_NOTICE 

A warning. An operation completed with an unexpected result.

CL_PRIO_INFORMATION 

A notice, which is an information with just a higher priority.

CL_PRIO_DEBUG 

An informational message, usually denoting the successful completion of an operation.

CL_PRIO_TRACE 

A debugging message.

A tracing message. This is the lowest priority.