log4cpp  1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes
log4cpp::LoggingEvent Struct Reference

The internal representation of logging events. More...

#include <LoggingEvent.hh>

List of all members.

Public Member Functions

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

Public Attributes

const std::string categoryName
 The category name.
const std::string message
 The application supplied message of logging event.
const std::string ndc
 The nested diagnostic context (NDC) of logging event.
Priority::Value priority
 Priority of logging event.
const std::string threadName
 The name of thread in which this logging event was generated, e.g.
TimeStamp timeStamp
 The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created.

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:
categoryThe category of this event.
messageThe message of this event.
ndcThe nested diagnostic context of this event.
priorityThe 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: