Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

log4cpp::LoggingEvent Struct Reference

The internal representation of logging events. More...

#include <LoggingEvent.hh>

Collaboration diagram for log4cpp::LoggingEvent:

Collaboration graph
[legend]
List of all members.

Public Methods

 LoggingEvent (const std::string &category, const std::string &message, const std::string &ndc, Priority::Value priority)
 Instantiate a LoggingEvent from the supplied parameters. More...


Public Attributes

const std::string categoryName
 The category name. More...

const std::string message
 The application supplied message of logging event. More...

const std::string ndc
 The nested diagnostic context (NDC) of logging event. More...

Priority::Value priority
 Priority of logging event. More...

const std::string threadName
 The name of thread in which this logging event was generated, e.g. More...

TimeStamp timeStamp
 The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created. More...


Detailed Description

The internal representation of logging events.

When a affirmative logging decision is made a LoggingEvent instance is created. This instance is passed around the different log4cpp components.

This class is of concern to those wishing to extend log4cpp.


Constructor & Destructor Documentation

log4cpp::LoggingEvent::LoggingEvent const std::string &    category,
const std::string &    message,
const std::string &    ndc,
Priority::Value    priority
 

Instantiate a LoggingEvent from the supplied parameters.

Except timeStamp all the other fields of LoggingEvent are filled when actually needed.

Parameters:
category  The category of this event.
message  The message of this event.
ndc  The nested diagnostic context of this event.
priority  The priority of this event.


Member Data Documentation

const std::string log4cpp::LoggingEvent::categoryName
 

The category name.

const std::string log4cpp::LoggingEvent::message
 

The application supplied message of logging event.

const std::string log4cpp::LoggingEvent::ndc
 

The nested diagnostic context (NDC) of logging event.

Priority::Value log4cpp::LoggingEvent::priority
 

Priority of logging event.

const std::string log4cpp::LoggingEvent::threadName
 

The name of thread in which this logging event was generated, e.g.

the PID.

TimeStamp log4cpp::LoggingEvent::timeStamp
 

The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created.


The documentation for this struct was generated from the following files:
Generated on Mon Oct 28 23:42:13 2002 for log4cpp by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002