activemq::logger::StreamHandler Class Reference

#include <StreamHandler.h>

Inheritance diagram for activemq::logger::StreamHandler:

activemq::logger::Handler List of all members.

Public Member Functions

 StreamHandler (void)
 StreamHandler (io::OutputStream *stream, Formatter *formatter)
virtual ~StreamHandler (void)
virtual void close (void) throw ( cms::CMSException )
virtual void flush (void)
virtual void publish (const LogRecord &record)
virtual void isLoggable (const LogRecord &record)
virtual void setFilter (const Filter *filter)
virtual const Filter * getFilter (void)
virtual void setLevel (Level level)
virtual Level getLevel (void)
virtual void setFormatter (const Formatter *formatter)
virtual const Formatter * getFormatter (void)
virtual io::OutputStream * getOutputStream (void) const (return stream

Private Attributes

io::OutputStream * stream
Formatter * formatter
Filter * filter

Constructor & Destructor Documentation

activemq::logger::StreamHandler::StreamHandler (  void   )  [inline]
 

Create a StreamHandler, with no current output stream.

activemq::logger::StreamHandler::StreamHandler (  io::OutputStream *  stream,
Formatter *  formatter
)  [inline]
 

Create a StreamHandler, with no current output stream.

virtual activemq::logger::StreamHandler::~StreamHandler (  void   )  [inline, virtual]
 

Destructor


Member Function Documentation

virtual void activemq::logger::StreamHandler::close (  void   )  throw ( cms::CMSException ) [inline, virtual]
 

Close the current output stream.

The close method will perform a flush and then close the Handler. After close has been called this Handler should no longer be used. Method calls may either be silently ignored or may throw runtime exceptions.

Exceptions:
CMSException 

virtual void activemq::logger::StreamHandler::flush (  void   )  [inline, virtual]
 

Flush the Handler's output, clears any buffers.

Implements activemq::logger::Handler.

virtual const Filter* activemq::logger::StreamHandler::getFilter (  void   )  [inline, virtual]
 

Gets the Filter that this Handler uses to filter Log Records

Parameters:
<code>Filter</code> derived instance

Implements activemq::logger::Handler.

virtual const Formatter* activemq::logger::StreamHandler::getFormatter (  void   )  [inline, virtual]
 

Gets the Formatter used by this Handler

Parameters:
<code>Filter</code> derived instance

Implements activemq::logger::Handler.

virtual Level activemq::logger::StreamHandler::getLevel (  void   )  [inline, virtual]
 

Get the log level specifying which message levels will be logged by this Handler.

Parameters:
Level enumeration value

Implements activemq::logger::Handler.

virtual io::OutputStream* activemq::logger::StreamHandler::getOutputStream (  void   )  const [virtual]
 

Gets the output Stream that this Handler is using

Returns:
OuputStream pointer

virtual void activemq::logger::StreamHandler::isLoggable (  const LogRecord &  record  )  [inline, virtual]
 

Check if this Handler would actually log a given LogRecord.

Parameters:
<code>LogRecord</code> to check

Implements activemq::logger::Handler.

virtual void activemq::logger::StreamHandler::publish (  const LogRecord &  record  )  [inline, virtual]
 

Publish the Log Record to this Handler

Parameters:
The Log Record to Publish

Implements activemq::logger::Handler.

virtual void activemq::logger::StreamHandler::setFilter (  const Filter *  filter  )  [inline, virtual]
 

Sets the Filter that this Handler uses to filter Log Records

Parameters:
<code>Filter</code> derived instance

Implements activemq::logger::Handler.

virtual void activemq::logger::StreamHandler::setFormatter (  const Formatter *  formatter  )  [inline, virtual]
 

Sets the Formatter used by this Handler

Parameters:
<code>Filter</code> derived instance

Implements activemq::logger::Handler.

virtual void activemq::logger::StreamHandler::setLevel (  Level  level  )  [inline, virtual]
 

Set the log level specifying which message levels will be logged by this Handler.

The intention is to allow developers to turn on voluminous logging, but to limit the messages that are sent to certain Handlers.

Parameters:
Level enumeration value

Implements activemq::logger::Handler.


Member Data Documentation

Filter* activemq::logger::StreamHandler::filter [private]
 

Formatter* activemq::logger::StreamHandler::formatter [private]
 

io::OutputStream* activemq::logger::StreamHandler::stream [private]
 


The documentation for this class was generated from the following file:
Generated on Thu Aug 3 18:03:33 2006 for activemq-cpp by  doxygen 1.4.5