log4shib::LoggingEvent(3)

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

πŸ’… log4shib::LoggingEvent(3) β€” Library Functions Manual

okay bestie, buckle up β€” this is the manual page for log4shib::LoggingEvent(3) from log4shib, and it's genuinely the lil' data-holder that makes the whole logging thing go. ✨


🌸 NAME

log4shib::LoggingEvent β€” the internal representation of logging events. that's it, that's the vibe πŸŽ€


✨ SYNOPSIS

#include <LoggingEvent.hh>

πŸ’– Public Member Functions

  • LoggingEvent (const std::string &category, const std::string &message, const std::string &ndc, Priority::Value priority) β€” instantiate a LoggingEvent from the supplied parameters. yes, that's the constructor, and yes it slays 🫢

πŸ¦‹ Public Attributes

  • const std::string categoryName β€” the category name.
  • const std::string message β€” the application supplied message of logging event.
  • const std::string ndc β€” the nested diagnostic context (NDC) of logging event.
  • Priority::Value priority β€” priority of logging event.
  • const std::string threadName β€” the name of thread in which this logging event was generated, e.g. the PID.
  • TimeStamp timeStamp β€” the number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created.

πŸ‘‘ Detailed Description

so like, this class is the internal representation of logging events. when an affirmative logging decision is made, a LoggingEvent instance is created, and then that instance gets passed around the different log4shib components. it's literally the main character of the logging pipeline 🌟

this class is of concern to those wishing to extend log4shib. iykyk πŸ’…


πŸŽ€ Constructor & Destructor Documentation

log4shib::LoggingEvent::LoggingEvent (const std::string & category, const std::string & message, const std::string & ndc, Priority::Value priority)

Instantiate a LoggingEvent from the supplied parameters. here's the cute part: except timeStamp, all the other fields of LoggingEvent are filled when actually needed. lazy loading but make it fashion ✨

Parameters

  • category β€” the category of this event.
  • message β€” the message of this event.
  • ndc β€” the nested diagnostic context of this event.
  • priority β€” the priority of this event.

πŸ”₯ Member Data Documentation

const std::string log4shib::LoggingEvent::categoryName

The category name. 🏷️

const std::string log4shib::LoggingEvent::message

The application supplied message of logging event. πŸ’¬

const std::string log4shib::LoggingEvent::ndc

The nested diagnostic context (NDC) of logging event. 🧚

Priority::Value log4shib::LoggingEvent::priority

Priority of logging event. 🌈

const std::string log4shib::LoggingEvent::threadName

The name of thread in which this logging event was generated, e.g. the PID. 🧡

TimeStamp log4shib::LoggingEvent::timeStamp

The number of seconds elapsed since the epoch (1/1/1970 00:00:00 UTC) until logging event was created. ⏰

fr fr, don't sleep on timeStamp β€” it's the one field that doesn't wait around to be filled in later, no cap.

🫢 Author

Generated automatically by Doxygen for log4shib from the source code. so no, a human didn't hand-write this one β€” the robots ate and left no crumbs πŸ€–πŸ’…


and that's the whole page, bestie πŸ’– this was log4shib version 2.0.1, manual page log4shib::LoggingEvent(3) β€” mwah, go log something iconic πŸŽ€βœ¨πŸ¦‹