Description:

A logger that logs all messages to an in-memory buffer of type AString. The name of the Logger defaults to "MEMORY".

Definition at line 14 of file memorylogger.inl.

Inheritance diagram for alib::lox::loggers::MemoryLogger:

Public Field Index:
AString	MemoryLog
bool	UseWStringLengthForTabAdjustments =true
Public Field Index: inherited from alib::lox::textlogger::PlainTextLogger
bool	PruneESCSequences =true
Public Field Index: inherited from alib::lox::textlogger::TextLogger
ObjectConverter *	Converter = nullptr
TickConverter	DateConverter
bool	FormatWarningOnce =false
Public Field Index: inherited from alib::lox::detail::Logger
integer	CntLogs =0
time::Ticks	TimeOfCreation
	The creation time of the Logger.
time::Ticks	TimeOfLastLog
	Timestamp of the last log operation.
Public Field Index: inherited from alib::threads::RecursiveLock
DbgLockAsserter	Dbg
	The debug tool instance.

Public Method Index:
	MemoryLogger (const NString &name=nullptr, bool pruneESCSequences=true, bool useWStringLengthForTabAdjustments=true)
virtual	~MemoryLogger () override
	Destructs a MemoryLogger.
Public Method Index: inherited from alib::lox::textlogger::TextLogger
virtual	~TextLogger () override
	Destructs a TextLogger.
virtual void	AcknowledgeLox (detail::LoxImpl *lox, lang::ContainerOp op) override
virtual void	ClearReplacements ()
	Removes all pairs of searched strings and their replacement value.
FormatAutoSizes &	GetAutoSizes ()
FormatDateTime &	GetFormatDate ()
FormatMetaInfo &	GetFormatMetaInfo ()
FormatMultiLine &	GetFormatMultiLine ()
FormatOther &	GetFormatOther ()
FormatTimeDiff &	GetFormatTimeDiff ()
Replacements &	GetReplacements ()
virtual void	Log (detail::Domain &domain, Verbosity verbosity, BoxesMA &logables, detail::ScopeInfo &scope) override
virtual void	ResetAutoSizes ()
virtual void	SetReplacement (const String &searched, const String &replacement)
Public Method Index: inherited from alib::lox::detail::Logger
virtual	~Logger () override
	Destructs a logger.
const NString &	GetName () const
const NString &	GetTypeName () const
bool	SetVerbosityExport (Lox *lox, bool value, Priority priority=Priority::Standard)
Public Method Index: inherited from alib::threads::RecursiveLock
void	AcquireRecursive (ALIB_DBG_TAKE_CI)
virtual bool	DCSIsAcquired () const override
virtual bool	DCSIsSharedAcquired () const override
void	ReleaseRecursive (ALIB_DBG_TAKE_CI)
bool	TryAcquire (ALIB_DBG_TAKE_CI)
Public Method Index: inherited from alib::lang::DbgCriticalSections::AssociatedLock
virtual	~AssociatedLock ()
	Virtual Destructor.

Protected Method Index:
virtual integer	logPlainTextPart (const String &buffer, integer start, integer length) override
virtual void	notifyMultiLineOp (lang::Phase) override
	Empty implementation, not needed for this class.
virtual bool	notifyPlainTextLogOp (lang::Phase phase) override
Protected Method Index: inherited from alib::lox::textlogger::PlainTextLogger
	PlainTextLogger (const NString &name, const NString &typeName)
virtual	~PlainTextLogger () override
	Destructs a MemoryLogger.
virtual void	logText (detail::Domain &domain, Verbosity verbosity, AString &msg, detail::ScopeInfo &scope, int lineNumber, bool isRecursion) override
Protected Method Index: inherited from alib::lox::textlogger::TextLogger
	TextLogger (const NString &pName, const NString &typeName)
virtual void	processVariable (const NString &domainPath, Verbosity verbosity, detail::ScopeInfo &scope, AString &dest, Substring &variable)
virtual void	writeMetaInfo (AString &buffer, detail::Domain &domain, Verbosity verbosity, detail::ScopeInfo &scope)
virtual void	writeTimeDiff (AString &buffer, int64_t diffNanos)
Protected Method Index: inherited from alib::lox::detail::Logger
	Logger (const NString &name, const NString &typeName)

