#include <FileAppender.hh>

Inheritance diagram for log4cpp::FileAppender:

[legend]

Collaboration diagram for log4cpp::FileAppender:

Public Member Functions
	FileAppender (const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644)
	Constructs a FileAppender. More...

	FileAppender (const std::string &name, int fd)
	Constructs a FileAppender to an already open file descriptor. More...

virtual	~FileAppender ()

virtual bool	reopen ()
	Reopens the logfile. More...

virtual void	close ()
	Closes the logfile. More...

virtual void	setAppend (bool append)
	Sets the append vs truncate flag. More...

virtual bool	getAppend () const
	Gets the value of the 'append' option. More...

virtual void	setMode (mode_t mode)
	Sets the file open mode. More...

virtual mode_t	getMode () const
	Gets the file open mode. More...

Public Member Functions inherited from log4cpp::LayoutAppender
	LayoutAppender (const std::string &name)

virtual	~LayoutAppender ()

virtual bool	requiresLayout () const
	Check if the appender requires a layout. More...

virtual void	setLayout (Layout *layout=NULL)
	Set the Layout for this appender. More...

Public Member Functions inherited from log4cpp::AppenderSkeleton
virtual	~AppenderSkeleton ()
	Destructor for AppenderSkeleton. More...

virtual void	doAppend (const LoggingEvent &event)
	Log in Appender specific way. More...

virtual void	setThreshold (Priority::Value priority)
	Set the threshold priority of this Appender. More...

virtual Priority::Value	getThreshold ()
	Get the threshold priority of this Appender. More...

virtual void	setFilter (Filter *filter)
	Set a Filter for this appender. More...

virtual Filter *	getFilter ()
	Get the Filter for this appender. More...

Public Member Functions inherited from log4cpp::Appender
virtual	~Appender ()
	Destructor for Appender. More...

const std::string &	getName () const
	Get the name of this appender. More...

Protected Member Functions
virtual void	_append (const LoggingEvent &event)
	Log in Appender specific way. More...

Protected Member Functions inherited from log4cpp::LayoutAppender
Layout &	_getLayout ()
	Return the layout of the appender. More...

Protected Member Functions inherited from log4cpp::AppenderSkeleton
	AppenderSkeleton (const std::string &name)
	Constructor for AppenderSkeleton. More...

Protected Member Functions inherited from log4cpp::Appender
	Appender (const std::string &name)
	Constructor for Appender. More...

Protected Attributes
const std::string	_fileName

int	_fd

int	_flags

mode_t	_mode

Additional Inherited Members
Public Types inherited from log4cpp::LayoutAppender
typedef BasicLayout	DefaultLayoutType

Static Public Member Functions inherited from log4cpp::Appender
static Appender *	getAppender (const std::string &name)
	Get a pointer to an exitsing Appender. More...

static bool	reopenAll ()
	Call reopen() on all existing Appenders. More...

static void	closeAll ()
	Call reopen() on all existing Appenders. More...

Constructor & Destructor Documentation

log4cpp::FileAppender::FileAppender	(	const std::string &	name,
		const std::string &	fileName,
		bool	append = `true`,
		mode_t	mode = `00644`
	)

Constructs a FileAppender.

Parameters

name	the name of the Appender.
fileName	the name of the file to which the Appender has to log.
append	whether the Appender has to truncate the file or just append to it if it already exists. Defaults to 'true'.
mode	file mode to open the logfile with. Defaults to 00644.

log4cpp::FileAppender::FileAppender	(	const std::string &	name,
		int	fd
	)

Constructs a FileAppender to an already open file descriptor.

Parameters

name	the name of the Appender.
fd	the file descriptor to which the Appender has to log.

log4cpp::FileAppender::~FileAppender ( )

virtual

Member Function Documentation

void log4cpp::FileAppender::_append ( const LoggingEvent & event )

protectedvirtual

Log in Appender specific way.

Subclasses of Appender should implement this method to perform actual logging.

Parameters

event The LoggingEvent to log.

Implements log4cpp::AppenderSkeleton.

Reimplemented in log4cpp::RollingFileAppender, and log4cpp::DailyRollingFileAppender.

void log4cpp::FileAppender::close ( )

virtual

Closes the logfile.

Implements log4cpp::AppenderSkeleton.

bool log4cpp::FileAppender::getAppend ( ) const

virtual

Gets the value of the 'append' option.

mode_t log4cpp::FileAppender::getMode ( ) const

virtual

Gets the file open mode.

bool log4cpp::FileAppender::reopen ( )

virtual

Reopens the logfile.

This can be useful for logfiles that are rotated externally, e.g. by logrotate. This method is a NOOP for FileAppenders that have been constructed with a file descriptor.

Returns: true if the reopen succeeded.

Reimplemented from log4cpp::AppenderSkeleton.

void log4cpp::FileAppender::setAppend ( bool append )

virtual

Sets the append vs truncate flag.

NB. currently the FileAppender opens the logfile in the constructor. Therefore this method is too late to influence the first file opening. We'll need something similar to log4j's activateOptions().

Parameters

append false to truncate, true to append

void log4cpp::FileAppender::setMode ( mode_t mode )

virtual

Sets the file open mode.

Member Data Documentation

int log4cpp::FileAppender::_fd

protected

const std::string log4cpp::FileAppender::_fileName

protected

int log4cpp::FileAppender::_flags

protected

mode_t log4cpp::FileAppender::_mode

protected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation