log4cpp::SyslogAppender - Man Page

SyslogAppender sends LoggingEvents to the local syslog system.

Synopsis

#include <SyslogAppender.hh>

Inherits log4cpp::LayoutAppender.

Public Member Functions

SyslogAppender (const std::string &name, const std::string &syslogName, int facility=LOG_USER)
Instantiate a SyslogAppender with given name and name and facility for syslog.
virtual ~SyslogAppender ()
virtual bool reopen ()
Calls closelog(3) and openlog(3).
virtual void close ()
Calls closelog(3) to close the syslog file descriptor.

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 bool reopen ()
Reopens the output destination of this Appender, e.g.
virtual void close ()=0
Release any resources allocated within the appender such as file handles, network connections, etc.
virtual bool requiresLayout () const =0
Check if the appender uses a layout.
virtual void setLayout (Layout *layout)=0
Set the Layout for this appender.
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.
virtual void doAppend (const LoggingEvent &event)=0
Log in Appender specific way.
virtual bool reopen ()=0
Reopens the output destination of this Appender, e.g.
virtual void close ()=0
Release any resources allocated within the appender such as file handles, network connections, etc.
virtual bool requiresLayout () const =0
Check if the appender uses a layout.
virtual void setLayout (Layout *layout)=0
Set the Layout for this appender.
const std::string & getName () const
Get the name of this appender.
virtual void setThreshold (Priority::Value priority)=0
Set the threshold priority of this Appender.
virtual Priority::Value getThreshold ()=0
Get the threshold priority of this Appender.
virtual void setFilter (Filter *filter)=0
Set a Filter for this appender.
virtual Filter * getFilter ()=0
Get the Filter for this appender.

Static Public Member Functions

static int toSyslogPriority (Priority::Value priority)
Translates a log4cpp priority to a syslog priority.

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.

Protected Member Functions

virtual void open ()
Calls openlog(3).
virtual void _append (const LoggingEvent &event)
Sends a LoggingEvent to syslog.

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.
virtual void _append (const LoggingEvent &event)=0
Log in Appender specific way.

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

Protected Attributes

const std::string _syslogName
int _facility

Additional Inherited Members

Public Types inherited from log4cpp::LayoutAppender

typedef BasicLayout DefaultLayoutType

Detailed Description

SyslogAppender sends LoggingEvents to the local syslog system.

Constructor & Destructor Documentation

log4cpp::SyslogAppender::SyslogAppender (const std::string & name, const std::string & syslogName, int facility = LOG_USER)

Instantiate a SyslogAppender with given name and name and facility for syslog. Note that the C syslog API is process global, so instantion of a second SyslogAppender will 'overwrite' the syslog name of the first.

Parameters

name The name of the Appender
syslogName The ident parameter in the openlog(3) call.
facility The syslog facility to log to. Defaults to LOG_USER.

virtual log4cpp::SyslogAppender::~SyslogAppender () [virtual]

Member Function Documentation

virtual void log4cpp::SyslogAppender::_append (const LoggingEvent & event) [protected], [virtual]

Sends a LoggingEvent to syslog.

Parameters

event the LoggingEvent to log.

Implements log4cpp::AppenderSkeleton.

virtual void log4cpp::SyslogAppender::close () [virtual]

Calls closelog(3) to close the syslog file descriptor.

Implements log4cpp::AppenderSkeleton.

virtual void log4cpp::SyslogAppender::open () [protected], [virtual]

Calls openlog(3).

virtual bool log4cpp::SyslogAppender::reopen () [virtual]

Calls closelog(3) and openlog(3).

Reimplemented from log4cpp::AppenderSkeleton.

static int log4cpp::SyslogAppender::toSyslogPriority (Priority::Value priority) [static]

Translates a log4cpp priority to a syslog priority.

Parameters

priority The log4cpp priority.

Returns

the syslog priority.

Member Data Documentation

int log4cpp::SyslogAppender::_facility [protected]

const std::string log4cpp::SyslogAppender::_syslogName [protected]

Author

Generated automatically by Doxygen for log4cpp from the source code.

Info

Thu Jan 19 2023 Version 1.1.3 log4cpp