ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::lox::detail::LI Struct Reference

Description:

Struct that collects static functions that provide the implementation of methods of class Lox. For most; the first parameter is of type lox;detail::LoxImpl.

Definition at line 27 of file loxpimpl.inl.

Public Static Method Index:

static ALIB_DLL void Acquire (LoxImpl *impl, const lang::CallerInfo &ci)
 
static ALIB_DLL BoxesMAacquireInternalLogables (LoxImpl *impl)
 
static ALIB_DLL int checkScopeInformation (LoxImpl *impl, Scope &scope, const NString &internalDomain)
 
static ALIB_DLL LoxImpl * Construct (const NString &name)
 
static ALIB_DLL MonoAllocatorDbgGetMonoAllocator (LoxImpl *impl)
 
static ALIB_DLL void Destruct (LoxImpl *lox)
 
static ALIB_DLL void dumpStateOnLoggerRemoval (LoxImpl *impl)
 
static ALIB_DLL void Entry (LoxImpl *impl, const NString &domain, Verbosity verbosity)
 
static ALIB_DLL void entryDetectDomainImpl (LoxImpl *impl, Verbosity verbosity)
 
static ALIB_DLL detail::DomainevaluateResultDomain (LoxImpl *impl, const NString &domainPath)
 
static ALIB_DLL detail::DomainfindDomain (LoxImpl *impl, detail::Domain &domainSystem, NString domainPath)
 
static ALIB_DLL void getAllVerbosities (LoxImpl *impl, variables::Variable &variable, detail::Logger *logger, detail::Domain &dom)
 
static ALIB_DLL void getDomainPrefixFromConfig (LoxImpl *impl, detail::Domain &dom)
 
static ALIB_DLL threads::RecursiveLockgetLock (LoxImpl *impl)
 
static ALIB_DLL BoxesMAGetLogableContainer (LoxImpl *impl)
 
static ALIB_DLL integerGetLogCounter (LoxImpl *impl)
 
static ALIB_DLL detail::LoggerGetLogger (LoxImpl *impl, const NString &loggerName)
 
static ALIB_DLL const NStringGetName (LoxImpl *impl)
 
static ALIB_DLL void GetState (LoxImpl *impl, NAString &buf, StateInfo flags)
 
static ALIB_DLL void getVerbosityFromConfig (LoxImpl *impl, variables::Variable &variable, detail::Logger *logger, detail::Domain &dom)
 
static ALIB_DLL void IncreaseLogCounter (LoxImpl *impl)
 
static ALIB_DLL void init (LoxImpl *impl)
 
static ALIB_DLL int IsActive (LoxImpl *impl, Verbosity verbosity, const NString &domain)
 
static ALIB_DLL bool isThreadRelatedScope (LoxImpl *impl, Scope scope)
 
static ALIB_DLL void log (LoxImpl *impl, detail::Domain *dom, Verbosity verbosity, BoxesMA &logables, lang::Inclusion prefixes)
 
static ALIB_DLL void logInternal (LoxImpl *impl, Verbosity verbosity, const NString &subDomain, BoxesMA &msg)
 
static ALIB_DLL void logInternal (LoxImpl *impl, Verbosity verbosity, const NString &subDomain, const NString &msg)
 
static ALIB_DLL void MapThreadName (LoxImpl *impl, const String &threadName, threads::ThreadID id)
 
static ALIB_DLL void once (LoxImpl *impl, const NString &domain, Verbosity verbosity, const Box &logables, const String &pGroup, Scope scope, int quantity)
 
static ALIB_DLL void Release (LoxImpl *impl)
 
static ALIB_DLL detail::LoggerRemoveLogger (LoxImpl *impl, const NString &loggerName)
 
static ALIB_DLL bool RemoveLogger (LoxImpl *impl, detail::Logger *logger)
 
static ALIB_DLL void RemoveThreadDomain (LoxImpl *impl, const NString &scopeDomain, Scope scope, threads::Thread *thread)
 
static ALIB_DLL void Reset (LoxImpl *impl)
 
static ALIB_DLL Box retrieve (LoxImpl *impl, const NString &pKey, Scope scope)
 
