log4cpp::FileAppender - Man Page

FileAppender (const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644)
Constructs a FileAppender.
FileAppender (const std::string &name, int fd)
Constructs a FileAppender to an already open file descriptor.
virtual ~FileAppender ()
virtual bool reopen ()
Reopens the logfile.
virtual void close ()
Closes the logfile.
virtual void setAppend (bool append)
Sets the append vs truncate flag.
virtual bool getAppend () const
Gets the value of the 'append' option.
virtual void setMode (mode_t mode)
Sets the file open mode.
virtual mode_t getMode () const
Gets the file open mode.

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.
virtual void setLayout (Layout *layout=NULL)
Set the Layout for this appender.

Public Member Functions inherited from log4cpp::AppenderSkeleton
virtual ~AppenderSkeleton ()
Destructor for AppenderSkeleton.
virtual void doAppend (const LoggingEvent &event)
Log in Appender specific way.
virtual void setThreshold (Priority::Value priority)
Set the threshold priority of this Appender.
virtual Priority::Value getThreshold ()
Get the threshold priority of this Appender.
virtual void setFilter (Filter *filter)
Set a Filter for this appender.
virtual Filter * getFilter ()
Get the Filter for this appender.

Public Member Functions inherited from log4cpp::Appender
virtual ~Appender ()
Destructor for Appender.
const std::string & getName () const
Get the name of this appender.

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

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

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

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

const std::string _fileName
int _fd
int _flags
mode_t _mode

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.
static bool reopenAll ()
Call reopen() on all existing Appenders.
static void closeAll ()
Call reopen() on all existing Appenders.

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.

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.

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::DailyRollingFileAppender, and log4cpp::RollingFileAppender.

Closes the logfile.

Implements log4cpp::AppenderSkeleton.

Gets the value of the 'append' option.

Gets the file open mode.

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.

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

Sets the file open mode.