Logger::LoggerAppenderFile Class Reference

Implements appender writing to a file. More...

#include <Logger.qm.dox.h>

Inheritance diagram for Logger::LoggerAppenderFile:

Public Member Methods
	constructor (*string name, LoggerLayout layout, string filename, *string encoding)
	Creates the object. More...
File	getFile ()
	Returns the file object for the appender.
string	getFileName ()
	Returns the current filename.
	processEventImpl (int type, auto params)
	Processes open, close, and log events with the file and ignores all other events. More...
Public Member Methods inherited from Logger::LoggerAppenderWithLayout
	constructor (*string name, LoggerLayout layout)
	Creates the object. More...
LoggerLayout	getLayout ()
	Returns the layout for the appender.
	setLayout (LoggerLayout layout)
	Assigns a layout to the appender. More...
Public Member Methods inherited from Logger::LoggerAppender
	addFilter (LoggerFilter filter, bool top=False)
	Adds a filter to the chain. More...
	close ()
	Releases any resources allocated by the appender and closes it.
	constructor (*string name)
	Creates the object. More...
list< LoggerFilter >	getFilters ()
	Returns the filter chain as a list. More...
string	getName ()
	Returns the appender name.
*LoggerAppenderQueue	getQueue ()
	Returns async queue or NOTHING when events are processed synchronously.
bool	isOpen ()
	Returns True if the appender is open and therefore active.
	open ()
	Opens logging resources. More...
bool	post (LoggerEvent event)
	Posts the given event to the output queue. More...
	processEvent (int type, auto params)
	Processes an event to the physical target. More...
abstract	processEventImpl (int type, auto params)
	Processes the event to the physical target. More...
	removeAllFilters ()
	Clears the filter chain by removing all filters.
	removeFilter (LoggerFilter filter)
	Removes the given filter from the filter chain. More...
	setQueue (*LoggerAppenderQueue queue)
	Sets the appender queue. More...

Public Attributes
const	DEFAULT_OPEN_FLAGS = O_CREAT | O_APPEND | O_WRONLY
	Default open flags.
const	EVENT_REOPEN = 1001
	reopen event
Public Attributes inherited from Logger::LoggerAppender
const	EVENT_CLOSE = 3
	close event
const	EVENT_LOG = 2
	logging event
const	EVENT_OPEN = 1
	open event

Additional Inherited Members
Private Member Methods inherited from Logger::LoggerAppenderWithLayout
auto	serializeImpl (LoggerEvent event)
	Returns the value formatted using the layout pattern. More...
Private Member Methods inherited from Logger::LoggerAppender
*object	ensureAtomicOperations (int type)
	Returns an object that can be used to ensure atomic operations for appender operations.
RWLock	lock ()
	The lock to ensure proper serialization with concurrent access.
bool	pushEvent (int type, auto params)
	Pushes the given event on the queue or calls processEvent() in case of synchronous processing. More...
abstract auto	serializeImpl (LoggerEvent event)
	Serializes the given event to put in the queue or write to the target device. More...

Detailed Description

Implements appender writing to a file.

No multi-threading protection is implemented in the class; the File class is reused

Member Function Documentation

constructor()

Logger::LoggerAppenderFile::constructor	(	*string	name,
		LoggerLayout	layout,
		string	filename,
		*string	encoding
	)

Creates the object.

Parameters

name	the name of the appender
layout	the layout for the appender
filename	the output filename
encoding	the file's output encoding

processEventImpl()

Logger::LoggerAppenderFile::processEventImpl ( int  type, auto  params  )

virtual

Processes open, close, and log events with the file and ignores all other events.

Parameters

type	the event type
params	parameters for the event

Implements Logger::LoggerAppender.

Reimplemented in Logger::LoggerAppenderFileRotate, Logger::LoggerAppenderFileRing, and Logger::LoggerAppenderFileArchive.