A high-level handle for logging operations. More...

#include <base_logger.h>

Inheritance diagram for CppTrail::BasicLogger< char_t >:

[legend]

Public Types
using	char_type = typename BasicLoggerImpl< char_t >::char_type
	Alias for the underlying character type used by this logger.

using	string_type = typename BasicLoggerImpl< char_t >::string_type
	Alias for the basic_string type associated with this logger's encoding.

using	message_type = typename BasicLoggerImpl< char_t >::message_type
	Alias for the BasicMessage type associated to the logger.

using	string_view_type = typename BasicLoggerImpl< char_t >::string_view_type
	Alias for the basic_string_view type associated with this logger's encoding.

Public Member Functions
	BasicLogger (nullptr_t)=delete
	Prevents construction from a null pointer.

	BasicLogger (const BasicLogger &pLogger)=default
	Copy constructor (defaults to shared ownership).

	BasicLogger (BasicLogger &&pLogger)=default
	Move constructor.

BasicLogger &	operator= (const BasicLogger &pLogger)=default
	Assignment operator.

BasicLogger &	operator= (BasicLogger &&pLogger)=default
	Assignment operator.

void	start ()
	Starts the underlying logging service.

void	stop ()
	Performs a synchronous shutdown of the logger.

void	signalStop ()
	Initiates an asynchronous shutdown request.

void	join ()
	Blocks until the asynchronous shutdown sequence is complete.

Status	status ()
	Retrieves the current operational status of the logger.

Primary Logging Interface
BasicLogger &	log (message_type oMessage)
	Submits a pre-constructed message object to the logger.

BasicLogger &	log (const Level nLevel, string_type sMessage)
	Logs a message with a specific severity level.

BasicLogger &	log (string_type sLevel, string_type sMessage)
	Logs a message with a custom string-based level.

Convenience Severity Wrappers
BasicLogger &	success (string_type sMessage)
	Submits a SUCCESS level log message.

BasicLogger &	trace (string_type sMessage)
	Submits a TRACE level log message.

BasicLogger &	debug (string_type sMessage)
	Submits a DEBUG level log message.

BasicLogger &	info (string_type sMessage)
	Submits an INFO level log message.

BasicLogger &	message (string_type sMessage)
	Submits a MESSAGE level log message.

BasicLogger &	warning (string_type sMessage)
	Submits a WARNING level log message.

BasicLogger &	error (string_type sMessage)
	Submits an ERROR level log message.

BasicLogger &	critical (string_type sMessage)
	Submits a CRITICAL level log message.

BasicLogger &	fatal (string_type sMessage)
	Submits a FATAL level log message.

BasicLogger &	success (string_view_type sMsg)
	Success wrapper for string views.

BasicLogger &	trace (string_view_type sMsg)
	Trace wrapper for string views.

BasicLogger &	debug (string_view_type sMsg)
	Debug wrapper for string views.

BasicLogger &	info (string_view_type sMsg)
	Info wrapper for string views.

BasicLogger &	message (string_view_type sMsg)
	Message wrapper for string views.

BasicLogger &	warning (string_view_type sMsg)
	Warning wrapper for string views.

BasicLogger &	error (string_view_type sMsg)
	Error wrapper for string views.

BasicLogger &	critical (string_view_type sMsg)
	Critical wrapper for string views.

BasicLogger &	fatal (string_view_type sMsg)
	Fatal wrapper for string views.

BasicLogger &	success (const char_t *sMsg)
	Success wrapper for string litterals.

BasicLogger &	trace (const char_t *sMsg)
	Trace wrapper for string litterals.

BasicLogger &	debug (const char_t *sMsg)
	Debug wrapper for string litterals.

BasicLogger &	info (const char_t *sMsg)
	Info wrapper for string litterals.

BasicLogger &	message (const char_t *sMsg)
	Message wrapper for string litterals.

