LOG4CPP::OSTREAMAPPENDER(3)

🦋 log4cpp::OstreamAppender(3) 🦋

okay bestie, welcome to the Library Functions Manual page for log4cpp::OstreamAppender. This is the appender that sends your LoggingEvents into an ostream — yes, that kind of stream. 💅

---

🌸 NAME 🌸

log4cpp::OstreamAppender — OstreamAppender appends LoggingEvents to ostreams. periodt. 🫶

✨ SYNOPSIS ✨

#include <OstreamAppender.hh>

Inherits log4cpp::LayoutAppender.

💖 Public Member Functions 💖

• OstreamAppender (const std::string &name, std::ostream *stream) — constructor, takes a name and a pointer to the stream. No extra deets in the original, bestie.
• virtual ~OstreamAppender () — virtual destructor.
• virtual bool reopen () — reopens the output destination of this Appender, e.g. … (the public list literally stops at “e.g.”; the detailed docs finish it as the logfile or TCP socket, iykyk).
• virtual void close () — release any resources allocated within the appender such as file handles, network connections, etc. 🧹

💫 Public Member Functions inherited from log4cpp::LayoutAppender 💫

• LayoutAppender (const std::string &name) — constructor.
• virtual ~LayoutAppender () — destructor.
• virtual bool requiresLayout () const — check if the appender requires a layout.
• virtual void setLayout (Layout *layout=NULL) — set the Layout for this appender. Default is NULL.

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

💜 Protected Member Functions 💜

• virtual void _append (const LoggingEvent &event) — log in Appender-specific way. This is the actual logging hook, bestie.

🌙 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 🧚

• std::ostream * _stream — the protected stream pointer. Main character energy for output. 💅

👑 Additional Inherited Members 👑

🌟 Public Types inherited from log4cpp::LayoutAppender 🌟

• typedef BasicLayout DefaultLayoutType

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

• static Appender * getAppender (const std::string &name) — get a pointer to an exitsing Appender. (yes, the original spells it “exitsing” — we’re preserving the tea. 🫖)
• static bool reopenAll () — call reopen() on all existing Appenders.
• static void closeAll () — the original description says “Call reopen() on all existing Appenders.” That’s what it says, bestie. Not me fixing it. 💀

🌸 Detailed Description 🌸

OstreamAppender appends LoggingEvents to ostreams. That’s the whole vibe — it’s an appender that writes to an ostream. 🦋

✨ Constructor & Destructor Documentation ✨

• log4cpp::OstreamAppender::OstreamAppender (const std::string & name, std::ostream * stream) — constructor. No extra description in the original.
• log4cpp::OstreamAppender::~OstreamAppender () [virtual] — virtual destructor. No extra description in the original.

🔥 Member Function Documentation 🔥

• void log4cpp::OstreamAppender::_append (const LoggingEvent & event) [protected], [virtual] — log in Appender-specific way. Subclasses of Appender should implement this method to perform actual logging. Parameters: event — The LoggingEvent to log. Implements log4cpp::AppenderSkeleton.
• void log4cpp::OstreamAppender::close () [virtual] — release any resources allocated within the appender such as file handles, network connections, etc. Implements log4cpp::AppenderSkeleton.
• bool log4cpp::OstreamAppender::reopen () [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. Reimplemented from log4cpp::AppenderSkeleton.

🫶 Member Data Documentation 🫶

• std::ostream* log4cpp::OstreamAppender::_stream [protected] — the protected ostream pointer. That’s it, that’s the data. 💖

🧚 Author 🧚

Generated automatically by Doxygen for log4cpp from the source code.

---

bestie sign-off: this page is from log4cpp, Version 1.1, and the footer also repeats log4cpp::OstreamAppender(3). There’s no date printed on the page, so the date slot is a lil blank — no cap, that’s just what the footer gives us. 💅✨