LOG4CPP::FIXEDCONTEXTCATEGORY(3)

📦
version 1.1.4 · 4 versions
, in opensuse-leap 16.0

💅 log4cpp::FixedContextCategory(3) 💅

okay so bestie, this is a page from the Library Functions Manual — section 3, the C library / function-call girlies — and it's all about log4cpp::FixedContextCategory. grab a lil snack, we're getting into it 🍓

🌸 NAME 🌸

log4cpp::FixedContextCategory — this Category subclass replaces the NDC field in LoggingEvents with a fixed context string. that's the whole vibe. no cap 💅

✨ SYNOPSIS ✨

#include <FixedContextCategory.hh>

Inherits log4cpp::Category.

🎀 Public Member Functions 🎀

  • FixedContextCategory(const std::string &name, const std::string &context='') — Constructor. yes queen, build the thing 💖
  • virtual ~FixedContextCategory() — Destructor for Category.
  • virtual void setContext(const std::string &context) — Set the context string used as NDC.
  • virtual std::string getContext() const — Return the context string used as NDC.
  • virtual Priority::Value getPriority() const LOG4CPP_NOTHROW — Returns the assigned Priority, if any, for this Category.
  • virtual Priority::Value getChainedPriority() const LOG4CPP_NOTHROW — Starting from this Category, search the category hierarchy for a set priority and return it.
  • virtual void addAppender(Appender *appender) LOG4CPP_NOTHROW — For the moment this method does nothing. 😭 literally nothing, bestie, it's giving decorative.
  • virtual void addAppender(Appender &appender) — For the moment this method does nothing. (same energy, reference edition 🫶)
  • virtual Appender * getAppender() const — Returns the Appender for this Category, or NULL if no Appender has been set.
  • virtual Appender * getAppender(const std::string &name) const — Returns the specified Appender for this Category, or NULL if the Appender is not attached to this Category.
  • virtual AppenderSet getAllAppenders() const — Returns the set of Appenders currently attached to this Category.
  • virtual void removeAllAppenders() — Removes all appenders set for this Category.
  • virtual bool ownsAppender() const LOG4CPP_NOTHROW — FixedContextAppenders cannot own Appenders. hard no, not their appenders ✋
  • virtual bool ownsAppender(Appender *appender) const LOG4CPP_NOTHROW — FixedContextAppenders cannot own Appenders. still no 💀
  • virtual void callAppenders(const LoggingEvent &event) LOG4CPP_NOTHROW — Call the appenders in the hierarchy starting at this.
  • virtual void setAdditivity(bool additivity) — Set the additivity flag for this Category instance.
  • virtual bool getAdditivity() const LOG4CPP_NOTHROW — Returns the additivity flag for this Category instance.