static ALIB_DLL void SetDomain (LoxImpl *impl, const NString &scopeDomain, Scope scope, threads::Thread *thread)
 
static ALIB_DLL void setDomain (LoxImpl *impl, const NString &scopeDomain, Scope scope, bool removeNTRSD, threads::Thread *thread)
 
static ALIB_DLL void SetDomainSubstitutionRule (LoxImpl *impl, const NString &domainPath, const NString &replacement)
 
static ALIB_DLL void SetFileNameCacheCapacity (LoxImpl *impl, integer numberOfLists, integer entriesPerList)
 
static ALIB_DLL void SetPrefix (LoxImpl *impl, const Box &prefix, const NString &domain, lang::Inclusion otherPLs)
 
static ALIB_DLL void setPrefix (LoxImpl *impl, const Box &prefix, Scope scope, threads::Thread *thread)
 
static ALIB_DLL void SetSourcePathTrimRule (LoxImpl *impl, const NCString &path, lang::Inclusion includeString, int trimOffset, lang::Case sensitivity, const NString &trimReplacement, lang::Reach reach, Priority priority)
 
static ALIB_DLL void SetStartTime (LoxImpl *impl, const FILETIME &startTime, const NString &loggerName)
 
static ALIB_DLL void SetStartTime (LoxImpl *impl, Ticks startTime, const NString &loggerName)
 
static ALIB_DLL void SetStartTime (LoxImpl *impl, time_t startTime, const NString &loggerName)
 
static ALIB_DLL void SetVerbosity (LoxImpl *impl, const NString &loggerName, Verbosity verbosity, const NString &domain, Priority priority)
 
static ALIB_DLL void SetVerbosity (LoxImpl *impl, detail::Logger *logger, Verbosity verbosity, const NString &domain, Priority priority)
 
static ALIB_DLL void State (LoxImpl *impl, const NString &domain, Verbosity verbosity, const String &headLine, StateInfo flags)
 
static ALIB_DLL void store (LoxImpl *impl, const Box &data, const NString &pKey, Scope scope)
 
static ALIB_DLL void writeVerbositiesOnLoggerRemoval (LoxImpl *impl, Logger *logger)
 

Public Method Index:

ALIB_DLL void Reset ()
 

Method Details:

◆ Acquire()

ALIB_DLL void alib::lox::detail::LI::Acquire ( LoxImpl * impl,
const lang::CallerInfo & ci )
static

Implementation of method Lox::Acquire.

Parameters
implThe implementation struct of the Lox.
ciThe source location that the call is placed at. Usually macro ALIB_CALLER is passed here.

◆ acquireInternalLogables()

ALIB_DLL BoxesMA & alib::lox::detail::LI::acquireInternalLogables ( LoxImpl * impl)
static

Returns a reference to a list of boxes to be used by internal logging. Each invocation has to be followed by an invocation to logInternal which releases the logables.

Parameters
implThe implementation struct of the Lox.
Returns
A list of boxes.

◆ checkScopeInformation()

ALIB_DLL int alib::lox::detail::LI::checkScopeInformation ( LoxImpl * impl,
Scope & scope,
const NString & internalDomain )
static

Checks if given scope needs information that is not available. In addition, the in/out parameter scope is changed to Scope::Path, in case a level was added.