BasicLogger &	warning (const char_t *sMsg)
	Warning wrapper for string litterals.

BasicLogger &	error (const char_t *sMsg)
	Error wrapper for string litterals.

BasicLogger &	critical (const char_t *sMsg)
	Critical wrapper for string litterals.

BasicLogger &	fatal (const char_t *sMsg)
	Fatal wrapper for string litterals.

String View Overloads (C++17)
BasicLogger &	log (const Level nLevel, string_view_type sMessage)
	Logs a message view with a specific severity level.

BasicLogger &	log (string_type sLevel, string_view_type sMessage)
	Logs a message view with a custom string level.

BasicLogger &	log (const Level nLevel, const char_t *sMessage)
	Logs a message view with a specific severity level.

BasicLogger &	log (string_type sLevel, const char_t *sMessage)
	Logs a message view with a custom string level.

Exception Overloads
template<typename T = char_t, typename std::enable_if< std::is_same< T, char >::value, int >::type = 0>
BasicLogger &	log (const std::exception &oException)
	Logs an exception with the default ERROR level.

template<typename T = char_t, typename std::enable_if< std::is_same< T, char >::value, int >::type = 0>
BasicLogger &	log (const Level nLevel, const std::exception &oException)
	Logs an exception with a specific severity level.

template<typename T = char_t, typename std::enable_if< std::is_same< T, char >::value, int >::type = 0>
BasicLogger &	log (string_type sLevel, const std::exception &oException)
	Logs an exception with a custom string level.

Protected Member Functions
	BasicLogger (std::shared_ptr< BasicLoggerImpl< char_t > > pLogger)
	Protected constructor for derived factories.

	~BasicLogger ()
	Destructor that ensures a graceful shutdown of the logger.

Detailed Description

template<typename char_t>
class CppTrail::BasicLogger< char_t >

A high-level handle for logging operations.

BasicLogger uses a pImpl-like approach via std::shared_ptr to manage a BasicLoggerImpl. It provides a flexible API including method chaining, exception handling, and operator overloading.

Template Parameters

char_t The character type (e.g., char, char8_t) used for logging.

Warning: All information needs to be managed by the underlying BasicLoggerImpl. Any form of extension over this class must be immune to object splicing.

Constructor & Destructor Documentation

◆ BasicLogger()

template<typename char_t >

CppTrail::BasicLogger< char_t >::BasicLogger ( std::shared_ptr< BasicLoggerImpl< char_t > > pLogger )

inlineprotected

Protected constructor for derived factories.

Parameters

pLogger A shared pointer to a concrete implementation.

◆ ~BasicLogger()

template<typename char_t >

CppTrail::BasicLogger< char_t >::~BasicLogger ( )

inlineprotected

Destructor that ensures a graceful shutdown of the logger.

BasicLogger follows an RAII (Resource Acquisition Is Initialization) pattern. If this specific instance is the last remaining handle (use_count == 1) to the underlying implementation, it will automatically call stop() and join() to ensure all pending logs are processed and resources are freed before the implementation is destroyed.

Note: If other copies of this BasicLogger exist, the destructor will simply decrement the shared reference count without stopping the service.

Member Function Documentation

◆ critical() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::critical ( const char_t * sMsg )

inline

Critical wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ critical() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::critical ( string_type sMessage )

inline

Submits a CRITICAL level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ critical() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::critical ( string_view_type sMsg )

inline

Critical wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ debug() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::debug ( const char_t * sMsg )

inline

Debug wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ debug() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::debug ( string_type sMessage )

inline

Submits a DEBUG level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ debug() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::debug ( string_view_type sMsg )

inline

Debug wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ error() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::error ( const char_t * sMsg )

inline

Error wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ error() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::error ( string_type sMessage )

inline

Submits an ERROR level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ error() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::error ( string_view_type sMsg )

inline

Error wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ fatal() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::fatal ( const char_t * sMsg )

inline

