LOG4SHIB::STRINGQUEUEAPPENDER(3)

💅 NAME 💅

okay bestie, welcome to the log4shib::StringQueueAppender(3) page in the Library Functions Manual — it's all about the class that puts log messages in an in-memory queue. No cap. It's giving tiny queue, big main character energy 💖.

✨ SYNOPSIS ✨

#include <StringQueueAppender.hh>

Inherits log4shib::LayoutAppender.

💖 Public Member Functions 💖

• StringQueueAppender (const std::string &name) — the constructor, obviously.
• virtual ~StringQueueAppender () — the destructor; it's virtual, bestie.
• virtual bool reopen () — reopens the output destination of this Appender, e.g. the logfile or TCP socket.
• virtual void close () — release any resources allocated within the appender such as file handles, network connections, etc.
• virtual size_t queueSize () const — return the current size of the message queue.
• virtual std::queue< std::string > & getQueue () — return the queue to which the Appends adds messages.
• virtual const std::queue< std::string > & getQueue () const — same queue but const; return the queue to which the Appends adds messages.
• virtual std::string popMessage () — pop the oldest log message from the front of the queue.

🫶 Public Member Functions inherited from log4shib::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. Yes, the default is NULL.

💜 Public Member Functions inherited from log4shib::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 log4shib::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) — appends the LoggingEvent to the queue.

🌈 Protected Member Functions inherited from log4shib::LayoutAppender 🌈

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

🦋 Protected Member Functions inherited from log4shib::AppenderSkeleton 🦋

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

🍓 Protected Member Functions inherited from log4shib::Appender 🍓

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

🧚 Protected Attributes 🧚

• std::queue< std::string > _queue — the protected queue attribute.

⭐ Additional Inherited Members ⭐

💖 Public Types inherited from log4shib::LayoutAppender 💖

• typedef BasicLayout DefaultLayoutType — the default layout type.

🌟 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. Yes, the original literally says reopen() here even though it's closeAll() — I'm just the messenger 💅.

🌸 Detailed Description 🌸

This class puts log messages in an in-memory queue.

Its primary use is in test cases, but it may be useful elsewhere as well.

Since: 0.2.4

🎀 Constructor & Destructor Documentation 🎀

log4shib::StringQueueAppender::StringQueueAppender (const std::string & name)

The constructor. The signature is the whole story here.

log4shib::StringQueueAppender::~StringQueueAppender () [virtual]

The virtual destructor.

💅 Member Function Documentation 💅

void log4shib::StringQueueAppender::_append (const LoggingEvent & event) [protected], [virtual]

Appends the LoggingEvent to the queue.

Parameters:

• event — the LoggingEvent to layout and append to the queue.

Implements: log4shib::AppenderSkeleton.

void log4shib::StringQueueAppender::close () [virtual]

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

Implements: log4shib::AppenderSkeleton.

std::queue< std::string > & log4shib::StringQueueAppender::getQueue () [virtual]

Return the queue to which the Appends adds messages.

Returns: the message queue.

const std::queue< std::string > & log4shib::StringQueueAppender::getQueue () const [virtual]

Return the queue to which the Appends adds messages.

Returns: the message queue.

std::string log4shib::StringQueueAppender::popMessage () [virtual]

Pop the oldest log message from the front of the queue.

Returns: the oldest log message.

size_t log4shib::StringQueueAppender::queueSize () const [virtual]

Return the current size of the message queue. Shorthand for getQueue().size().

Returns: the queue size.

bool log4shib::StringQueueAppender::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: log4shib::AppenderSkeleton.

🌟 Member Data Documentation 🌟

std::queue<std::string> log4shib::StringQueueAppender::_queue [protected]

The protected queue data member. That's the whole vibe — it's the queue.

👑 Author 👑

Generated automatically by Doxygen for log4shib from the source code.

---

xoxo, bestie 💖 — source/version: log4shib, Version 2.0.1, page: log4shib::StringQueueAppender(3). Date: the original footer didn't show one, so I'm not inventing one — periodt 🫶✨.