log4cpp(3)

πŸ“¦
version 1.1.4 Β· 5 versions
, in opensuse-leap 16.0

πŸ’– NAME πŸ’–

Okay bestie, this is log4cpp(3) β€” the Library Functions Manual page for log4cpp β€” and it's literally the top level namespace for all 'Log for C++' types and classes. That's the whole name vibe. Periodt. ✨


✨ SYNOPSIS ✨

Here's the cast list, the function menu, and the static-variable lore. Buckle up. πŸŽ€

🧚 Namespaces

  • details β€” listed, no extra description on the page.
  • threading β€” also listed, also no extra description.

πŸ‘‘ Classes

  • class AbortAppender β€” this appender causes the application to call abort() on the first append() call. It's giving "no thoughts, just termination." πŸ’€
  • class Appender β€” implement this interface for your own strategies for printing log statements.
  • class AppendersFactory β€” no description on the page; it's just listed.
  • class AppenderSkeleton β€” helper class simplifying implementation of Appenders: it already takes care of handling Thresholds and Filters.
  • class BasicConfigurator β€” implements a trivial default configuration for log4cpp: it adds a FileAppender that logs to stdout and uses a BasicLayout to the root Category.
  • class BasicLayout β€” a simple fixed format Layout implementation.
  • class BufferingAppender β€” no description on the page.
  • class Category β€” the central class in the log4j package. (Yes, it says log4j. Preserve the lore.)
  • struct CategoryNameComponent β€” no description on the page.
  • class CategoryStream β€” enables streaming simple types and objects to a category.
  • class ConfigureFailure β€” exception class for configuration.
  • class DailyRollingFileAppender β€” a FileAppender that rolls over the logfile once the next day starts.
  • class FactoryParams β€” no description on the page.
  • class FileAppender β€” no description on the page.
  • class Filter β€” users should extend this class to implement customized logging event filtering.
  • class FixedContextCategory β€” this Category subclass replaces the NDC field in LoggingEvents with a fixed context string.
  • struct FormatModifierComponent β€” no description on the page.
  • class HierarchyMaintainer β€” an internal log4cpp class.
  • class IdsaAppender β€” an Appender that sends LoggingEvents to the IDS/A logger and reference monitor by Marc Welz.
  • class Layout β€” extend this abstract class to create your own log layout format.
  • class LayoutAppender β€” common superclass for all Appenders that require a Layout.
  • class LayoutsFactory β€” no description on the page.
  • class LevelEvaluator β€” no description on the page.
  • struct LoggingEvent β€” the internal representation of logging events.
  • struct MessageComponent β€” no description on the page.
  • struct MillisSinceEpochComponent β€” no description on the page.
  • class NDC β€” implements nested diagnostic contexts as defined by Neil Harrison in the article PatternsforLoggingDiagnosticMessages, part of the book Pattern Languages ofProgram Design 3 edited by Martin et al.
  • struct NDCComponent β€” no description on the page.
  • class NTEventLogAppender β€” an Appender that sends LoggingEvents to the Windows event log.
  • class OstreamAppender β€” appends LoggingEvents to ostreams.
  • class PassThroughLayout β€” no description on the page.
  • class PatternLayout β€” a simple fixed format Layout implementation.
  • class Priority β€” provides importance levels with which one can categorize log messages.
  • struct PriorityComponent β€” no description on the page.
  • struct ProcessorTimeComponent β€” no description on the page.
  • class Properties β€” no description on the page.
  • class PropertyConfigurator β€” property configurator will read a config file using the same (or similar) format to the config file used by log4j.
  • class PropertyConfiguratorImpl β€” no description on the page.
  • class RemoteSyslogAppender β€” sends LoggingEvents to a remote syslog system.
  • class RollingFileAppender β€” a FileAppender that rolls over the logfile once it has reached a certain size limit.
  • struct SecondsSinceEpochComponent β€” no description on the page.
  • class SimpleConfigurator β€” implements a simple Configurator for log4cpp.
  • class SimpleLayout β€” the page's one-liner is literally "BasicLayout is a simple fixed format Layout implementation." Keep that exactly, bestie.
  • struct StringLiteralComponent β€” no description on the page.
  • class StringQueueAppender β€” this class puts log messages in an in-memory queue.
  • class StringUtil β€” no description on the page.
  • class SyslogAppender β€” sends LoggingEvents to the local syslog system.
  • class tab β€” class listed, no description. Lowercase icon behavior. πŸŽ€
  • struct ThreadNameComponent β€” no description on the page.
  • class TimeStamp β€” a simple TimeStamp abstraction.
  • struct TimeStampComponent β€” no description on the page.
  • class TriggeringEventEvaluator β€” no description on the page.
  • class TriggeringEventEvaluatorFactory β€” no description on the page.
  • class width β€” class listed, no description. Lowercase icon behavior. πŸ¦‹
  • class Win32DebugAppender β€” simply sends the log message to the default system debugger on Win32 systems.

