Qore Logger Module Reference  0.1
Logger::LoggerAppenderFile Class Reference

Implements appender writing to a file. More...

Inheritance diagram for Logger::LoggerAppenderFile:

Public Member Methods

 constructor (*string n_name, LoggerLayout n_layout, string n_filename, *string n_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 n_name, LoggerLayout n_layout)
 Creates the object. More...
 
LoggerLayout getLayout ()
 Returns the layout for the appender.
 
 setLayout (LoggerLayout n_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 n_name)
 Creates the object. More...
 
list< LoggerFiltergetFilters ()
 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...
 
 removeAllFilters ()
 Clears the filter chain by removing all filters.
 
 removeFilter (LoggerFilter filter)
 Removes the given filter from the filter chain. More...
 
 setQueue (*LoggerAppenderQueue n_queue)
 Sets the appender queue. More...
 

Additional Inherited Members

- Public Attributes inherited from Logger::LoggerAppender
const EVENT_CLOSE = 3
 close event
 
const EVENT_LOG = 2
 logging event
 
const EVENT_OPEN = 1
 open event
 
- 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
bool pushEvent (int type, auto params)
 Pushes the given event on the queue or calls processEventImpl() in case of synchronous processing. 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  n_name,
LoggerLayout  n_layout,
string  n_filename,
*string  n_encoding 
)

Creates the object.

Parameters
n_namethe name of the appender
n_layoutthe layout for the appender
n_filenamethe output filename
n_encodingthe 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
typethe event type
paramsparameters for the event

Implements Logger::LoggerAppender.

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