AixLog

Classes

	Name
struct	AixLog::Conditional For Conditional logging of a log line.
struct	AixLog::Function Capture function, file and line number of the log line.
class	AixLog::Log Main Logger class with "Log::init".
struct	AixLog::Metadata Collection of a log line's meta data.
struct	AixLog::Sink Abstract log sink.
struct	AixLog::SinkCallback Forward log messages to a callback function.
struct	AixLog::SinkCerr Formatted logging to cerr.
struct	AixLog::SinkCout Formatted logging to cout.
struct	AixLog::SinkFile Formatted logging to file.
struct	AixLog::SinkFormat Abstract log sink with support for formatting log message.
struct	AixLog::SinkNative Log to the system's native sys logger.
struct	AixLog::SinkSyslog UNIX: Logging to syslog.
struct	AixLog::Tag Tag (string) for log line.
struct	AixLog::TextColor Encapsulation of foreground and background color.
struct	AixLog::Timestamp Timestamp of a log line.

Types

	Name
enum class std::int8_t	Severity { debug = SEVERITY::DEBUG, verbose = SEVERITY::VERBOSE, info = SEVERITY::INFO, config = SEVERITY::CONFIG, warning = SEVERITY::WARNING, error = SEVERITY::ERROR, critical = SEVERITY::CRITICAL} Severity of the log message.
enum class	Type { normal, special, all} Type of the log message or Sink.
enum class	Color { none = 0, NONE = 0, black = 1, BLACK = 1, red = 2, RED = 2, green = 3, GREEN = 3, yellow = 4, YELLOW = 4, blue = 5, BLUE = 5, magenta = 6, MAGENTA = 6, cyan = 7, CYAN = 7, white = 8, WHITE = 8} Color constants used for console colors.
using std::shared_ptr< Sink >	log_sink_ptr

Functions

	Name
std::ostream &	operator<<(std::ostream & os, const Severity & log_severity) ostream operators << for the meta data structs
std::ostream &	operator<<(std::ostream & os, const Type & log_type)
std::ostream &	operator<<(std::ostream & os, const Timestamp & timestamp)
std::ostream &	operator<<(std::ostream & os, const Tag & tag)
std::ostream &	operator<<(std::ostream & os, const Function & function)
std::ostream &	operator<<(std::ostream & os, const Conditional & conditional)
std::ostream &	operator<<(std::ostream & os, const Color & color)
std::ostream &	operator<<(std::ostream & os, const TextColor & text_color)

Types Documentation

enum Severity

Enumerator	Value	Description
debug	SEVERITY::DEBUG
verbose	SEVERITY::VERBOSE
info	SEVERITY::INFO
config	SEVERITY::CONFIG
warning	SEVERITY::WARNING
error	SEVERITY::ERROR
critical	SEVERITY::CRITICAL

Severity of the log message.

Mandatory parameter for the LOG macro

enum Type

Enumerator	Value	Description
normal
special
all

Type of the log message or Sink.

"normal" messages will be logged by "normal" or "all" Sinks "special" ones by "special" or "all" Sinks

enum Color

Enumerator	Value	Description
none	0
NONE	0
black	1
BLACK	1
red	2
RED	2
green	3
GREEN	3
yellow	4
YELLOW	4
blue	5
BLUE	5
magenta	6
MAGENTA	6
cyan	7
CYAN	7
white	8
WHITE	8

Color constants used for console colors.

using log_sink_ptr

using log_sink_ptr =  std::shared_ptr<Sink>;

Functions Documentation

function operator<<

static std::ostream & operator<<(
    std::ostream & os,
    const Severity & log_severity
)

ostream operators << for the meta data structs

ostream << operator for "Severity"

Severity must be the first thing that is logged into clog, since it will reset the loggers metadata.

function operator<<

static std::ostream & operator<<(
    std::ostream & os,
    const Type & log_type
)

function operator<<

static std::ostream & operator<<(
    std::ostream & os,
    const Timestamp & timestamp
)

function operator<<

static std::ostream & operator<<(
    std::ostream & os,
    const Tag & tag
)

function operator<<

static std::ostream & operator<<(
    std::ostream & os,
    const Function & function
)

function operator<<

static std::ostream & operator<<(
    std::ostream & os,
    const Conditional & conditional
)

function operator<<

static std::ostream & operator<<(
    std::ostream & os,
    const Color & color
)

function operator<<

static std::ostream & operator<<(
    std::ostream & os,
    const TextColor & text_color
)

---

Updated on 2023-11-29 at 18:22:22 +0000