log4shib::...ugAppender(3)

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

✨ log4shib::Win32DebugAppender ✨

okay so bestie, you've stumbled into the log4shib docs (that's the manual name btw, a library β€” you're welcome πŸ’–) and this particular page is all about log4shib::Win32DebugAppender. And like… Win32DebugAppender simply sends the log message to the default system debugger on Win32 systems. That's literally the whole vibe. πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

Include it like this, no cap:

#include <Win32DebugAppender.hh>

It inherits log4shib::LayoutAppender. Family tree time 🧚:

πŸ’œ Public Member Functions

  • Win32DebugAppender (const std::string &name) β€” Constructor, bestie.
  • virtual ~Win32DebugAppender () β€” Destructor.
  • virtual void close () β€” Close method. Slay.

🌸 Public Member Functions inherited from log4shib::LayoutAppender

  • LayoutAppender (const std::string &name)
  • virtual ~LayoutAppender ()
  • 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 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) β€” Method that does the actual work. Main character energy fr fr.

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

πŸ‘‘ 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.
    • static bool reopenAll () β€” Call reopen() on all existing Appenders.
    • static void closeAll () β€” Call reopen() on all existing Appenders.

πŸ’– Detailed Description πŸ’–

Win32DebugAppender simply sends the log message to the default system debugger on Win32 systems. Periodt.

This is useful for users of MSVC and Borland because the log messages will show up in the debugger window. Obsessed, honestly. 😭

NB: This class is only available on Win32 platforms. So if you're on anything else… it's giving not for you, bestie. πŸ’€

🧚 Constructor & Destructor Documentation 🧚

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

Constructor.

Parameters

  • name β€” Name used by the base classes only.

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

Destructor.


πŸ”₯ Member Function Documentation πŸ”₯

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

Method that does the actual work. In this case, it simply sets up the layout and calls the OutputDebugString API.

Parameters

  • event β€” Event for which we are logging.

Implements log4shib::AppenderSkeleton.

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

Close method. This is called by the framework, but there is nothing to do for the OutputDebugString API, so it simply returns. Lowkey the easiest job in the whole library tbh. πŸ’…

Implements log4shib::AppenderSkeleton.


⭐ Author ⭐

Generated automatically by Doxygen for log4shib from the source code. (Not a human author, just robot vibes πŸ€–βœ¨)


okay that's the whole page, bestie β€” you ate that reading session fr fr 🫢 this was Version 2.0.1 of the log4shib docs, dated with the source page footer label log4shib::...ugAppender(3), brought to you by the one and only log4shib πŸ’– bye bye, go log something iconic 🌸