LOG4SHIB::LAYOUTAPPENDER(3)

💖 NAME 💖

okay bestie, welcome to the log4shib::LayoutAppender(3) manual page — this is the library-functions manual for log4shib::LayoutAppender. It's the common superclass for all Appenders that require a Layout. periodt 💅

✨ SYNOPSIS ✨

#include <LayoutAppender.hh>

Inherits log4shib::AppenderSkeleton.

Inherited by log4shib::FileAppender, log4shib::NTEventLogAppender, log4shib::OstreamAppender, log4shib::RemoteSyslogAppender, log4shib::StringQueueAppender, log4shib::SyslogAppender, and log4shib::Win32DebugAppender. the whole appender friend group fr fr 🫶

🎀 Public Types 🎀

• typedef BasicLayout DefaultLayoutType — this is the default layout type, bestie.

💅 Public Member Functions 💅

• LayoutAppender (const std::string &name) — constructor; it takes the appender name.
• virtual ~LayoutAppender () — virtual destructor.
• 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 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 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 log4shib::Appender 🫶

• virtual ~Appender () — destructor for Appender.
• const std::string & getName () const — get the name of this appender.

🛡️ Protected Member Functions 🛡️

• Layout & _getLayout () — return the layout of the appender.

🛡️ Protected Member Functions inherited from log4shib::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 log4shib::Appender 🛡️

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

🧚 Additional Inherited Members 🧚

🧚 Static Public Member Functions inherited from log4shib::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.

🌈 Detailed Description 🌈

LayoutAppender is a common superclass for all Appenders that require a Layout. it's giving foundational base-class energy, and honestly? iconic 👑

🌸 Member Typedef Documentation 🌸

typedef BasicLayout log4shib::LayoutAppender::DefaultLayoutType

that's the default layout type, no cap. 🎀

🎀 Constructor & Destructor Documentation 🎀

• log4shib::LayoutAppender::LayoutAppender (const std::string & name) — constructor signature as listed; takes the appender name.
• log4shib::LayoutAppender::~LayoutAppender () [virtual] — virtual destructor signature as listed.

💅 Member Function Documentation 💅

• Layout & log4shib::LayoutAppender::_getLayout () [protected] — return the layout of the appender. This method is the Layout accessor for subclasses of LayoutAppender.

Returns — the Layout.

• bool log4shib::LayoutAppender::requiresLayout () const [virtual] — check if the appender requires a layout. All LayoutAppenders do, therefore this method returns true for all subclasses.

Returns — true.

Implements — log4shib::AppenderSkeleton.

• void log4shib::LayoutAppender::setLayout (Layout * layout = NULL) [virtual] — set the Layout for this appender.

Parameters — layout The layout to use.

Implements — log4shib::AppenderSkeleton.

👑 Author 👑

Generated automatically by Doxygen for log4shib from the source code. slay, Doxygen 💅

---

💖 that's the whole vibe, bestie — brought to you by log4shib, Version 2.0.1, and the log4shib::LayoutAppender(3) page. stay iconic ✨💅