πŸ¦‹ Typedefs

  • typedef std::set< Appender * > AppenderSet β€” the one typedef in the synopsis. That's it, that's the set.

🌸 Functions

  • LOG4CPP_EXPORT CategoryStream & eol (CategoryStream &os) β€” eol manipulator.
  • LOG4CPP_EXPORT CategoryStream & left (CategoryStream &os) β€” left manipulator.
  • std::LOG4CPP_UNIQUE_PTR< Appender > create_abort_appender (const FactoryParams &params)
  • std::auto_ptr< Appender > create_file_appender (const FactoryParams &)
  • std::auto_ptr< Appender > create_roll_file_appender (const FactoryParams &)
  • std::auto_ptr< Appender > create_daily_roll_file_appender (const FactoryParams &)
  • std::auto_ptr< Appender > create_idsa_appender (const FactoryParams &)
  • std::auto_ptr< Appender > create_nt_event_log_appender (const FactoryParams &)
  • std::auto_ptr< Appender > create_remote_syslog_appender (const FactoryParams &)
  • std::auto_ptr< Appender > create_syslog_appender (const FactoryParams &)
  • std::auto_ptr< Appender > create_win32_debug_appender (const FactoryParams &)
  • std::auto_ptr< Appender > create_smtp_appender (const FactoryParams &)
  • std::LOG4CPP_UNIQUE_PTR< Layout > create_basic_layout (const FactoryParams &params)
  • std::auto_ptr< Layout > create_simple_layout (const FactoryParams &params)
  • std::auto_ptr< Layout > create_pattern_layout (const FactoryParams &params)
  • std::auto_ptr< Layout > create_pass_through_layout (const FactoryParams &params)
  • std::LOG4CPP_UNIQUE_PTR< TriggeringEventEvaluator > create_level_evaluator (const FactoryParams &params)
  • void localtime (const ::time_t *time, ::tm *t)
  • ostream & operator<< (ostream &os, const width &w)
  • ostream & operator<< (ostream &os, const tab &t)
  • template<typename T> const T & min (const T &a, const T &b)
  • template<typename T> const T & max (const T &a, const T &b)

πŸ’… Variables

  • class LOG4CPP_EXPORT Filter
  • static Appender::AppenderMapStorageInitializer appenderMapStorageInitializer
  • class LOG4CPP_EXPORT Category
  • class LOG4CPP_EXPORT CategoryStream
  • static int appenders_nifty_counter
  • static char appenderMapStorage_buf [sizeof(Appender::AppenderMapStorage)]
  • static AppendersFactory * appenders_factory_ = 0
  • static const std::string EMPTY
  • static LayoutsFactory * layouts_factory_ = 0
  • static TriggeringEventEvaluatorFactory * evaluators_factory_ = 0

🌈 Detailed Description 🌈

The detailed description, no cap, is the same top-level namespace truth: log4cpp is the top level namespace for all 'Log for C++' types and classes. That's the whole detailed section, and honestly it ate. πŸ’œ


