log4cpp  1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Friends
log4cpp::CategoryStream Class Reference

This class enables streaming simple types and objects to a category. More...

#include <CategoryStream.hh>

Collaboration diagram for log4cpp::CategoryStream:
Collaboration graph
[legend]

List of all members.

Public Types

typedef CategoryStream &(* cspf )(CategoryStream &)

Public Member Functions

 CategoryStream (Category &category, Priority::Value priority)
 Construct a CategoryStream for given Category with given priority.
 ~CategoryStream ()
 Destructor for CategoryStream.
CategorygetCategory () const
 Returns the destination Category for this stream.
Priority::Value getPriority () const throw ()
 Returns the priority for this stream.
void flush ()
 Flush the contents of the stream buffer to the Category and empties the buffer.
template<typename T >
CategoryStreamoperator<< (const T &t)
 Stream in arbitrary types and objects.
template<typename T >
CategoryStreamoperator<< (const std::string &t)
std::streamsize width (std::streamsize wide)
 Set the width output on CategoryStream.
CategoryStreamoperator<< (cspf)

Friends

LOG4CPP_EXPORT friend
CategoryStream
eol (CategoryStream &os)
 eol manipulator
LOG4CPP_EXPORT friend
CategoryStream
left (CategoryStream &os)
 left manipulator

Detailed Description

This class enables streaming simple types and objects to a category.

Use category.errorStream(), etc. to obtain a CategoryStream class.


Member Typedef Documentation


Constructor & Destructor Documentation

Construct a CategoryStream for given Category with given priority.

Parameters:
categoryThe category this stream will send log messages to.
priorityThe priority the log messages will get or Priority::NOTSET to silently discard any streamed in messages.

Destructor for CategoryStream.


Member Function Documentation

Flush the contents of the stream buffer to the Category and empties the buffer.

Returns the destination Category for this stream.

Returns:
The Category.

Returns the priority for this stream.

Returns:
The priority.
template<typename T >
CategoryStream& log4cpp::CategoryStream::operator<< ( const T &  t) [inline]

Stream in arbitrary types and objects.

Parameters:
tThe value or object to stream in.
Returns:
A reference to itself.
template<typename T >
CategoryStream& log4cpp::CategoryStream::operator<< ( const std::string &  t) [inline]
CategoryStream & log4cpp::CategoryStream::operator<< ( cspf  pf)
std::streamsize log4cpp::CategoryStream::width ( std::streamsize  wide)

Set the width output on CategoryStream.


Friends And Related Function Documentation

LOG4CPP_EXPORT friend CategoryStream& eol ( CategoryStream os) [friend]

eol manipulator

LOG4CPP_EXPORT friend CategoryStream& left ( CategoryStream os) [friend]

left manipulator


Member Data Documentation


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines