log4cpp::FileAppender Class Reference

#include <FileAppender.hh>

Inheritance diagram for log4cpp::FileAppender:

Public Member Functions
virtual void	close ()
	FileAppender (const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644)
	FileAppender (const std::string &name, int fd)
virtual bool	getAppend () const
virtual mode_t	getMode () const
virtual bool	reopen ()
virtual void	setAppend (bool append)
virtual void	setMode (mode_t mode)
virtual	~FileAppender ()
Public Member Functions inherited from log4cpp::LayoutAppender
	LayoutAppender (const std::string &name)
virtual bool	requiresLayout () const
virtual void	setLayout (Layout *layout=NULL)
virtual	~LayoutAppender ()
Public Member Functions inherited from log4cpp::AppenderSkeleton
virtual void	doAppend (const LoggingEvent &event)
virtual Filter *	getFilter ()
virtual Priority::Value	getThreshold ()
virtual void	setFilter (Filter *filter)
virtual void	setThreshold (Priority::Value priority)
virtual	~AppenderSkeleton ()
Public Member Functions inherited from log4cpp::Appender
const std::string &	getName () const
virtual	~Appender ()

Protected Member Functions
virtual void	_append (const LoggingEvent &event)
Protected Member Functions inherited from log4cpp::LayoutAppender
Layout &	_getLayout ()
Protected Member Functions inherited from log4cpp::AppenderSkeleton
	AppenderSkeleton (const std::string &name)
Protected Member Functions inherited from log4cpp::Appender
	Appender (const std::string &name)

Protected Attributes
int	_fd
const std::string	_fileName
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 void	closeAll ()
static Appender *	getAppender (const std::string &name)
static bool	reopenAll ()

Detailed Description

Definition at line 20 of file FileAppender.hh.

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.

Definition at line 27 of file FileAppender.cpp.

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.

Definition at line 40 of file FileAppender.cpp.

log4cpp::FileAppender::~FileAppender ( )

virtual

Definition at line 48 of file FileAppender.cpp.

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.

Definition at line 79 of file FileAppender.cpp.

void log4cpp::FileAppender::close ( )

virtual

Closes the logfile.

Implements log4cpp::AppenderSkeleton.

Definition at line 52 of file FileAppender.cpp.

bool log4cpp::FileAppender::getAppend ( ) const

virtual

Gets the value of the 'append' option.

Definition at line 67 of file FileAppender.cpp.

mode_t log4cpp::FileAppender::getMode ( ) const

virtual

Gets the file open mode.

Definition at line 75 of file FileAppender.cpp.

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.

Definition at line 86 of file FileAppender.cpp.

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

Definition at line 59 of file FileAppender.cpp.

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

virtual

Sets the file open mode.

Definition at line 71 of file FileAppender.cpp.

Member Data Documentation

int log4cpp::FileAppender::_fd

protected

Definition at line 86 of file FileAppender.hh.

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

protected

Definition at line 85 of file FileAppender.hh.

int log4cpp::FileAppender::_flags

protected

Definition at line 87 of file FileAppender.hh.

mode_t log4cpp::FileAppender::_mode

protected

Definition at line 88 of file FileAppender.hh.

---

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

• FileAppender.hh
• FileAppender.cpp