LOG4CPP::REMOTESYSLOGAPPENDER(3)

💖 NAME 💖

Hey bestie! 💅 Welcome to the log4cpp::R...logAppender(3) page from the Library Functions Manual — this is the log4cpp::RemoteSyslogAppender lore, and it literally sends LoggingEvents to a remote syslog system. Slay. ✨

✨ SYNOPSIS ✨

#include <RemoteSyslogAppender.hh>

Inherits log4cpp::LayoutAppender.

🌸 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 () — the virtual destructor; the original gives no extra description here. 💀
• virtual bool reopen () — Closes and reopens the socket.
• virtual void close () — Closes the socket.

🌈 Public Member Functions inherited from log4cpp::LayoutAppender 🌈

• LayoutAppender (const std::string &name) — constructor; no extra description in the original. ✨
• virtual ~LayoutAppender () — destructor; no extra description in the original.
• 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 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.
• const std::string & getName () const — Get the name of 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. (yep, that exitsing typo is literally in the original — preserving it fr fr)
• static bool reopenAll () — Call reopen() on all existing Appenders.
• static void closeAll () — Call reopen() on all existing Appenders.

🎀 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 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.

💜 Protected Member Functions inherited from log4cpp::Appender 💜

• Appender (const std::string &name) — Constructor for Appender.

👑 Protected Attributes 👑

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

🌈 Additional Inherited Members 🌈

• Public Types inherited from log4cpp::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 🎀

log4cpp::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:

• name — The name of the Appender
• syslogName — The ident parameter in the openlog(3) call.
• relayer — The IP address or hostname of a standard syslog host.
• facility — The syslog facility to log to. Defaults to LOG_USER. Value '-1' implies to use the default.
• portNumber — An alternative port number. Defaults to the standard syslog port number (514). Value '-1' implies to use the default.

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

The virtual destructor. The original leaves it undecorated, so no extra description here bestie. 🫶

🔥 Member Function Documentation 🔥

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

Sends a LoggingEvent to the remote syslog.

Parameters:

• event — the LoggingEvent to log.

Implements log4cpp::AppenderSkeleton.

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

Closes the socket.

Implements log4cpp::AppenderSkeleton.

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

Just creates the socket.

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

Closes and reopens the socket.

Reimplemented from log4cpp::AppenderSkeleton.

int log4cpp::RemoteSyslogAppender::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::RemoteSyslogAppender::_facility [protected]
• in_addr_t log4cpp::RemoteSyslogAppender::_ipAddr [protected]
• int log4cpp::RemoteSyslogAppender::_portNumber [protected]
• const std::string log4cpp::RemoteSyslogAppender::_relayer [protected]
• SOCKET log4cpp::RemoteSyslogAppender::_socket [protected]
• const std::string log4cpp::RemoteSyslogAppender::_syslogName [protected]

The original just lists these protected data members with no extra descriptions — periodt. 💅

🫶 Author 🫶

Generated automatically by Doxygen for log4cpp from the source code.

---

okay bestie, that's the whole page 💖 The footer says source/version log4cpp, Version 1.1, and the page tag log4cpp::R...logAppender(3) — and there's literally no date printed on this one, so that's all the date lore we have 🎀✨