CategoryStream Class Reference

#include <CategoryStream.hh>

List of all members.

Public Types
typedef CategoryStream &(*	cspf )(CategoryStream &)
Public Member Functions
	CategoryStream (Category &category, Priority::Value priority)
void	flush ()
Category &	getCategory () const
Priority::Value	getPriority () const throw ()
template<typename T >
CategoryStream &	operator<< (const T &t)
CategoryStream &	operator<< (const char *t)
template<typename T >
CategoryStream &	operator<< (const std::string &t)
CategoryStream &	operator<< (cspf)
std::streamsize	width (std::streamsize wide)
	~CategoryStream ()
Private Member Functions
CategoryStream &	operator= (const CategoryStream &)
Private Attributes
union {
std::ostringstream *   _buffer
};
Category &	_category
Priority::Value	_priority
Friends
LOG4CPP_EXPORT friend CategoryStream &	eol (CategoryStream &os)
LOG4CPP_EXPORT friend CategoryStream &	left (CategoryStream &os)

---

Detailed Description

This class enables streaming simple types and objects to a category. Use category.errorStream(), etc. to obtain a CategoryStream class.

Definition at line 39 of file CategoryStream.hh.

---

Member Typedef Documentation

typedef CategoryStream&(* CategoryStream::cspf)(CategoryStream &)

Definition at line 137 of file CategoryStream.hh.

---

Constructor & Destructor Documentation

CategoryStream::CategoryStream	(	Category &	category,
		Priority::Value	priority
	)

Construct a CategoryStream for given Category with given priority.

Parameters:

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

CategoryStream::~CategoryStream

(

)

Destructor for CategoryStream

---

Member Function Documentation

void CategoryStream::flush

(

)

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

Category& CategoryStream::getCategory

(

)

const [inline]

Returns the destination Category for this stream.

Returns:

The Category.

Definition at line 59 of file CategoryStream.hh.

Priority::Value CategoryStream::getPriority

(

)

const throw () [inline]

Returns the priority for this stream.

Returns:

The priority.

Definition at line 65 of file CategoryStream.hh.

template<typename T >

CategoryStream& CategoryStream::operator<<

(

const T &

t

)

[inline]

Stream in arbitrary types and objects.

Parameters:

t	The value or object to stream in.

Returns:

A reference to itself.

Definition at line 80 of file CategoryStream.hh.

CategoryStream& CategoryStream::operator<<

(

const char *

t

)

template<typename T >

CategoryStream& CategoryStream::operator<<

(

const std::string &

t

)

[inline]

Definition at line 95 of file CategoryStream.hh.

CategoryStream& CategoryStream::operator<<

(

cspf

)

CategoryStream& CategoryStream::operator=

(

const CategoryStream &

)

[private]

std::streamsize 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

union { ... } [private]

std::ostringstream* CategoryStream::_buffer

Definition at line 130 of file CategoryStream.hh.

Category& CategoryStream::_category [private]

Definition at line 127 of file CategoryStream.hh.

Priority::Value CategoryStream::_priority [private]

Definition at line 128 of file CategoryStream.hh.

---

The documentation for this class was generated from the following file:

• CategoryStream.hh