log4cpp::LayoutAppender(3)

💅 log4cpp::LayoutAppender 💅

okay bestie, this is the log4cpp::LayoutAppender(3) page from the Library Functions Manual — manual-name energy folded in right at the top 🎀. It’s giving “C++ logging superclass realness,” and we’re gonna get through every single detail together. No cap.

---

✨ NAME ✨

log4cpp::LayoutAppender — the common superclass for all Appenders that require a Layout. Periodt.

---

🌸 SYNOPSIS 🌸

#include <LayoutAppender.hh>

Inherits log4cpp::AppenderSkeleton.

Inherited by log4cpp::BufferingAppender, log4cpp::FileAppender, log4cpp::OstreamAppender, log4cpp::RemoteSyslogAppender, log4cpp::StringQueueAppender, log4cpp::SyslogAppender, and log4cpp::Win32DebugAppender.

🎀 Public Types 🎀

typedef BasicLayout DefaultLayoutType

🫶 Public Member Functions 🫶

• LayoutAppender (const std::string &name) — the constructor, bestie.
• virtual ~LayoutAppender () — the 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 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. (yep, the original sentence trails off there 😭)
• 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 log4cpp::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 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.

🌈 Additional Inherited Members 🌈

⭐ Static Public Member Functions inherited from log4cpp::Appender ⭐

• static Appender * getAppender (const std::string &name) — get a pointer to an exitsing Appender (that spelling is literally in the original, bestie 👀).
• static bool reopenAll () — call reopen() on all existing Appenders.
• static void closeAll () — call reopen() on all existing Appenders. (Yep, that’s what it says under closeAll — I’m just the messenger 💀.)

---

💫 Detailed Description 💫

LayoutAppender is a common superclass for all Appenders that require a Layout. That’s the whole main-character job, honestly.

---

🦋 Member Typedef Documentation 🦋

typedef BasicLayout log4cpp::LayoutAppender::DefaultLayoutType

---

🎀 Constructor & Destructor Documentation 🎀

• log4cpp::LayoutAppender::LayoutAppender (const std::string & name)
• log4cpp::LayoutAppender::~LayoutAppender () [virtual]

---

💅 Member Function Documentation 💅

🫶 Layout & log4cpp::LayoutAppender::_getLayout () [protected]

Return the layout of the appender. This method is the Layout accessor for subclasses of LayoutAppender.

Returns: the Layout.

✨ bool log4cpp::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: log4cpp::AppenderSkeleton.

🌸 void log4cpp::LayoutAppender::setLayout (Layout * layout = NULL) [virtual]

Set the Layout for this appender.

Parameters: layout — the layout to use.

Implements: log4cpp::AppenderSkeleton.

---

📜 Author 📜

Generated automatically by Doxygen for log4cpp from the source code.

---

✨ That’s the whole page, bestie! Source/version: log4cpp, Version 1.1. Date: not shown on this page — the footer is keeping that mysterious 🙈, and I’m not inventing one. Bye! 💖