Parameters
implThe implementation struct of the Lox.
[in,out]scopeA reference to the scope that is to be checked (and eventually modified.
internalDomainThe internal subdomain to log any error/warning into.
Returns
A positive value providing the path level deduced from scope if all is fine, -1 else.

◆ Construct()

ALIB_DLL LoxImpl * alib::lox::detail::LI::Construct ( const NString & name)
static

Implementation of the constructor the constructor of class Lox.

Parameters
nameThe name of the Lox. Will be copied and converted to upper case.
Returns
The implementation for the calling Lox.

◆ DbgGetMonoAllocator()

ALIB_DLL MonoAllocator & alib::lox::detail::LI::DbgGetMonoAllocator ( LoxImpl * impl)
static

Implementation of method Lox::DbgGetMonoAllocator.

Parameters
implThe implementation struct of the Lox.
Returns
The monotonic allocator of this Lox.

◆ Destruct()

ALIB_DLL void alib::lox::detail::LI::Destruct ( LoxImpl * lox)
static

Destructs a lox.

Parameters
loxThe Lox that is to be destructed.

◆ dumpStateOnLoggerRemoval()

ALIB_DLL void alib::lox::detail::LI::dumpStateOnLoggerRemoval ( LoxImpl * impl)
static

Implements functionality for configuration variable LOXNAME_DUMP_STATE_ON_EXIT. Is called when a logger is removed.

Parameters
implThe implementation struct of the Lox.

◆ Entry()

ALIB_DLL void alib::lox::detail::LI::Entry ( LoxImpl * impl,
const NString & domain,
Verbosity verbosity )
static

Implementation of method Lox::Entry.

Parameters
implThe implementation struct of the Lox.
domainThe domain.
verbosityThe verbosity.

◆ entryDetectDomainImpl()

ALIB_DLL void alib::lox::detail::LI::entryDetectDomainImpl ( LoxImpl * impl,
Verbosity verbosity )
static

Implementation of method Lox::EntryDetectDomain.

Parameters
implThe implementation struct of the Lox.
verbosityThe verbosity.

◆ evaluateResultDomain()

ALIB_DLL detail::Domain * alib::lox::detail::LI::evaluateResultDomain ( LoxImpl * impl,
const NString & domainPath )
static

Assembles the resulting domain from the given domainPath and the Scope Domain paths (see SetDomain) according to the scope identified by scopeInfo. The resulting full domain string is assembled from inner to outer scope. If domainPath, respectively as soon as any of the Scope Domain's paths start with the character defined with Domain::Separator, the evaluation is stopped (the path is interpreted as absolute).

Parameters
implThe implementation struct of the Lox.
domainPathThe domain path. If starting with the character defined with Domain::Separator, no scope domains are applied.
Returns
The resulting Domain.

◆ findDomain()

ALIB_DLL detail::Domain * alib::lox::detail::LI::findDomain ( LoxImpl * impl,
detail::Domain & domainSystem,
NString domainPath )
static

Invokes Find on the given domain and logs internal message when the domain was not known before.

Parameters
implThe implementation struct of the Lox.
domainSystemThe domain system. Either the standard or the internal one.
domainPathThe domain path.
Returns
The resulting Domain.

◆ getAllVerbosities()

ALIB_DLL void alib::lox::detail::LI::getAllVerbosities ( LoxImpl * impl,
variables::Variable & variable,
detail::Logger * logger,
detail::Domain & dom )
static

Reads the verbosity for the given logger and domain from the ALib variable system. This internal method is used when a new logger is added. Walks recursively for all existing domains.

Parameters
implThe implementation struct of the Lox.
variableThe loaded variable with verbosity information.
loggerThe logger to set the verbosity for.
domThe domain to set the verbosity for.

◆ getDomainPrefixFromConfig()

ALIB_DLL void alib::lox::detail::LI::getDomainPrefixFromConfig ( LoxImpl * impl,
detail::Domain & dom )
static

Reads a prefix string from the ALib variable system. This internal method is used when a new domain is created,

Parameters
implThe implementation struct of the Lox.
domThe domain to set the verbosity for.

◆ getLock()

ALIB_DLL threads::RecursiveLock & alib::lox::detail::LI::getLock ( LoxImpl * impl)
static

Returns the internal lock.

Parameters
implThe implementation struct of the Lox.
Returns
The internal RecursiveLock of this Lox.

◆ GetLogableContainer()

ALIB_DLL BoxesMA & alib::lox::detail::LI::GetLogableContainer ( LoxImpl * impl)
static

Implementation of method Lox::GetLogableContainer.

Parameters
implThe implementation struct of the Lox.
Returns
An empty list of boxes.

◆ GetLogCounter()

ALIB_DLL integer & alib::lox::detail::LI::GetLogCounter ( LoxImpl * impl)
static

Implementation of method Lox::GetLogCounter.

Parameters
implThe implementation struct of the Lox.
Returns
The name of this Lox.

◆ GetLogger()

ALIB_DLL detail::Logger * alib::lox::detail::LI::GetLogger ( LoxImpl * impl,
const NString & loggerName )
static

Implementation of method Lox::GetLogger.

Parameters
implThe implementation struct of the Lox.
loggerNameThe name of the Logger to search for (case-insensitive).
Returns
The logger, nullptr if not found.

◆ GetName()

ALIB_DLL const NString & alib::lox::detail::LI::GetName ( LoxImpl * impl)
static

Implementation of method Lox::GetName.

Parameters
implThe implementation struct of the Lox.
Returns
The name of this Lox.

◆ GetState()

ALIB_DLL void alib::lox::detail::LI::GetState ( LoxImpl * impl,
NAString & buf,
StateInfo flags )
static

Implementation of method Lox::GetState.

Parameters
implThe implementation struct of the Lox.
bufThe target string.
flagsBits that define which state information is collected.

◆ getVerbosityFromConfig()

ALIB_DLL void alib::lox::detail::LI::getVerbosityFromConfig ( LoxImpl * impl,
variables::Variable & variable,
detail::Logger * logger,
detail::Domain & dom )
static

Reads the verbosity for the given logger and domain from the ALib variable system. This internal method is used in two occasions:

  • when a new logger is added: recursively for all existing domains (configStr is given)
  • when a new domain is created on the fly(configStr is not given)

The variable is already read and found in an internal instance.

Parameters
implThe implementation struct of the Lox.
variableThe loaded variable with verbosity information.
loggerThe logger to set the verbosity for.
domThe domain to set the verbosity for.

◆ IncreaseLogCounter()

ALIB_DLL void alib::lox::detail::LI::IncreaseLogCounter ( LoxImpl * impl)
static

Increases the internal log counter of impl.

Parameters
implThe implementation struct of the Lox.

◆ init()

ALIB_DLL void alib::lox::detail::LI::init ( LoxImpl * impl)
static

Used on construction and with Reset.

Parameters
implThe implementation struct of the Lox.

◆ IsActive()

ALIB_DLL int alib::lox::detail::LI::IsActive ( LoxImpl * impl,
Verbosity verbosity,
const NString & domain )
static

Implementation of method Lox::IsActive.

Parameters
implThe implementation struct of the Lox.
verbosityThe verbosity to query for activity.
domainThe log domain. All rules for resolving the effective log domain apply as with normal log statements.
Returns
The number of active loggers.

◆ isThreadRelatedScope()

ALIB_DLL bool alib::lox::detail::LI::isThreadRelatedScope ( LoxImpl * impl,
Scope scope )
static

Checks if given scope is thread-related.

Parameters
implThe implementation struct of the Lox.
scopeThe scope that is to be checked.
Returns
true if scope is thread-related, false else.

◆ log()

ALIB_DLL void alib::lox::detail::LI::log ( LoxImpl * impl,
detail::Domain * dom,
Verbosity verbosity,
BoxesMA & logables,
lang::Inclusion prefixes )
static

This method is looping over the Loggers, checking their verbosity against the given one, and, if they match, invoke the log method of the Logger. With the first logger identified to be active, the Prefix Objects get collected from the scope store.

Parameters
implThe implementation struct of the Lox.
domThe domain to log on
verbosityThe verbosity.
logablesThe objects to log.
prefixesDenotes if prefixes should be included or not.

◆ logInternal() [1/2]

ALIB_DLL void alib::lox::detail::LI::logInternal ( LoxImpl * impl,
Verbosity verbosity,
const NString & subDomain,
BoxesMA & msg )
static

Logs an internal error message using the internal domain tree as defined in Lox::InternalDomains.

Parameters
implThe implementation struct of the Lox.
verbosityThe verbosity.
subDomainThe subdomain of the internal domain to log into.
msgThe message.

◆ logInternal() [2/2]

ALIB_DLL void alib::lox::detail::LI::logInternal ( LoxImpl * impl,
Verbosity verbosity,
const NString & subDomain,
const NString & msg )
static

Overloaded version accepting a string to log.

Parameters
implThe implementation struct of the Lox.
verbosityThe verbosity.
subDomainThe subdomain of the internal domain to log into.
msgThe message.

◆ MapThreadName()

ALIB_DLL void alib::lox::detail::LI::MapThreadName ( LoxImpl * impl,
const String & threadName,
threads::ThreadID id )
static

Implementation of method Lox::MapThreadName.

Parameters
implThe implementation struct of the Lox.
threadNameThe name of the thread as it should be displayed in the logs.
idThe thread ID.

◆ once()

ALIB_DLL void alib::lox::detail::LI::once ( LoxImpl * impl,
const NString & domain,
Verbosity verbosity,
const Box & logables,
const String & pGroup,
Scope scope,
int quantity )
static

Internal method serving public interface Lox::Once.

Parameters
implThe implementation struct of the Lox.
domainOptional Log Domain which is combined with Scope Domains set for the Scope of invocation.
verbosityThe verbosity of the Log Statement (if performed).
logablesThe objects to log (Multiple objects may be provided within container class Boxes.)
pGroupThe optional name of the statement group. If used, all statements that share the same group name are working on the same counter (according to the scope.) If omitted (or empty or nullptr), the counter is bound to the Scope provided. If omitted and scope is Scope::Global, then the counter is associated exclusively with the single Log Statement itself.
scopeThe Scope that the group or counter is bound to.
quantityThe number of logs to be performed. As the name of the method indicates, this defaults to 1.

◆ Release()

ALIB_DLL void alib::lox::detail::LI::Release ( LoxImpl * impl)
static

Implementation of method Lox::Release.

Parameters
implThe implementation struct of the Lox.

◆ RemoveLogger() [1/2]

ALIB_DLL detail::Logger * alib::lox::detail::LI::RemoveLogger ( LoxImpl * impl,
const NString & loggerName )
static

Implementation of method Lox::RemoveLogger.

Parameters
implThe implementation struct of the Lox.
loggerNameThe name of the Logger(s) to be removed (case-insensitive).
Returns
The logger that was removed, nullptr if not found.

◆ RemoveLogger() [2/2]

ALIB_DLL bool alib::lox::detail::LI::RemoveLogger ( LoxImpl * impl,
detail::Logger * logger )
static

Implementation of method Lox::RemoveLogger.

Parameters
implThe implementation struct of the Lox.
loggerThe logger to be removed.
Returns
true, if the Logger was found and removed, false otherwise.

◆ RemoveThreadDomain()

ALIB_DLL void alib::lox::detail::LI::RemoveThreadDomain ( LoxImpl * impl,
const NString & scopeDomain,
Scope scope,
threads::Thread * thread )
static

Implementation of method Lox::RemoveThreadDomain.

Parameters
implThe implementation struct of the Lox.
scopeDomainThe domain path to register.
scopeEither Scope::ThreadOuter or Scope::ThreadInner. With other values, an internal error is logged.
threadThe thread to set/unset a thread-related Scope Domains for.

◆ Reset() [1/2]

ALIB_DLL void alib::lox::detail::LI::Reset ( )

Resets this object. Concretely, the following steps are performed:

  • If the debug lox singleton exists, it is deleted.
  • It is asserted that no other lox object is registered.
  • The ALox path of the configuration is deleted.
Attention
This method was introduced to support resetting ALox in the unit tests. In real applications, this method should NOT be used. Side effects might appear using this method and it is not tested otherwise than used in tests!

◆ Reset() [2/2]

ALIB_DLL void alib::lox::detail::LI::Reset ( LoxImpl * impl)
static

Implementation of method Lox::Reset.

Parameters
implThe implementation struct of the Lox.

◆ retrieve()

ALIB_DLL Box alib::lox::detail::LI::retrieve ( LoxImpl * impl,
const NString & pKey,
Scope scope )
static

Internal method serving public interface Lox::Retrieve.

Parameters
implThe implementation struct of the Lox.
pKeyThe key to the data.
scopeThe Scope that the data is bound to.
Returns
The data, a nulled box if no value was found.

◆ SetDomain()

ALIB_DLL void alib::lox::detail::LI::SetDomain ( LoxImpl * impl,
const NString & scopeDomain,
Scope scope,
threads::Thread * thread )
static

Implementation of method Lox::SetDomain.

Parameters
implThe implementation struct of the Lox.
scopeDomainThe domain path to register.
scopeEither Scope::ThreadOuter or Scope::ThreadInner. With other values, an internal error is logged.
threadThe thread to set/unset a thread-related Scope Domains for.

◆ setDomain()

ALIB_DLL void alib::lox::detail::LI::setDomain ( LoxImpl * impl,
const NString & scopeDomain,
Scope scope,
bool removeNTRSD,
threads::Thread * thread )
static

Implementation of the interface method fetching all possible parameters.

Parameters
implThe implementation struct of the Lox.
scopeDomainThe domain path to register.
scopeThe scope that the given domain should be registered for. Available Scope definitions are platform/language dependent.
removeNTRSDUsed to remove a named thread-related Scope Domain (and is true only when invoked by interface method RemoveThreadDomain.
threadThe thread to set/unset a thread-related Scope Domain for.

◆ SetDomainSubstitutionRule()

ALIB_DLL void alib::lox::detail::LI::SetDomainSubstitutionRule ( LoxImpl * impl,
const NString & domainPath,
const NString & replacement )
static

Implementation of method Lox::SetDomainSubstitutionRule.

Parameters
implThe implementation struct of the Lox.
domainPathThe path to search. Has to start with either '/' or '*'.
replacementThe replacement path.

◆ SetFileNameCacheCapacity()

ALIB_DLL void alib::lox::detail::LI::SetFileNameCacheCapacity ( LoxImpl * impl,
integer numberOfLists,
integer entriesPerList )
static

Implementation of method Lox::SetFileNameCacheCapacity.

Parameters
implThe implementation struct of the Lox.
numberOfListsThe number of LRU-lists to use.
entriesPerListThe maximum length of each cache list.

◆ SetPrefix()

ALIB_DLL void alib::lox::detail::LI::SetPrefix ( LoxImpl * impl,
const Box & prefix,
const NString & domain,
lang::Inclusion otherPLs )
static

Implementation of method Lox::SetPrefix.

Parameters
implThe implementation struct of the Lox.
prefixThe Prefix Logable to set.
domainThe domain path. Defaults to nullptr, resulting in evaluated Scope Domain path.
otherPLsIf set to Inclusion::Exclude, scope-related Prefix Logables are ignored and only domain-related Prefix Logables are passed to the Loggers.

◆ setPrefix()

ALIB_DLL void alib::lox::detail::LI::setPrefix ( LoxImpl * impl,
const Box & prefix,
Scope scope,
threads::Thread * thread )
static

Implementation of the interface method fetching all possible parameters.

Parameters
implThe implementation struct of the Lox.
prefixThe Prefix Logable to set.
scopeThe scope that the given logable should be registered for. Available Scope definitions are platform/language dependent.
threadThe thread to set/unset a thread-related Prefix Logable for.

◆ SetSourcePathTrimRule()

ALIB_DLL void alib::lox::detail::LI::SetSourcePathTrimRule ( LoxImpl * impl,
const NCString & path,
lang::Inclusion includeString,
int trimOffset,
lang::Case sensitivity,
const NString & trimReplacement,
lang::Reach reach,
Priority priority )
static

Implementation of method Lox::SetSourcePathTrimRule.

Parameters
implThe implementation struct of the Lox.
pathThe path to search for. If not starting with '*', a prefix is searched.
includeStringDetermines if path should be included in the trimmed path or not. Optional and defaults to Inclusion::Exclude.
trimOffsetAdjusts the portion of path that is trimmed. Optional and defaults to 0.
sensitivityDetermines if the comparison of path with a source file's path is performed case-sensitive or not. Optional and defaults to Case::Ignore.
trimReplacementReplacement string for trimmed portion of the path. Optional and defaults to NULL_STRING.
reachDenotes whether the rule is applied locally (to this Lox only) or applies to all instances of class Lox. Defaults to Reach::Global.
priorityThe priority of the setting. Defaults to DefaultValues.

◆ SetStartTime() [1/3]

ALIB_DLL void alib::lox::detail::LI::SetStartTime ( LoxImpl * impl,
const FILETIME & startTime,
const NString & loggerName )
static

Implementation of method Lox::SetStartTime.

Parameters
implThe implementation struct of the Lox.
startTimeThe new start time in system-specific time unit.
loggerNameThe name of the Logger whose start time is to be set (case insensitive). Defaults to empty string, which indicates that all loggers are to be affected.

◆ SetStartTime() [2/3]

ALIB_DLL void alib::lox::detail::LI::SetStartTime ( LoxImpl * impl,
Ticks startTime,
const NString & loggerName )
static

Implementation of method Lox::SetStartTime.

Parameters
implThe implementation struct of the Lox.
startTimeOptional parameter with the new start time. Defaults to current time if omitted.
loggerNameThe name of the Logger(s) whose start time is to be set (case-insensitive). Defaults to nullptr, which indicates that all loggers are to be affected.

◆ SetStartTime() [3/3]

ALIB_DLL void alib::lox::detail::LI::SetStartTime ( LoxImpl * impl,
time_t startTime,
const NString & loggerName )
static

Implementation of method Lox::SetStartTime.

Parameters
implThe implementation struct of the Lox.
startTimeThe new start time in system-specific time unit.
loggerNameThe name of the Logger whose start time is to be set (case insensitive). Defaults to empty string, which indicates that all loggers are to be affected.

◆ SetVerbosity() [1/2]

ALIB_DLL void alib::lox::detail::LI::SetVerbosity ( LoxImpl * impl,
const NString & loggerName,
Verbosity verbosity,
const NString & domain,
Priority priority )
static

Implementation of method Lox::SetVerbosity.

Parameters
implThe implementation struct of the Lox.
loggerNameThe logger to be to be affected, identified by its name (case insensitive).
verbosityThe 'level of verboseness' to be set.
domainThe parent (start) domain to be set. The use of absolute paths starting with '/' are recommended. Defaults to root domain "/".
priorityThe priority of the setting. Defaults to DefaultValues.

◆ SetVerbosity() [2/2]

ALIB_DLL void alib::lox::detail::LI::SetVerbosity ( LoxImpl * impl,
detail::Logger * logger,
Verbosity verbosity,
const NString & domain,
Priority priority )
static

Implementation of method Lox::SetVerbosity.

Parameters
implThe implementation struct of the Lox.
loggerThe logger to be to be affected (case-insensitive).
verbosityThe 'level of verboseness' to be set.
domainThe parent (start) domain to be set. The use of absolute paths starting with '/' are recommended. Defaults to root domain "/".
priorityThe priority of the setting. Defaults to DefaultValues.

◆ State()

ALIB_DLL void alib::lox::detail::LI::State ( LoxImpl * impl,
const NString & domain,
Verbosity verbosity,
const String & headLine,
StateInfo flags )
static

Implementation of method Lox::State.

Parameters
implThe implementation struct of the Lox.
domainOptional Log Domain which is combined with Scope Domains set for the Scope of invocation.
verbosityThe verbosity.
headLineIf given, a separated headline will be logged at first place.
flagsFlag bits that define which state information is logged.

◆ store()

ALIB_DLL void alib::lox::detail::LI::store ( LoxImpl * impl,
const Box & data,
const NString & pKey,
Scope scope )
static

Internal method serving public interface Lox::Store.

Parameters
implThe implementation struct of the Lox.
dataThe data object to store. In C++, has to be heap allocated and will be deleted by this Lox when overwritten or this lox is deleted.
pKeyThe key to the data.
scopeThe Scope that the data is bound to.

◆ writeVerbositiesOnLoggerRemoval()

ALIB_DLL void alib::lox::detail::LI::writeVerbositiesOnLoggerRemoval ( LoxImpl * impl,
Logger * logger )
static

Implements functionality for configuration variable LOXNAME_LOGGERNAME_VERBOSITY. Is called when a logger is removed.

Parameters
implThe implementation struct of the Lox.
loggerThe logger to write the verbosity for.

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