ost::slog(3)

NAME

ost::Slog - The slog class is used to stream messages to the system's
logging facility (syslogd).

SYNOPSIS

#include <slog.h>
Public Types
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 }
typedef enum ost::Slog::Class Class
typedef enum ost::Slog::Level Level
Public Member Functions
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 error (const char *format,...)
    Print a formatted syslog string.
void warn (const char *format,...)
    Print a formatted syslog string.
void debug (const char *format,...)
    Print a formatted syslog string.
void emerg (const char *format,...)
    Print a formatted syslog string.
void alert (const char *format,...)
    Print a formatted syslog string.
void critical (const char *format,...)
    Print a formatted syslog string.
void notice (const char *format,...)
    Print a formatted syslog string.
void info (const char *format,...)
    Print a formatted syslog string.
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 Member Functions
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).

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:

slog('mydaemon', SLOG_DAEMON, SLOG_EMERGENCY) << I just died << endl;

or things like:

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 <dyfet@ostel.com>
Minor docs & hacks by Jon Little <littlej@arlut.utexas.edu>

system logging facility class.

Member Typedef Documentation

typedef enum ost::Slog::Class ost::Slog::Class typedef enum ost::Slog::Level ost::Slog::Level

Member Enumeration Documentation

enum ost::Slog::Class

Enumerator:

classSecurity

classAudit

classDaemon

classUser

classDefault

classLocal0

classLocal1

classLocal2

classLocal3

classLocal4

classLocal5

classLocal6

classLocal7

enum ost::Slog::Level

Enumerator:

levelEmergency

levelAlert

levelCritical

levelError

levelWarning

levelNotice

levelInfo

levelDebug

Constructor & Destructor Documentation

ost::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 ost::Slog::~Slog (void) [virtual]

Member Function Documentation

int ost::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.

void ost::Slog::close (void) void ost::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& ost::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

Slog& ost::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& ost::Slog::operator() (void)

Does nothing except return *this.

void ost::Slog::error (const char * format, ...)

Print a formatted syslog string.

Parameters:

format string.

void ost::Slog::warn (const char * format, ...)

Print a formatted syslog string.

Parameters:

format string.

void ost::Slog::debug (const char * format, ...)

Print a formatted syslog string.

Parameters:

format string.

void ost::Slog::emerg (const char * format, ...)

Print a formatted syslog string.

Parameters:

format string.

void ost::Slog::alert (const char * format, ...)

Print a formatted syslog string.

Parameters:

format string.

void ost::Slog::critical (const char * format, ...)

Print a formatted syslog string.

Parameters:

format string.

void ost::Slog::notice (const char * format, ...)

Print a formatted syslog string.

Parameters:

format string.

void ost::Slog::info (const char * format, ...)

Print a formatted syslog string.

Parameters:

format string.

void ost::Slog::level (Level enable) [inline]

Sets the logging level.

Parameters:

enable is the logging level to use for further output

void ost::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

Examples:

slogTest.cpp.

Slog& ost::Slog::warn (void) [inline]

References levelWarning.

Slog& ost::Slog::error (void) [inline]

References levelError.

Slog& ost::Slog::debug (void) [inline]

References levelDebug.

Slog& ost::Slog::emerg (void) [inline]

References levelEmergency.

Slog& ost::Slog::alert (void) [inline]

References levelAlert.

Slog& ost::Slog::critical (void) [inline]

References levelCritical.

Slog& ost::Slog::notice (void) [inline]

References levelNotice.

Slog& ost::Slog::info (void) [inline]

References levelInfo.

Author

Generated automatically by Doxygen for GNU CommonC++ from the source
code.

GNU CommonC++ 25 Aug 2008 ost::Slog(3)