NAME
Slog - The slog class is used to stream messages to the system's logging facility (syslogd). system logging facility class.
SYNOPSIS
#include <slog.h>
Public Types
typedef enum Slog::Class Class
typedef enum Slog::Level Level
enum Class { classSecurity, classAudit, classDaemon, classUser, classDefault, classLocal0, classLocal1, classLocal2, classLocal3, classLocal4, classLocal5, classLocal6, classLocal7 }
enum Level { levelEmergency = 1, levelAlert, levelCritical, levelError, levelWarning, levelNotice, levelInfo, levelDebug }
Public Methods
Slog (void)
Default (and only) constructor. virtual ~Slog (void)
void close (void)
void open (const char *ident, Class grp=classUser)
(re)opens the output stream. Slog & operator() (const char *ident, Class grp=classUser, Level level=levelError)
Sets the log identifier, level, and class to use for subsequent output. Slog & operator() (Level level, Class grp=classDefault)
Changes the log level and class to use for subsequent output. Slog & operator() (void)
Does nothing except return *this. void level (Level enable)
Sets the logging level. void clogEnable (bool f=true)
Enables or disables the echoing of the messages to clog in addition to the syslog daemon. Slog & warn (void)
Slog & error (void)
Slog & debug (void)
Slog & emerg (void)
Slog & alert (void)
Slog & critical (void)
Slog & notice (void)
Slog & info (void)
Protected Methods
int overflow (int c)
This is the streambuf function that actually outputs the data to the device.
DETAILED DESCRIPTION
The slog class is used to stream messages to the system's logging facility (syslogd). system logging facility class.
A default slog object is used to avoid confusion with the native syslog facility and to imply a logical relationship to the C++ clog().
The key difference is that the slog object sends it's output to the system logging daemon (typically syslogd) rather than through stderr. slog can be streamed with the << operator just like clog; a default slog object is pre-initialized, and you stream character data to it.
The slog allows one to specify logging levels and other properties through the () operators. Hence, once can do:
.nf
slog('mydaemon', SLOG_DAEMON, SLOG_EMERGENCY) << I just died << endl;
or things like:
.nf
slog('mydaemon', SLOG_DAEMON);
slog(SLOG_INFO) << 'daemon initalized' << endl;
The intent is to be as common-place and as convenient to use as the stderr based clog facility found in C++, and this is especially useful for C++ daemons.
The std::flush manipulator doesn't work. Either the std::endl or std::ends manipulators must be used to cause the output to be sent to the daemon.
When this class is used on a system that doesn't have the syslog headers (i.e. a non-posix win32 box), the output goes to the a file with the same name as the syslog identifier string with '.log' appended to it. If the identifier string ends in '.exe', the '.exe' is removed before the '.log' is appened. (e.g. the identifier foo.exe will generate a log file named foo.log)
Author: David Sugar <[email protected]>
Minor docs & hacks by Jon Little <[email protected]>
MEMBER TYPEDEF DOCUMENTATION
typedef enum Slog::Class Slog::Class
typedef enum Slog::Level Slog::Level
MEMBER ENUMERATION DOCUMENTATION
enum Slog::Class
Enumeration values:
- classSecurity
- classAudit
- classDaemon
- classUser
- classDefault
- classLocal0
- classLocal1
- classLocal2
- classLocal3
- classLocal4
- classLocal5
- classLocal6
- classLocal7
enum Slog::Level
Enumeration values:
- levelEmergency
- levelAlert
- levelCritical
- levelError
- levelWarning
- levelNotice
- levelInfo
- levelDebug
CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
Slog::Slog (void)
Default (and only) constructor.
The default log level is set to SLOG_DEBUG. There is no default log facility set. One should be set before attempting any output. This is done by the open() or the operator()(const char *, Class, Level) functions.
virtual Slog::~Slog (void) [virtual]
MEMBER FUNCTION DOCUMENTATION
Slog& Slog::alert (void) [inline]
void Slog::clogEnable (bool f = true) [inline]
Enables or disables the echoing of the messages to clog in addition to the syslog daemon.
This is enabled by the default class constructor.
Parameters:
- f
-
true to enable, false to disable clog output
void Slog::close (void)
Slog& Slog::critical (void) [inline]
Slog& Slog::debug (void) [inline]
Slog& Slog::emerg (void) [inline]
Slog& Slog::error (void) [inline]
Slog& Slog::info (void) [inline]
void Slog::level (Level enable) [inline]
Sets the logging level.
Parameters:
- enable
-
is the logging level to use for further output
Slog& Slog::notice (void) [inline]
void Slog::open (const char * ident, Class grp = classUser)
(re)opens the output stream.
Parameters:
- ident
-
The identifier portion of the message sent to the syslog daemon.
- grp
-
The log facility the message is sent to
Slog& Slog::operator() (void)
Does nothing except return *this.
Slog& Slog::operator() (Level level, Class grp = classDefault)
Changes the log level and class to use for subsequent output.
Parameters:
- level
-
The log level of the message
- grp
-
The log facility the message is sent to
Slog& Slog::operator() (const char * ident, Class grp = classUser, Level level = levelError)
Sets the log identifier, level, and class to use for subsequent output.
Parameters:
- ident
-
The identifier portion of the message
- grp
-
The log facility the message is sent to
- level
-
The log level of the message
int Slog::overflow (int c) [protected]
This is the streambuf function that actually outputs the data to the device.
Since all output should be done with the standard ostream operators, this function should never be called directly.
Slog& Slog::warn (void) [inline]
AUTHOR
Generated automatically by Doxygen for CommonC++ from the source code.