Fatal wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ fatal() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::fatal ( string_type sMessage )

inline

Submits a FATAL level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ fatal() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::fatal ( string_view_type sMsg )

inline

Fatal wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ info() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::info ( const char_t * sMsg )

inline

Info wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ info() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::info ( string_type sMessage )

inline

Submits an INFO level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ info() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::info ( string_view_type sMsg )

inline

Info wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ join()

template<typename char_t >

void CppTrail::BasicLogger< char_t >::join ( )

inline

Blocks until the asynchronous shutdown sequence is complete.

This method safely checks if the underlying implementation is an asynchronous type via dynamic_cast. If it is, it waits for background threads to finish. For synchronous loggers, this is a no-op.

◆ log() [1/10]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::log	(	const Level	nLevel,
		const char_t *	sMessage
	)

inline

Logs a message view with a specific severity level.

Parameters

nLevel	The severity level.
sMessage	The string litteral to log.

Returns: BasicLogger& A reference to this logger.

◆ log() [2/10]

template<typename char_t >

template<typename T = char_t, typename std::enable_if< std::is_same< T, char >::value, int >::type = 0>

BasicLogger & CppTrail::BasicLogger< char_t >::log	(	const Level	nLevel,
		const std::exception &	oException
	)

inline

Logs an exception with a specific severity level.

Template Parameters

T	Internal type for SFINAE check.

Parameters

nLevel	The severity level.
oException	The exception object.

Returns: BasicLogger& A reference to this logger.

Note: Only available for char-based loggers.

◆ log() [3/10]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::log	(	const Level	nLevel,
		string_type	sMessage
	)

inline

Logs a message with a specific severity level.

Parameters

nLevel	The severity level (from the Level enum).
sMessage	The string content of the log.

Returns: BasicLogger& A reference to this logger to allow method chaining.

◆ log() [4/10]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::log	(	const Level	nLevel,
		string_view_type	sMessage
	)

inline

Logs a message view with a specific severity level.

Parameters

nLevel	The severity level.
sMessage	The string view to log.

Returns: BasicLogger& A reference to this logger.

◆ log() [5/10]

template<typename char_t >

template<typename T = char_t, typename std::enable_if< std::is_same< T, char >::value, int >::type = 0>

BasicLogger & CppTrail::BasicLogger< char_t >::log ( const std::exception & oException )

inline

Logs an exception with the default ERROR level.

Template Parameters

T	Internal type for SFINAE check.

Parameters

oException The exception object.

Returns: BasicLogger& A reference to this logger.

Note: Only available for char-based loggers.

◆ log() [6/10]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::log ( message_type oMessage )

inline

Submits a pre-constructed message object to the logger.

Parameters

oMessage The message implementation to be processed.

Returns: BasicLogger& A reference to this logger to allow method chaining.

◆ log() [7/10]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::log	(	string_type	sLevel,
		const char_t *	sMessage
	)

inline

Logs a message view with a custom string level.

Parameters

sLevel	The custom level name.
sMessage	The string litteral to log.

Returns: BasicLogger& A reference to this logger.

◆ log() [8/10]

template<typename char_t >

template<typename T = char_t, typename std::enable_if< std::is_same< T, char >::value, int >::type = 0>

BasicLogger & CppTrail::BasicLogger< char_t >::log	(	string_type	sLevel,
		const std::exception &	oException
	)

inline

Logs an exception with a custom string level.

Template Parameters

T	Internal type for SFINAE check.

Parameters

sLevel	The custom level name.
oException	The exception object.

Returns: BasicLogger& A reference to this logger.

Note: Only available for char-based loggers.

◆ log() [9/10]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::log	(	string_type	sLevel,
		string_type	sMessage
	)

inline

Logs a message with a custom string-based level.

Parameters

sLevel	A custom string to represent the log category or level.
sMessage	The string content of the log.

Returns: BasicLogger& A reference to this logger to allow method chaining.

