msgpack_rpc::logging Namespace Reference

Namespace of logging. More...

Namespaces
namespace	impl
	Namespace of internal implementations.

Classes
class	ILogSink
	Interface of log sinks to write logs. More...
class	Logger
	Class to write logs. More...
class	SourceLocationView
	Class of locations in source codes. More...

Enumerations
enum class	LogLevel : std::uint8_t {   TRACE , DEBUG , INFO , WARN ,   ERROR , CRITICAL }
	Enumeration of log levels. More...

Functions
std::shared_ptr< ILogSink >	create_log_sink_from_config (const config::LoggingConfig &config)
	Create a log sink from a configuration.
std::shared_ptr< ILogSink >	create_rotating_file_log_sink (std::string_view file_path, std::size_t max_file_size, std::size_t max_files)
	Create a log sink to write to a file with rotation.
std::shared_ptr< ILogSink >	create_stdout_log_sink ()
	Create a log sink to write to standard output.
std::shared_ptr< ILogSink >	create_stdout_log_sink_impl ()
	Create a log sink to write to standard output.

Detailed Description

Namespace of logging.

Enumeration Type Documentation

LogLevel

enum class msgpack_rpc::logging::LogLevel : std::uint8_t

strong

Enumeration of log levels.

Enumerator
TRACE	Trace. (Internal operations to send and receive messages.)
DEBUG	Debug. (Log of messages, initialization and finalization of clients and servers.)
INFO	Information. (Not used in this library.)
WARN	Warnings. (Unexpected conditions which don't stop operations.)
ERROR	Error. (Unexpected conditions which stop some operations in communication.)
CRITICAL	Critical. (Unexpected conditions which can stop all operations in communication.)

Definition at line 29 of file log_level.h.

Function Documentation

create_log_sink_from_config()

std::shared_ptr< ILogSink > msgpack_rpc::logging::create_log_sink_from_config ( const config::LoggingConfig & config )

nodiscard

Create a log sink from a configuration.

Parameters

[in]

config

Configuration of logging.

Returns

Log sink.

Definition at line 66 of file log_sinks.cpp.

create_rotating_file_log_sink()

std::shared_ptr< ILogSink > msgpack_rpc::logging::create_rotating_file_log_sink ( std::string_view file_path, std::size_t max_file_size, std::size_t max_files )

nodiscard

Create a log sink to write to a file with rotation.

Parameters

[in]	file_path	File path.
[in]	max_file_size	Maximum size of a file.
[in]	max_files	Maximum number of files.

Returns

Log sink.

Definition at line 55 of file log_sinks.cpp.

create_stdout_log_sink()

std::shared_ptr< ILogSink > msgpack_rpc::logging::create_stdout_log_sink ( )

nodiscard

Create a log sink to write to standard output.

Returns

Log sink.

Definition at line 50 of file log_sinks.cpp.

create_stdout_log_sink_impl()

std::shared_ptr< ILogSink > msgpack_rpc::logging::create_stdout_log_sink_impl

(

)

Create a log sink to write to standard output.

Returns

Log sink.

Definition at line 42 of file log_sinks.cpp.