πŸŽ€ Typedef Documentation πŸŽ€

  • typedef std::set<Appender *> log4cpp::AppenderSet β€” this is the typedef documentation entry, spelled exactly like that on the page.

πŸ”₯ Function Documentation πŸ”₯

Every signature stays exactly as written, bestie. 🫢
  • std::auto_ptr< Appender > log4cpp::create_abort_appender (const FactoryParams & params)
  • std::auto_ptr< Layout > log4cpp::create_basic_layout (const FactoryParams & params)
  • std::LOG4CPP_UNIQUE_PTR< Appender > log4cpp::create_daily_roll_file_appender (const FactoryParams & params)
  • std::LOG4CPP_UNIQUE_PTR< Appender > log4cpp::create_file_appender (const FactoryParams & params)
  • std::auto_ptr< Appender > log4cpp::create_idsa_appender (const FactoryParams & )
  • std::auto_ptr< TriggeringEventEvaluator > log4cpp::create_level_evaluator (const FactoryParams & params)
  • std::LOG4CPP_UNIQUE_PTR< Appender > log4cpp::create_nt_event_log_appender (const FactoryParams & params)
  • std::LOG4CPP_UNIQUE_PTR< Layout > log4cpp::create_pass_through_layout (const FactoryParams & params)
  • std::LOG4CPP_UNIQUE_PTR< Layout > log4cpp::create_pattern_layout (const FactoryParams & params)
  • std::LOG4CPP_UNIQUE_PTR< Appender > log4cpp::create_remote_syslog_appender (const FactoryParams & params)
  • std::LOG4CPP_UNIQUE_PTR< Appender > log4cpp::create_roll_file_appender (const FactoryParams & params)
  • std::LOG4CPP_UNIQUE_PTR< Layout > log4cpp::create_simple_layout (const FactoryParams & params)
  • std::auto_ptr< Appender > log4cpp::create_smtp_appender (const FactoryParams & )
  • std::auto_ptr< Appender > log4cpp::create_syslog_appender (const FactoryParams & )
  • std::LOG4CPP_UNIQUE_PTR< Appender > log4cpp::create_win32_debug_appender (const FactoryParams & params)
  • CategoryStream & log4cpp::eol (CategoryStream & os) β€” eol manipulator.
  • CategoryStream & log4cpp::left (CategoryStream & os) β€” left manipulator.
  • void log4cpp::localtime (const ::time_t * time, ::tm * t)
  • template<typename T> const T & log4cpp::max (const T & a, const T & b)
  • template<typename T> const T & log4cpp::min (const T & a, const T & b)
  • ostream & log4cpp::operator<< (ostream & os, const tab & t)
  • ostream & log4cpp::operator<< (ostream & os, const width & w)

πŸ’€ Variable Documentation πŸ’€

  • char log4cpp::appenderMapStorage_buf[sizeof(Appender::AppenderMapStorage)] [static]
  • Appender::AppenderMapStorageInitializer log4cpp::appenderMapStorageInitializer [static]
  • AppendersFactory* log4cpp::appenders_factory_ = 0 [static]
  • int log4cpp::appenders_nifty_counter [static]
  • class LOG4CPP_EXPORT log4cpp::Category
  • class LOG4CPP_EXPORT log4cpp::CategoryStream
  • const std::string log4cpp::EMPTY [static]
  • TriggeringEventEvaluatorFactory* log4cpp::evaluators_factory_ = 0 [static]
  • class LOG4CPP_EXPORT log4cpp::Filter
  • LayoutsFactory* log4cpp::layouts_factory_ = 0 [static]

🌸 Author 🌸

Generated automatically by Doxygen for log4cpp from the source code. That's the author section, bestie. πŸ’…


Cute little sign-off: source/version is log4cpp, Version 1.1, and the footer also shows log4cpp(3) with the date slot blank in the original β€” so we're not inventing a date. Bye bestie, go log something iconic. πŸ’œβœ¨

πŸ“¦ where this page comes from