◆ log() [10/10]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::log	(	string_type	sLevel,
		string_view_type	sMessage
	)

inline

Logs a message view with a custom string level.

Parameters

sLevel	The custom level name.
sMessage	The string view to log.

Returns: BasicLogger& A reference to this logger.

◆ message() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::message ( const char_t * sMsg )

inline

Message wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ message() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::message ( string_type sMessage )

inline

Submits a MESSAGE level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ message() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::message ( string_view_type sMsg )

inline

Message wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ signalStop()

template<typename char_t >

void CppTrail::BasicLogger< char_t >::signalStop ( )

inline

Initiates an asynchronous shutdown request.

Signals the logger to begin closing, allowing the calling thread to continue execution immediately. Use join() later to ensure completion.

◆ start()

template<typename char_t >

void CppTrail::BasicLogger< char_t >::start ( )

inline

Starts the underlying logging service.

Depending on the implementation, this may initialize resources, open files, or spawn background worker threads.

◆ status()

template<typename char_t >

Status CppTrail::BasicLogger< char_t >::status ( )

inline

Retrieves the current operational status of the logger.

Returns: The current Status (e.g., STARTING, RUNNING, STOPPED, etc.).

◆ stop()

template<typename char_t >

void CppTrail::BasicLogger< char_t >::stop ( )

inline

Performs a synchronous shutdown of the logger.

This method triggers the stop sequence and waits until the service has fully terminated and all resources are released.

◆ success() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::success ( const char_t * sMsg )

inline

Success wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ success() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::success ( string_type sMessage )

inline

Submits a SUCCESS level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ success() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::success ( string_view_type sMsg )

inline

Success wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ trace() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::trace ( const char_t * sMsg )

inline

Trace wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ trace() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::trace ( string_type sMessage )

inline

Submits a TRACE level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ trace() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::trace ( string_view_type sMsg )

inline

Trace wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ warning() [1/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::warning ( const char_t * sMsg )

inline

Warning wrapper for string litterals.

Parameters

sMsg	Message view.

Returns: Logger reference.

◆ warning() [2/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::warning ( string_type sMessage )

inline

Submits a WARNING level log message.

Parameters

sMessage The message content.

Returns: BasicLogger& A reference to this logger.

◆ warning() [3/3]

template<typename char_t >

BasicLogger & CppTrail::BasicLogger< char_t >::warning ( string_view_type sMsg )

inline

Warning wrapper for string views.

Parameters

sMsg	Message view.

Returns: Logger reference.

The documentation for this class was generated from the following file:

/home/runner/work/cpptrail/cpptrail/include/cpptrail/base_logger.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BasicLogger()

◆ ~BasicLogger()

Member Function Documentation

◆ critical() [1/3]

◆ critical() [2/3]

◆ critical() [3/3]

◆ debug() [1/3]

◆ debug() [2/3]

◆ debug() [3/3]

◆ error() [1/3]

◆ error() [2/3]

◆ error() [3/3]

◆ fatal() [1/3]

◆ fatal() [2/3]

◆ fatal() [3/3]

◆ info() [1/3]

◆ info() [2/3]

◆ info() [3/3]

◆ join()

◆ log() [1/10]

◆ log() [2/10]

◆ log() [3/10]

◆ log() [4/10]

◆ log() [5/10]

◆ log() [6/10]

◆ log() [7/10]

◆ log() [8/10]

◆ log() [9/10]

◆ log() [10/10]

◆ message() [1/3]

◆ message() [2/3]

◆ message() [3/3]

◆ signalStop()

◆ start()

◆ status()

◆ stop()

◆ success() [1/3]

◆ success() [2/3]

◆ success() [3/3]

◆ trace() [1/3]

◆ trace() [2/3]

◆ trace() [3/3]

◆ warning() [1/3]

◆ warning() [2/3]

◆ warning() [3/3]