log4shib::Appender(3)

✨ log4shib::Appender ✨

okay bestie, this is the log4shib::Appender(3) page from the Library Functions Manual. it's giving “interface you implement when you want your own strategy for printing log statements,” and we're gonna go through every single member function like it's a group-chat recap. no cap. 💖

🌸 NAME 🌸

log4shib::Appender — implement this interface for your own strategies for printing log statements. that's the whole point, bestie 💅

✨ SYNOPSIS ✨

#include <Appender.hh>

Inherited by log4shib::AppenderSkeleton. 🦋

💅 Public Member Functions 💅

• 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. (the synopsis literally stops at e.g. — the full sentence is down below, iykyk 👀)
• 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 Appender * getAppender (const std::string &name) — Get a pointer to an exitsing Appender. (their spelling, not mine 😭)
• static bool reopenAll () — Call reopen() on all existing Appenders. 🔁
• static void closeAll () — Call reopen() on all existing Appenders. (yes, the closeAll description says reopen() too — that's what the page says 👀)

🎀 Protected Member Functions 🎀

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

💜 Detailed Description 💜

Implement this interface for your own strategies for printing log statements. that's the assignment, bestie — make it yours. 💖

🧚 Constructor & Destructor Documentation 🧚

💫 log4shib::Appender::Appender (const std::string & name) [protected] 💫

Constructor for Appender. Will only be used in getAppender() (and in derived classes of course).

Parameters

• name — The name of this Appender.

💀 log4shib::Appender::~Appender () [virtual] 💀

Destructor for Appender.

🔥 Member Function Documentation 🔥

🦋 virtual void log4shib::Appender::close () [pure virtual] 🦋

Release any resources allocated within the appender such as file handles, network connections, etc.

Implemented in: log4shib::AbortAppender, log4shib::AppenderSkeleton, log4shib::FileAppender, log4shib::IdsaAppender, log4shib::NTEventLogAppender, log4shib::OstreamAppender, log4shib::RemoteSyslogAppender, log4shib::StringQueueAppender, log4shib::SyslogAppender, and log4shib::Win32DebugAppender.

🌸 void log4shib::Appender::closeAll () [static] 🌸

Call reopen() on all existing Appenders.

Returns

• true if all Appenders returned true on their reopen() call.

🎀 virtual void log4shib::Appender::doAppend (const LoggingEvent & event) [pure virtual] 🎀

Log in Appender specific way.

Parameters

• event — The LoggingEvent to log.

Implemented in: log4shib::AppenderSkeleton.

🫶 Appender * log4shib::Appender::getAppender (const std::string & name) [static] 🫶

Get a pointer to an exitsing Appender. (yes, “exitsing” is the original spelling, bestie 😭)

Parameters

• name — The name of the Appender to return.

Returns

• a pointer to an existing Appender, or NULL if no appender with the specfied name exists. (again: “specfied” is their spelling 💀)

💅 virtual Filter * log4shib::Appender::getFilter () [pure virtual] 💅

Get the Filter for this appender.

Returns

• the filter, or NULL if no filter has been set.

Implemented in: log4shib::AppenderSkeleton.

⭐ const std::string & log4shib::Appender::getName () const [inline] ⭐

Get the name of this appender. The name identifies the appender.

Returns

• the name of the appender.

👑 virtual Priority::Value log4shib::Appender::getThreshold () [pure virtual] 👑

Get the threshold priority of this Appender.

Returns

• the threshold

Implemented in: log4shib::AppenderSkeleton.

🧚 virtual bool log4shib::Appender::reopen () [pure virtual] 🧚

Reopens the output destination of this Appender, e.g. the logfile or TCP socket.

Returns

• false if an error occured during reopening, true otherwise.

Implemented in: log4shib::AbortAppender, log4shib::AppenderSkeleton, log4shib::FileAppender, log4shib::IdsaAppender, log4shib::NTEventLogAppender, log4shib::OstreamAppender, log4shib::RemoteSyslogAppender, log4shib::StringQueueAppender, and log4shib::SyslogAppender.

🌈 bool log4shib::Appender::reopenAll () [static] 🌈

Call reopen() on all existing Appenders.

Returns

• true if all Appenders returned true on their reopen() call.

🦋 virtual bool log4shib::Appender::requiresLayout () const [pure virtual] 🦋

Check if the appender uses a layout.

Returns

• true if the appender implementation requires a layout.

Implemented in: log4shib::AbortAppender, log4shib::AppenderSkeleton, log4shib::IdsaAppender, and log4shib::LayoutAppender.

🍓 virtual void log4shib::Appender::setFilter (Filter * filter) [pure virtual] 🍓

Set a Filter for this appender.

Implemented in: log4shib::AppenderSkeleton.

🧚 virtual void log4shib::Appender::setLayout (Layout * layout) [pure virtual] 🧚

Set the Layout for this appender.

Parameters

• layout — The layout to use.

Implemented in: log4shib::AbortAppender, log4shib::AppenderSkeleton, log4shib::IdsaAppender, and log4shib::LayoutAppender.

💜 virtual void log4shib::Appender::setThreshold (Priority::Value priority) [pure virtual] 💜

Set the threshold priority of this Appender. The Appender will not append LoggingEvents with a priority lower than the threshold. Use Priority::NOTSET to disable threshold checking.

Parameters

• priority — The priority to set.

Implemented in: log4shib::AppenderSkeleton.

👑 Author 👑

Generated automatically by Doxygen for log4shib from the source code. so no human author to tag — Doxygen ate and left no crumbs 💅

---

sign-off bestie: this page is from log4shib Version 2.0.1 and its manual name is log4shib::Appender(3). the footer doesn't print a date here, so we're not inventing one — mwah 💋🫶