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

s3_msgb_logger Class Reference

This class is used to stream messages to an S3 message box. More...

#include <s3_logger.h>

Collaboration diagram for s3_msgb_logger:

Collaboration graph
[legend]
List of all members.

Public Methods

 s3_msgb_logger (const std::string &my_box_name, const std::string &dst_box_name, const std::string po_ip="", const unsigned int po_port=0)
 Constructor. More...


Protected Attributes

s3_msgb_log_buffer logbuf
 Buffer class that does the actual work. More...

Detailed Description

This class is used to stream messages to an S3 message box.

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

Definition at line 390 of file s3_logger.h.

Constructor & Destructor Documentation

s3_msgb_logger::s3_msgb_logger (  const std::string &    my_box_name,
const std::string &    dst_box_name,
const std::string    po_ip = "",
const unsigned int    po_port = 0
)  [inline]
 

Constructor.

Connects the message box to the postal system.

When values other than the defaults are provided for both the Post Office switch IP and Port arguments, the message box system is initialised if it is not yet initialised. When these arguments are omitted, the message box system must be initialised prior to the instantiation of this class. If the message box connection fail for whatever reason, an s3_generic_exception will be thrown.

Parameters:
my_box_name  The name of the internal message box.
dst_box_name  The message box where the messages are send to.
po_ip  The IP address of the Post Office switch.
po_port  The Post Office switch port.

Definition at line 415 of file s3_logger.h.

Member Data Documentation

s3_msgb_log_buffer s3_msgb_logger::logbuf [protected]
 

Buffer class that does the actual work.

Definition at line 395 of file s3_logger.h.

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