LOG4SHIB::OSTREAMAPPENDER(3)

πŸ“¦ version 2.0.1, in opensuse-leap 16.0

🌸 NAME 🌸

log4shib::OstreamAppender β€” okay bestie, this is from the log4shib Library Functions manual, and the page tag is log4shib::...eamAppender(3). The appender appends LoggingEvents to ostreams. Periodt. πŸ’…


✨ SYNOPSIS ✨

#include <OstreamAppender.hh>

Inherits log4shib::LayoutAppender.


πŸ’– Public Member Functions πŸ’–

  • OstreamAppender (const std::string &name, std::ostream *stream) β€” constructor vibes, no extra description on the page.
  • virtual ~OstreamAppender () β€” destructor, also no extra description here.
  • virtual bool reopen () β€” Reopens the output destination of this Appender, e.g. the logfile or TCP socket. The full tea is down in the member docs.
  • virtual void close () β€” Release any resources allocated within the appender such as file handles, network connections, etc.

πŸ¦‹ 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.

🌈 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) β€” Log in Appender specific way.

🌸 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::ostream * _stream

🫢 Additional Inherited Members 🫢

Public Types inherited from log4shib::LayoutAppender

  • typedef BasicLayout DefaultLayoutType

Static Public Member Functions inherited from log4shib::Appender

  • static Appender * getAppender (const std::string &name) β€” Get a pointer to an exitsing Appender. (Yes, β€œexitsing” is exactly what the page says β€” I'm not fixing the typo, bestie.)
  • static bool reopenAll () β€” Call reopen() on all existing Appenders.
  • static void closeAll () β€” Call reopen() on all existing Appenders. (Again: the page literally says reopen() here. I'm just relaying it exactly, no cap.)

πŸ”₯ Detailed Description πŸ”₯

OstreamAppender appends LoggingEvents to ostreams.

It's giving β€œoutput destination, but make it an ostream.” Iconic. ✨


πŸ’€ Constructor & Destructor Documentation πŸ’€

  • log4shib::OstreamAppender::OstreamAppender (const std::string & name, std::ostream * stream)
  • log4shib::OstreamAppender::~OstreamAppender () [virtual]

πŸ‘‘ Member Function Documentation πŸ‘‘

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

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

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

Implements log4shib::AppenderSkeleton.

bool log4shib::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. (β€œoccured” is preserved exactly, bestie β€” character for character.)

Reimplemented from log4shib::AppenderSkeleton.


πŸ’– Member Data Documentation πŸ’–

  • std::ostream* log4shib::OstreamAppender::_stream [protected]

🌟 Author 🌟

Generated automatically by Doxygen for log4shib from the source code.


That's the whole page, bestie β€” every function, inherited member, typo, and tiny detail is still here. πŸ’œ

Cute little footer sign-off: this is log4shib, Version 2.0.1, page tag log4shib::...eamAppender(3) β€” and that's the vibe check complete. πŸŽ€πŸ¦‹