A_UTILS_NS::log::IThreadLocalLogChannelStack Class Reference

#include <log.h>

Public Member Functions
virtual ILogChannel *	Top () const noexcept=0
virtual void	Push (ILogChannel *pLogChannel) noexcept=0
virtual void	Pop () noexcept=0
virtual tResult	Annotate (tResult oResult) const noexcept=0

Detailed Description

Class to inject a thread local log channel stack into a shared object. Implementations have to provide a separate stack of log channels for each thread that calls their member functions.

Member Function Documentation

Annotate()

virtual tResult A_UTILS_NS::log::IThreadLocalLogChannelStack::Annotate ( tResult oResult ) const

nodiscardpure virtualnoexcept

Annotate the given result with the context information of all log channels currently on the stack.

Parameters

[in]

oResult

The result that should be annotated.

Returns

The annotated result.

Pop()

virtual void A_UTILS_NS::log::IThreadLocalLogChannelStack::Pop ( )

pure virtualnoexcept

Pops one log channel from the stack.

Push()

virtual void A_UTILS_NS::log::IThreadLocalLogChannelStack::Push ( ILogChannel * pLogChannel )

pure virtualnoexcept

Pushes a log channel onto the stack.

Parameters

[in]

pLogChannel

The new top of the stack.

Top()

virtual ILogChannel * A_UTILS_NS::log::IThreadLocalLogChannelStack::Top ( ) const

pure virtualnoexcept

Returns

The current log channel on top of the stack or nullptr if the stack is empty.

---

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

• src/libraries/a_utils/include/a_utils/std/log.h