Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FileAppender Class Reference

#include <FileAppender.hh>

Inheritance diagram for FileAppender:
Inheritance graph
[legend]

Public Member Functions

virtual void close ()
 Closes the logfile. More...
 
 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 bool getAppend () const
 Gets the value of the 'append' option. More...
 
virtual mode_t getMode () const
 Gets the file open mode. More...
 
virtual bool reopen ()
 Reopens the logfile. More...
 
virtual void setAppend (bool append)
 Sets the append vs truncate flag. More...
 
virtual void setMode (mode_t mode)
 Sets the file open mode. More...
 
virtual ~FileAppender ()
 
- Public Member Functions inherited from LayoutAppender
 LayoutAppender (const std::string &name)
 
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...
 
virtual ~LayoutAppender ()
 
- Public Member Functions inherited from AppenderSkeleton
virtual void doAppend (const LoggingEvent &event)
 Log in Appender specific way. More...
 
virtual FiltergetFilter ()
 Get the Filter for 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 void setThreshold (Priority::Value priority)
 Set the threshold priority of this Appender. More...
 
virtual ~AppenderSkeleton ()
 Destructor for AppenderSkeleton. More...
 
- Public Member Functions inherited from Appender
const std::string & getName () const
 Get the name of this appender. More...
 
virtual ~Appender ()
 Destructor for Appender. More...
 

Protected Member Functions

virtual void _append (const LoggingEvent &event)
 Log in Appender specific way. More...
 
- Protected Member Functions inherited from LayoutAppender
Layout_getLayout ()
 Return the layout of the appender. More...
 
- Protected Member Functions inherited from AppenderSkeleton
 AppenderSkeleton (const std::string &name)
 Constructor for AppenderSkeleton. More...
 
- Protected Member Functions inherited from Appender
 Appender (const std::string &name)
 Constructor for Appender. More...
 

Protected Attributes

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

Additional Inherited Members

- Public Types inherited from LayoutAppender
typedef BasicLayout DefaultLayoutType
 
- Static Public Member Functions inherited from Appender
static void closeAll ()
 Call reopen() on all existing Appenders. More...
 
static AppendergetAppender (const std::string &name)
 Get a pointer to an existing Appender. More...
 
static bool reopenAll ()
 Call reopen() on all existing Appenders. More...
 

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
namethe name of the Appender.
fileNamethe name of the file to which the Appender has to log.
appendwhether the Appender has to truncate the file or just append to it if it already exists. Defaults to 'true'.
modefile 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
namethe name of the Appender.
fdthe file descriptor to which the Appender has to log.
virtual FileAppender::~FileAppender ( )
virtual

Member Function Documentation

virtual void FileAppender::_append ( const LoggingEvent event)
protectedvirtual

Log in Appender specific way.

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

Parameters
eventThe 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
appendfalse 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:


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:55