Public Types | Public Member Functions | Static Public Member Functions

base::Log Class Reference

Log class. More...

#include <libppbase/base/Log.h>

Inheritance diagram for base::Log:
base::Mutex

List of all members.

Public Types

enum  levels {
  FATAL = 1, ERR, WARNING, NOTICE,
  INFO, DEBUG
}
 

log levels

More...

Public Member Functions

 Log (const String &name, enum levels level=NOTICE)
 Constructor.
void debug (const char *func, const char *fmt,...)
 Logs a debug message.
void debug (const char *func, const String &msg)
 Logs a debug message.
void error (const char *func, const char *fmt,...)
 Logs an error message.
void error (const char *func, const String &msg)
 Logs an error message.
void error (const char *func, const Exception &ex)
 Logs an exception as error.
void fatal (const char *func, const char *fmt,...)
 Logs a fatal message.
void fatal (const char *func, const String &msg)
 Logs a fatal message.
levels getLoglevel () const
 Returns current loglevel.
String getLogfile ()
 Returns current log file name.
void info (const char *func, const char *fmt,...)
 Logs an informal message.
void info (const char *func, const String &msg)
 Logs an informal message.
void vlog (enum levels level, const char *func, const char *fmt, va_list ap)
 Logs a message.
void log (enum levels level, const char *func, const char *fmt,...)
 Logs a message.
void log (enum levels level, const char *func, const String &msg)
 Logs a message.
void notice (const char *func, const char *fmt,...)
 Logs a notice.
void notice (const char *func, const String &msg)
 Logs a notice.
void setLoglevel (enum levels level)
 Changes the loglevel.
void setPid (Process::pid_type pid=0)
 Changes the process ID.
void setStdErrLog (bool on=true)
 Enable/Disable logging to stderr.
void warn (const char *func, const char *fmt,...)
 Logs an warning message.
void warn (const char *func, const String &msg)
 Logs an warning message.

Static Public Member Functions

static const char * getLoglevelName (enum levels level)
 Returns name of log level.

Detailed Description

Log class.

Author:
Christoph Schwarz
Version:
$Id: Log.h 21 2010-09-05 04:18:17Z cschwarz1 $

Member Enumeration Documentation

enum base::Log::levels

log levels

Enumerator:
FATAL 

fatal error

ERR 

normal error

WARNING 

warning

NOTICE 

significant message

INFO 

debug message level 1

DEBUG 

debug message level 2

Constructor & Destructor Documentation

base::Log::Log ( const String &  name,
enum levels  level = NOTICE 
)

Constructor.

Parameters:
name program or file name (file name must contain at least one ".", "/" or "\", otherwise program name is assumed)
level the log level

Member Function Documentation

void base::Log::debug ( const char *  func,
const char *  fmt,
  ... 
)

Logs a debug message.

See also:
log
void base::Log::debug ( const char *  func,
const String &  msg 
)

Logs a debug message.

See also:
log
void base::Log::error ( const char *  func,
const String &  msg 
)

Logs an error message.

See also:
log
void base::Log::error ( const char *  func,
const Exception &  ex 
)

Logs an exception as error.

See also:
log
void base::Log::error ( const char *  func,
const char *  fmt,
  ... 
)

Logs an error message.

See also:
log
void base::Log::fatal ( const char *  func,
const char *  fmt,
  ... 
)

Logs a fatal message.

See also:
log
void base::Log::fatal ( const char *  func,
const String &  msg 
)

Logs a fatal message.

See also:
log
String base::Log::getLogfile (  ) 

Returns current log file name.

Returns:
current log file name
levels base::Log::getLoglevel (  )  const

Returns current loglevel.

Returns:
the current loglevel
static const char* base::Log::getLoglevelName ( enum levels  level  )  [static]

Returns name of log level.

Returns:
name of log level
void base::Log::info ( const char *  func,
const char *  fmt,
  ... 
)

Logs an informal message.

See also:
log
void base::Log::info ( const char *  func,
const String &  msg 
)

Logs an informal message.

See also:
log
void base::Log::log ( enum levels  level,
const char *  func,
const String &  msg 
)

Logs a message.

Parameters:
level the log level
func the function or method that writes the message
msg the message
void base::Log::log ( enum levels  level,
const char *  func,
const char *  fmt,
  ... 
)

Logs a message.

Parameters:
level the log level
func the function or method that writes the message
fmt the message, in printf-format
... additional arguments for the message
void base::Log::notice ( const char *  func,
const char *  fmt,
  ... 
)

Logs a notice.

See also:
log
void base::Log::notice ( const char *  func,
const String &  msg 
)

Logs a notice.

See also:
log
void base::Log::setLoglevel ( enum levels  level  ) 

Changes the loglevel.

Parameters:
level the new loglevel
void base::Log::setPid ( Process::pid_type  pid = 0  ) 

Changes the process ID.

Parameters:
pid the new process id
void base::Log::setStdErrLog ( bool  on = true  ) 

Enable/Disable logging to stderr.

Parameters:
on true for logging to stderr
void base::Log::vlog ( enum levels  level,
const char *  func,
const char *  fmt,
va_list  ap 
)

Logs a message.

Parameters:
level the log level
func the function or method that writes the message
fmt the message, in printf-format
ap additional arguments for the message
void base::Log::warn ( const char *  func,
const String &  msg 
)

Logs an warning message.

See also:
log
void base::Log::warn ( const char *  func,
const char *  fmt,
  ... 
)

Logs an warning message.

See also:
log
The documentation for this class was generated from the following file:
Generated on Sun Sep 5 2010 21:01:38 for base_libraries by  doxygen 1.7.1