FileAppender Class Reference

#include <FileAppender.hh>

Inheritance diagram for FileAppender:

List of all members.

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 ()
Protected Member Functions
virtual void	_append (const LoggingEvent &event)
Protected Attributes
int	_fd
const std::string	_fileName
int	_flags
mode_t	_mode

---

Detailed Description

Definition at line 20 of file FileAppender.hh.

---

Constructor & Destructor Documentation

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.

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.

virtual FileAppender::~FileAppender

(

)

[virtual]

---

Member Function Documentation

virtual void FileAppender::_append

(

const LoggingEvent &

event

)

[protected, virtual]

Log in Appender specific way. Subclasses of Appender should implement this method to perform actual logging.

Parameters:

event

The LoggingEvent to log.

Implements AppenderSkeleton.

Reimplemented in RollingFileAppender.

virtual void FileAppender::close

(

)

[virtual]

Closes the logfile.

Implements AppenderSkeleton.

virtual bool FileAppender::getAppend

(

)

const [virtual]

Gets the value of the 'append' option.

virtual mode_t FileAppender::getMode

(

)

const [virtual]

Gets the file open mode.

virtual bool 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 AppenderSkeleton.

virtual void 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

virtual void FileAppender::setMode

(

mode_t

mode

)

[virtual]

Sets the file open mode.

---

Member Data Documentation

int FileAppender::_fd [protected]

Definition at line 86 of file FileAppender.hh.

const std::string FileAppender::_fileName [protected]

Definition at line 85 of file FileAppender.hh.

int FileAppender::_flags [protected]

Definition at line 87 of file FileAppender.hh.

mode_t FileAppender::_mode [protected]

Definition at line 88 of file FileAppender.hh.

---

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

• FileAppender.hh