Additional Inherited Members
Protected Field Index: inherited from alib::lox::textlogger::TextLogger
strings::util::CalendarDateTime	callerDateTime
AString	logBuf
	The internal log Buffer.
AString	msgBuf
	The buffer for converting the logables.
Variable	varFormatAutoSizes
Variable	varFormatDateTime
Variable	varFormatMetaInfo
Variable	varFormatMultiLine
Variable	varFormatOther
Variable	varFormatTimeDiff
Variable	varReplacements
Protected Field Index: inherited from alib::lox::detail::Logger
NString32	Name
NString32	TypeName
Protected Field Index: inherited from alib::threads::RecursiveLock
std::recursive_mutex	mutex

Field Details:

◆ MemoryLog

AString alib::lox::loggers::MemoryLogger::MemoryLog

The logging Buffer. This can be accessed publicly and hence used quite freely. Especially, the whole log can easily be cleared using AString::Reset. In multithreaded environments, Lox interface's mutex should be acquired before accessing this buffer. The initial size of the buffer is 8kb.

Definition at line 25 of file memorylogger.inl.

◆ UseWStringLengthForTabAdjustments

bool alib::lox::loggers::MemoryLogger::UseWStringLengthForTabAdjustments =true

If this field is set to true (which is the default), the effective length of the messages when converted to wide character strings are taken into account.

Switching this off increases the overall logging performance (especially when logging into memory) significantly.

Definition at line 32 of file memorylogger.inl.

Constructor(s) / Destructor Details:

◆ MemoryLogger()

alib::lox::loggers::MemoryLogger::MemoryLogger	(	const NString &	name = nullptr,
		bool	pruneESCSequences = true,
		bool	useWStringLengthForTabAdjustments = true )

inlineexplicit

Creates a MemoryLogger with the given name.

Parameters

name	(Optional) The name of the Logger. Defaults to "MEMORY".
pruneESCSequences	(Optional) Sets the member PruneESCSequences. Defaults to `true`.
useWStringLengthForTabAdjustments	(Optional) Sets the member UseWStringLengthForTabAdjustments. Defaults to `true`.

Definition at line 45 of file memorylogger.inl.

◆ ~MemoryLogger()

virtual alib::lox::loggers::MemoryLogger::~MemoryLogger ( )

inlineoverridevirtual

Destructs a MemoryLogger.

Definition at line 56 of file memorylogger.inl.

Method Details:

◆ logPlainTextPart()

virtual integer alib::lox::loggers::MemoryLogger::logPlainTextPart	(	const String &	buffer,
		integer	start,
		integer	length )

inlineoverrideprotectedvirtual

Write the given region of the given AString to the destination buffer.

Parameters

buffer	The string to write a portion of.
start	The start of the portion in buffer to write out.
length	The length of the portion in buffer to write out.

Returns: The number of characters written, -1 on error.

Implements alib::lox::textlogger::PlainTextLogger.

Definition at line 79 of file memorylogger.inl.

◆ notifyMultiLineOp()

virtual void alib::lox::loggers::MemoryLogger::notifyMultiLineOp ( lang::Phase )

inlineoverrideprotectedvirtual

Empty implementation, not needed for this class.

Implements alib::lox::textlogger::TextLogger.

Definition at line 88 of file memorylogger.inl.

◆ notifyPlainTextLogOp()

virtual bool alib::lox::loggers::MemoryLogger::notifyPlainTextLogOp ( lang::Phase phase )

inlineoverrideprotectedvirtual

Start a new log line. Appends a new-line character sequence to previously logged lines.

Parameters

phase Indicates the beginning or end of a log line.

Returns: Always returns true.

Implements alib::lox::textlogger::PlainTextLogger.

Definition at line 66 of file memorylogger.inl.

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

memorylogger.inl

Description:

Public Field Index:

Public Method Index:

Protected Method Index:

Additional Inherited Members

Field Details:

◆ MemoryLog

◆ UseWStringLengthForTabAdjustments

Constructor(s) / Destructor Details:

◆ MemoryLogger()

◆ ~MemoryLogger()

Method Details:

◆ logPlainTextPart()

◆ notifyMultiLineOp()

◆ notifyPlainTextLogOp()