log4shib(3)

📦 version 2.0.1, in opensuse-leap 16.0

🌸 NAME 🌸

bestie, welcome to log4shib(3) — the Library Functions Manual page for log4shib. It's the top level namespace for all 'Log for C++' types and classes, and that's literally the whole name-section moment. 💅

✨ SYNOPSIS ✨

🦋 Namespaces 🦋

  • namespace threading

🎀 Classes 🎀

  • class AbortAppender — This Appender causes the application to abort() upon the first append() call. Dramatic? Yes. On purpose? Also yes. 😭
  • class Appender — Implement this interface for your own strategies for printing log statements. You do you, bestie.
  • class AppenderSkeleton — AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already takes care of handling of Thresholds and Filters. Iconic labor-saving behavior.
  • class BasicConfigurator — This class implements a trivial default configuration for log4shib: it adds a FileAppender that logs to stdout and uses a BasicLayout to the root Category. Cute little default setup.
  • class BasicLayout — BasicLayout is a simple fixed format Layout implementation. No cap, it's giving simple + fixed.
  • class Category — This is the central class in the log4j package. Main character energy, honestly.
  • struct CategoryNameComponent — no description given in the source, so I'm not inventing lore. Just the name, glowing quietly. ✨
  • class CategoryStream — This class enables streaming simple types and objects to a category. Stream it, bestie.
  • class ConfigureFailure — Exception class for configuration. When config says no. 💀
  • class FileAppender — no description in the source; the class is just here being its FileAppender self. 🎀
  • class Filter — Users should extend this class to implement customized logging event filtering. DIY filter era.
  • class FixedContextCategory — This Category subclass replaces the NDC field in LoggingEvents with a fixed context string. Very "set it and forget it" of it.
  • struct FormatModifierComponent — no description in the source. Just a struct on the list. 🦋
  • class HierarchyMaintainer — HierarchyMaintainer is an internal log4shib class. Internal! Respect the privacy, queen. 👑
  • class IdsaAppender — IdsaAppender is an Appender that sends LoggingEvents to the IDS/A logger and reference monitor by Marc Welz. That's the lore.
  • class Layout — Extend this abstract class to create your own log layout format. Make it yours.
  • class LayoutAppender — LayoutAppender is a common superclass for all Appenders that require a Layout. Common superclass behavior.
  • struct LoggingEvent — The internal representation of logging events. That's the whole note.
  • struct MessageComponent — no description in the source; just the struct name, bestie. 💜
  • struct MillisSinceEpochComponent — no description in the source; name only, no extra claims. ⭐
  • class NDC — The NDC class implements nested diagnostic contexts as defined by Neil Harrison in the article "Patterns for Logging Diagnostic Messages", part of the book Pattern Languages of Program Design 3, edited by Martin et al. That's a whole citation moment. 🎀
  • struct NDCComponent — no description in the source; just vibing as a struct. 🌸
  • class NTEventLogAppender — NTEventLogAppender is an Appender that sends LoggingEvents to the Windows event log. Windows said "I'll take those events."
  • class OstreamAppender — OstreamAppender appends LoggingEvents to ostreams. Streams to ostreams, as advertised.
  • class PatternLayout — PatternLayout is a simple fixed format Layout implementation. Pattern girlie.
  • class Priority — The Priority class provides importance levels with which one can categorize log messages. Categorize the messages, prioritize the vibe.
  • struct PriorityComponent — no description given; just the struct name. 💅
  • struct ProcessorTimeComponent — no description given; name only. ⏱️
  • class Properties — no description in the source. The class is just here. 🎀
  • class PropertyConfigurator — Property configurator will read a config file using the same (or similar) format to the config file used by log4j. Same (or similar) energy.
  • class PropertyConfiguratorImpl — no description in the source; just the class listed. ✨
  • class RemoteSyslogAppender — RemoteSyslogAppender sends LoggingEvents to a remote syslog system. Remote, as the name says.
  • class RollingFileAppender — RollingFileAppender is a FileAppender that rolls over the logfile once it has reached a certain size limit. It rolls when the size limit hits. 🎳
  • struct SecondsSinceEpochComponent — no description in the source; just the struct name. ⭐
  • class SimpleConfigurator — This class implements a simple Configurator for log4shib. Simple. Configurator. Done.
  • class SimpleLayout — The source description says "BasicLayout is a simple fixed format Layout implementation." Yep, that's what it says under SimpleLayout — I'm not fixing it, I'm just reporting it bestie. 😭
  • struct StringLiteralComponent — no description in the source; name only. 🦋
  • class StringQueueAppender — This class puts log messages in an in-memory queue. Queue it up.
  • class StringUtil — no description in the source; just the class name on the list. 💜
  • class SyslogAppender — SyslogAppender sends LoggingEvents to the local syslog system. Local syslog says hi.
  • struct ThreadNameComponent — no description in the source; just the struct. 🎀
  • class TimeStamp — A simple TimeStamp abstraction. Simple. Timestamp. Slay.
  • struct TimeStampComponent — no description in the source; name only. ⏰
  • class Win32DebugAppender — Win32DebugAppender simply sends the log message to the default system debugger on Win32 systems. Win32 debugger gets the message.

⭐ Typedefs ⭐

typedef std::set< Appender * > AppenderSet

🔥 Functions 🔥

  • LOG4SHIB_EXPORT CategoryStream & eol (CategoryStream &os) — eol manipulator. That's the whole function note.

🌈 Variables 🌈

class LOG4SHIB_EXPORT Filter
class LOG4SHIB_EXPORT Category
class LOG4SHIB_EXPORT CategoryStream

💖 Detailed Description 💖

The top level namespace for all 'Log for C++' types and classes. That's the detailed description, and it ate. 💅

🦋 Typedef Documentation 🦋

Here's the exact typedef, because we do not mess with types:

typedef std::set<Appender *> log4shib::AppenderSet

🔥 Function Documentation 🔥

CategoryStream & log4shib::eol (CategoryStream & os) — eol manipulator. That's the function doc, periodt.

🌈 Variable Documentation 🌈

  • class LOG4SHIB_EXPORT log4shib::Category
  • class LOG4SHIB_EXPORT log4shib::CategoryStream
  • class LOG4SHIB_EXPORT log4shib::Filter

💅 Author 💅

Generated automatically by Doxygen for log4shib from the source code. Doxygen really said "I'll generate the whole author section" and did. 🫶

cute little sign-off: this page's footer energy is log4shib Version 2.0.1 and log4shib(3). The original footer doesn't print a date, so I'm not making one up — no cap. 💖

📦 where this page comes from