💜 Public Member Functions inherited from log4cpp::Category 💜

  • virtual ~Category() — Destructor for Category.
  • virtual const std::string & getName() const LOG4CPP_NOTHROW — Return the category name.
  • virtual void setPriority(Priority::Value priority) — Set the priority of this Category.
  • virtual bool isPriorityEnabled(Priority::Value priority) const LOG4CPP_NOTHROW — Returns true if the chained priority of the Category is equal to or higher than given priority.
  • void setAppender(Appender *appender) — Adds an Appender to this Category.
  • void setAppender(Appender &appender) — Adds an Appender for this Category.
  • virtual void removeAppender(Appender *appender) — Removes specified appender for this Category.
  • virtual Category * getParent() LOG4CPP_NOTHROW — Returns the parent category of this category, or NULL if the category is the root category.
  • virtual const Category * getParent() const LOG4CPP_NOTHROW — Returns the parent category of this category, or NULL if the category is the root category. (const version, she's the same but classier ✨)
  • virtual void log(Priority::Value priority, const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with the specified priority.
  • virtual void log(Priority::Value priority, const std::string &message) LOG4CPP_NOTHROW — Log a message with the specified priority.
  • virtual void logva(Priority::Value priority, const char *stringFormat, va_list va) LOG4CPP_NOTHROW — Log a message with the specified priority.
  • void debug(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with debug priority.
  • void debug(const std::string &message) LOG4CPP_NOTHROW — Log a message with debug priority.
  • bool isDebugEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority DEBUG.
  • CategoryStream debugStream() — Return a CategoryStream with priority DEBUG.
  • void info(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with info priority.
  • void info(const std::string &message) LOG4CPP_NOTHROW — Log a message with info priority.
  • bool isInfoEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority INFO.
  • CategoryStream infoStream() — Return a CategoryStream with priority INFO.
  • void notice(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with notice priority.
  • void notice(const std::string &message) LOG4CPP_NOTHROW — Log a message with notice priority.
  • bool isNoticeEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority NOTICE.
  • CategoryStream noticeStream() — Return a CategoryStream with priority NOTICE.
  • void warn(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with warn priority.
  • void warn(const std::string &message) LOG4CPP_NOTHROW — Log a message with warn priority.
  • bool isWarnEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority WARN.
  • CategoryStream warnStream() — Return a CategoryStream with priority WARN.
  • void error(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with error priority.
  • void error(const std::string &message) LOG4CPP_NOTHROW — Log a message with error priority.
  • bool isErrorEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority ERROR.
  • CategoryStream errorStream() — Return a CategoryStream with priority ERROR.
  • void crit(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with crit priority.
  • void crit(const std::string &message) LOG4CPP_NOTHROW — Log a message with crit priority.
  • bool isCritEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority CRIT.
  • CategoryStream critStream() — Return a CategoryStream with priority CRIT.
  • void alert(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with alert priority.
  • void alert(const std::string &message) LOG4CPP_NOTHROW — Log a message with alert priority.
  • bool isAlertEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority ALERT.
  • CategoryStream alertStream() LOG4CPP_NOTHROW — Return a CategoryStream with priority ALERT.
  • void emerg(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with emerg priority.
  • void emerg(const std::string &message) LOG4CPP_NOTHROW — Log a message with emerg priority.
  • bool isEmergEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority EMERG.
  • CategoryStream emergStream() — Return a CategoryStream with priority EMERG.
  • void fatal(const char *stringFormat,...) LOG4CPP_NOTHROW — Log a message with fatal priority.
  • void fatal(const std::string &message) LOG4CPP_NOTHROW — Log a message with fatal priority.
  • bool isFatalEnabled() const LOG4CPP_NOTHROW — Return true if the Category will log messages with priority FATAL.
  • CategoryStream fatalStream() — Return a CategoryStream with priority FATAL.
  • virtual CategoryStream getStream(Priority::Value priority) — Return a CategoryStream with given Priority.
  • virtual CategoryStream operator<<(Priority::Value priority) — Return a CategoryStream with given Priority.

🦋 Protected Member Functions 🦋

  • virtual void _logUnconditionally2(Priority::Value priority, const std::string &message) LOG4CPP_NOTHROW — Unconditionally log a message with the specified priority. (no further comment in the source, icon behaviour honestly 👑)

🧚 Protected Member Functions inherited from log4cpp::Category 🧚

  • Category(const std::string &name, Category *parent, Priority::Value priority=Priority::NOTSET) — Constructor.
  • virtual void _logUnconditionally(Priority::Value priority, const char *format, va_list arguments) LOG4CPP_NOTHROW — (no description on this one, it's a mystery, we respect the silence 🙈)

🌈 Additional Inherited Members 🌈

⭐ Static Public Member Functions inherited from log4cpp::Category ⭐

  • static Category & getRoot() — Return the root of the Category hierarchy.
  • static void setRootPriority(Priority::Value priority) — Set the priority of the root Category.
  • static Priority::Value getRootPriority() LOG4CPP_NOTHROW — Get the priority of the root Category.
  • static Category & getInstance(const std::string &name) — Instantiate a Category with name name.
  • static Category * exists(const std::string &name) — If the named category exists (in the default hierarchy) then it returns a reference to the category, otherwise it returns NULL.
  • static std::vector< Category * > * getCurrentCategories() — Returns all the currently defined categories as a vector of Category pointers.
  • static void shutdown() — This method will remove all Appenders from Categories.XXX.
  • static void shutdownForced() — This method will remove all Appenders from Categories.XXX and delete all appenders.

🔥 Detailed Description 🔥

So like — this Category subclass replaces the NDC field in LoggingEvents with a fixed context string. that's the entire personality. 💅

All handling of Appenders, etc. is delegated to the 'normal' Category with the same name. lowkey the whole point: it's intended for object instances that serve a single client — they construct a FixedContextCategory with the client identifier as the context. and here's the catch, bestie, listen up: unlike with regular Category instances, you have to explicitly create FixedContextCategory instances using the constructor. which also means you have to take care of destruction of the instance yourself too. no free ride, no magic cleanup, it's giving main-character responsibility 🫶

💀 fr fr: explicit construction + explicit destruction. don't come crying to me when you leak one.

🌟 Since 🌟

0.2.4 — vintage darling, she's been iconic since 0.2.4 ✨

🎀 Constructor & Destructor Documentation 🎀

log4cpp::FixedContextCategory::FixedContextCategory(const std::string &name, const std::string &context = '')

Constructor. 🎉

Parameters

  • name — the fully qualified name of this Categories delegate Category.
  • context — the context to fill the NDC field of LoggingEvents with.

log4cpp::FixedContextCategory::~FixedContextCategory() [virtual]

Destructor for Category. say bye bestie 👋💖

💅 Member Function Documentation 💅

okay bestie, this is the whole member-function lineup, and yes, we're keeping every overload, flag, return value, and little note. no cap. 🫶

  • void log4cpp::FixedContextCategory::_logUnconditionally2 (Priority::Value priority, const std::string & message) [protected], [virtual] — Unconditionally log a message with the specified priority.
    • Parameters:
      • priority — The priority of this log message.
      • message — string to write in the log file
    • Reimplemented from log4cpp::Category.
  • void log4cpp::FixedContextCategory::addAppender (Appender & appender) [virtual] — For the moment this method does nothing.
    • Reimplemented from log4cpp::Category.
  • void log4cpp::FixedContextCategory::addAppender (Appender * appender) [virtual] — For the moment this method does nothing.
    • Reimplemented from log4cpp::Category.
  • void log4cpp::FixedContextCategory::callAppenders (const LoggingEvent & event) [virtual] — Call the appenders in the hierarchy starting at this. If no appenders could be found, emit a warning.
    • This method always calls all the appenders inherited form the hierracy circumventing any evaluation of whether to log or not to log the particular log request.
    • Parameters:
      • event — The LoggingEvent to log.
    • Reimplemented from log4cpp::Category.
  • bool log4cpp::FixedContextCategory::getAdditivity () const [virtual] — Returns the additivity flag for this Category instance.
    • Reimplemented from log4cpp::Category.
  • AppenderSet log4cpp::FixedContextCategory::getAllAppenders () const [virtual] — Returns the set of Appenders currently attached to this Catogory.
    • Since: 0.3.1
    • Returns: The set of attached Appenders.
    • Reimplemented from log4cpp::Category.
  • Appender * log4cpp::FixedContextCategory::getAppender () const [virtual] — Returns the Appender for this Category, or NULL if no Appender has been set.
    • Returns: The Appender.
    • Reimplemented from log4cpp::Category.
  • Appender * log4cpp::FixedContextCategory::getAppender (const std::string & name) const [virtual] — Returns the specified Appender for this Category, or NULL if the Appender is not attached to this Category.
    • Since: 0.2.7
    • Returns: The Appender.
    • Reimplemented from log4cpp::Category.
  • Priority::Value log4cpp::FixedContextCategory::getChainedPriority () const [virtual] — Starting from this Category, search the category hierarchy for a set priority and return it. Otherwise, return the priority of the root category.
    • The Category class is designed so that this method executes as quickly as possible.
    • Reimplemented from log4cpp::Category.
  • std::string log4cpp::FixedContextCategory::getContext () const [virtual] — Return the context string used as NDC.
    • Returns: the context string.
  • Priority::Value log4cpp::FixedContextCategory::getPriority () const [virtual] — Returns the assigned Priority, if any, for this Category.
    • Returns: Priority — the assigned Priority, can be Priority::NOTSET
    • Reimplemented from log4cpp::Category.
  • bool log4cpp::FixedContextCategory::ownsAppender () const [virtual] — FixedContextAppenders cannot own Appenders.
    • Returns: false
    • Reimplemented from log4cpp::Category.
  • bool log4cpp::FixedContextCategory::ownsAppender (Appender * appender) const [virtual] — FixedContextAppenders cannot own Appenders.
    • Returns: false
    • Reimplemented from log4cpp::Category.
  • void log4cpp::FixedContextCategory::removeAllAppenders () [virtual] — Removes all appenders set for this Category. Currently a Category can have only one appender, but this may change in the future.
    • Reimplemented from log4cpp::Category.
  • void log4cpp::FixedContextCategory::setAdditivity (bool additivity) [virtual] — Set the additivity flag for this Category instance.
    • Reimplemented from log4cpp::Category.
  • void log4cpp::FixedContextCategory::setContext (const std::string & context) [virtual] — Set the context string used as NDC.
    • Parameters:
      • context — the context string

✨ Author ✨

Generated automatically by Doxygen for log4cpp from the source code.

and that's the whole member-function vibe check, bestie 💖 the source/version on this one is log4cpp Version 1.1, auto-generated by Doxygen, and there's no date on the footer so I'm not gonna invent one — periodt 🎀✨

📦 where this page comes from