2005/5/9

--
down ACDK
down API Docs
down Namespaces
down acdk
down acdk::util
down acdk::util::logging
down FileConsumer
  down members
See also:
  down FileConsumer.cpp
  down FileConsumer.h

(c) 2005 by
Roger Rene Kommer

Kindly hosted at:
SourceForge.net Logo

     
 

class FileConsumer
artefaktur
Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

acdk::util::logging::FileConsumer Class Reference
[ACDK Logging classes/functions/macros]

#include <FileConsumer.h>

Inheritance diagram for acdk::util::logging::FileConsumer:

acdk::util::logging::AbstractLogConsumer acdk::lang::Object acdk::util::logging::LogConsumer acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch acdk::util::logging::RollingFileConsumer List of all members.

Detailed Description

Writes LogRecord into a file.

See also:
acdk::util::logging::RollingFileConsumer
Author:
Roger Rene Kommer


Public Member Functions

 FileConsumer (INP(RFormatter) formatter=Nil, int minll=AllSys, int maxll=None, bool buffered=false)
 FileConsumer (INP(RString) fname, INP(RFormatter) formatter=Nil, int minll=All, int maxll=None, bool buffered=false)
void publish (INP(RLogRecord) rec)
void _ensureWriter ()
virtual void configure (IN(RString) propnameprefix, IN(RProperties) props)
 Will be called by the LogManager to self-configuration this LogConsumer.

void _openWriter ()
bool isBuffered () const
void setBuffered (bool buffered)
int getFlushLevel () const
void setFlushLevel (int level)

Protected Attributes

RString _fname
::acdk::io::RCharWriter _writer
bool _buffered
int _flushLevel

Constructor & Destructor Documentation

acdk::util::logging::FileConsumer::FileConsumer (  INP(RFormatter)  formatter = Nil,
int  minll = AllSys,
int  maxll = None,
bool  buffered = false
)  [inline]
 

acdk::util::logging::FileConsumer::FileConsumer (  INP(RString)  fname,
INP(RFormatter)  formatter = Nil,
int  minll = All,
int  maxll = None,
bool  buffered = false
) 
 

Parameters:
fname the base file name. $(PNAME) will be replaced by executalle name $(PID) will be replaced by process id

Member Function Documentation

void acdk::util::logging::FileConsumer::_ensureWriter (   )  [inline]
 

void acdk::util::logging::FileConsumer::_openWriter (   ) 
 

virtual void acdk::util::logging::FileConsumer::configure (  IN(RString)  propnameprefix,
IN(RProperties)  props
)  [virtual]
 

Will be called by the LogManager to self-configuration this LogConsumer.

To access a custom configure value 'foo' just read it with the the prefix propnameprefix + foo

Reimplemented from acdk::util::logging::AbstractLogConsumer.

Reimplemented in acdk::util::logging::RollingFileConsumer.

int acdk::util::logging::FileConsumer::getFlushLevel (   )  const [inline]
 

bool acdk::util::logging::FileConsumer::isBuffered (   )  const [inline]
 

void acdk::util::logging::FileConsumer::publish (  INP(RLogRecord)  rec  )  [inline]
 

Reimplemented in acdk::util::logging::RollingFileConsumer.

void acdk::util::logging::FileConsumer::setBuffered (  bool  buffered  )  [inline]
 

void acdk::util::logging::FileConsumer::setFlushLevel (  int  level  )  [inline]
 

Reimplemented in acdk::util::logging::RollingFileConsumer.

Member Data Documentation

bool acdk::util::logging::FileConsumer::_buffered [protected]
 

int acdk::util::logging::FileConsumer::_flushLevel [protected]
 

Reimplemented in acdk::util::logging::RollingFileConsumer.

RString acdk::util::logging::FileConsumer::_fname [protected]
 

::acdk::io::RCharWriter acdk::util::logging::FileConsumer::_writer [protected]