log4shib  1.0.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
log4shib::RemoteSyslogAppender Class Reference

RemoteSyslogAppender sends LoggingEvents to a remote syslog system. More...

#include <RemoteSyslogAppender.hh>

Inheritance diagram for log4shib::RemoteSyslogAppender:
Inheritance graph
[legend]
Collaboration diagram for log4shib::RemoteSyslogAppender:
Collaboration graph
[legend]

Public Member Functions

 RemoteSyslogAppender (const std::string &name, const std::string &syslogName, const std::string &relayer, int facility=LOG_USER, int portNumber=514)
 Instantiate a RemoteSyslogAppender with given name and name and facility for syslog.
virtual ~RemoteSyslogAppender ()
virtual bool reopen ()
 Closes and reopens the socket.
virtual void close ()
 Closes the socket.
- Public Member Functions inherited from log4shib::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 log4shib::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 FiltergetFilter ()
 Get the Filter for this appender.
- Public Member Functions inherited from log4shib::Appender
virtual ~Appender ()
 Destructor for Appender.
const std::string & getName () const
 Get the name of this appender.

Static Public Member Functions

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

Protected Member Functions

virtual void open ()
 Just creates the socket.
virtual void _append (const LoggingEvent &event)
 Sends a LoggingEvent to the remote syslog.
- Protected Member Functions inherited from log4shib::LayoutAppender
Layout_getLayout ()
 Return the layout of the appender.
- Protected Member Functions inherited from log4shib::AppenderSkeleton
 AppenderSkeleton (const std::string &name)
 Constructor for AppenderSkeleton.
- Protected Member Functions inherited from log4shib::Appender
 Appender (const std::string &name)
 Constructor for Appender.

Protected Attributes

const std::string _syslogName
const std::string _relayer
int _facility
int _portNumber
int _socket
in_addr_t _ipAddr

Additional Inherited Members

- Public Types inherited from log4shib::LayoutAppender
typedef BasicLayout DefaultLayoutType

Detailed Description

RemoteSyslogAppender sends LoggingEvents to a remote syslog system.

Also see: draft-ietf-syslog-syslog-12.txt

Constructor & Destructor Documentation

log4shib::RemoteSyslogAppender::RemoteSyslogAppender ( const std::string &  name,
const std::string &  syslogName,
const std::string &  relayer,
int  facility = LOG_USER,
int  portNumber = 514 
)

Instantiate a RemoteSyslogAppender with given name and name and facility for syslog.

Parameters
nameThe name of the Appender
syslogNameThe ident parameter in the openlog(3) call.
relayerThe IP address or hostname of a standard syslog host.
facilityThe syslog facility to log to. Defaults to LOG_USER. Value '-1' implies to use the default.
portNumberAn alternative port number. Defaults to the standard syslog port number (514). Value '-1' implies to use the default.
log4shib::RemoteSyslogAppender::~RemoteSyslogAppender ( )
virtual

Member Function Documentation

void log4shib::RemoteSyslogAppender::_append ( const LoggingEvent event)
protectedvirtual

Sends a LoggingEvent to the remote syslog.

Parameters
eventthe LoggingEvent to log.

Implements log4shib::AppenderSkeleton.

void log4shib::RemoteSyslogAppender::close ( )
virtual

Closes the socket.

Implements log4shib::AppenderSkeleton.

void log4shib::RemoteSyslogAppender::open ( )
protectedvirtual

Just creates the socket.

bool log4shib::RemoteSyslogAppender::reopen ( )
virtual

Closes and reopens the socket.

Reimplemented from log4shib::AppenderSkeleton.

int log4shib::RemoteSyslogAppender::toSyslogPriority ( Priority::Value  priority)
static

Translates a log4shib priority to a syslog priority.

Parameters
priorityThe log4shib priority.
Returns
the syslog priority.

Member Data Documentation

int log4shib::RemoteSyslogAppender::_facility
protected
in_addr_t log4shib::RemoteSyslogAppender::_ipAddr
protected
int log4shib::RemoteSyslogAppender::_portNumber
protected
const std::string log4shib::RemoteSyslogAppender::_relayer
protected
int log4shib::RemoteSyslogAppender::_socket
protected
const std::string log4shib::RemoteSyslogAppender::_syslogName
protected

The documentation for this class was generated from the following files: