S3FC project page S3FC home page
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

s3_logger Class Reference

This class is used to stream messages to a number of registered ostreams. More...

#include <s3_logger.h>

Collaboration diagram for s3_logger:

Collaboration graph
[legend]
List of all members.

Public Methods

 s3_logger (const std::string &ident_arg=S3_LOG_DEFAULT_IDENT, std::ostream *def_out=0, const bool b_append_info_arg=true)
 Constructor. More...

 s3_logger (const bool b_append_info_arg)
 ~s3_logger ()
 Does nothing. More...

std::list< std::ostream * > & ostream_list (void)
 Returns a reference to the list of ostream pointers. More...

std::ostream & setident (const std::string &new_ident)
 Set the current ident string. More...

std::ostream & setpriority (const int new_priority)
 Set the current message priority. More...

int getpriority (void)
 Return the current priority setting. More...


Private Attributes

s3_log_buffer logbuf
 This streambuf does all the work. More...

Detailed Description

This class is used to stream messages to a number of registered ostreams.

See also:
The overall operation of the S3 Logging System.
Author:
Francois Swanepoel <swanepoel@stonethree.com>

Definition at line 653 of file s3_logger.h.

Constructor & Destructor Documentation

s3_logger::s3_logger (  const std::string &    ident_arg = S3_LOG_DEFAULT_IDENT,
std::ostream *    def_out = 0,
const bool    b_append_info_arg = true
)  [inline]
 

Constructor.

Parameters:
ident_arg  This will be included with all log messages, and is usually the application name.
def_out  The ostream to which this streambuf should stream to. If not supplied, it defaults to cerr. Registered ostream pointers can be altered using standard STL list methods (like clear(), push_back(), etc.).

Definition at line 672 of file s3_logger.h.

References S3_LOG_DEFAULT_IDENT.

s3_logger::s3_logger (  const bool    b_append_info_arg )  [inline]
 

Definition at line 678 of file s3_logger.h.

References S3_LOG_DEFAULT_IDENT.

s3_logger::~s3_logger (    )  [inline]
 

Does nothing.

Definition at line 684 of file s3_logger.h.

Member Function Documentation

int s3_logger::getpriority (  void    )  [inline]
 

Return the current priority setting.

Definition at line 713 of file s3_logger.h.

References s3_log_buffer::get_priority.

std::list<std::ostream*>& s3_logger::ostream_list (  void    )  [inline]
 

Returns a reference to the list of ostream pointers.

Alter this list to change to which ostreams this stream should stream.

Definition at line 690 of file s3_logger.h.

std::ostream& s3_logger::setident (  const std::string &    new_ident )  [inline]
 

Set the current ident string.

Definition at line 696 of file s3_logger.h.

References s3_log_buffer::set_ident.

Referenced by __iomanip_setident.

std::ostream& s3_logger::setpriority (  const int    new_priority )  [inline]
 

Set the current message priority.

See also:
s3_log_buffer::set_priority()

Definition at line 706 of file s3_logger.h.

References s3_log_buffer::set_priority.

Referenced by __iomanip_setpriority.

Member Data Documentation

s3_log_buffer s3_logger::logbuf [private]
 

This streambuf does all the work.

Definition at line 658 of file s3_logger.h.

The documentation for this class was generated from the following file:
Send comments to: s3fc@stonethree.com SourceForge Logo