ALib C++ Framework
by
Library Version: 2511 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::lox::ALoxCamp Class Reference

Description:

This is the camp class for ALox logging library residing in namespace lox.

This is a strict singleton class. The only instance is found with the namespace variable ALOX.

Definition at line 125 of file aloxcamp.inl.

Inheritance diagram for alib::lox::ALoxCamp:
alib::camp::Camp alib::resources::ResourceHolder

Public Static Field Index:

static variables::Declaration CODEPAGE

Public Method Index:

 ALoxCamp ()
void Reset ()
Public Method Index: inherited from alib::camp::Camp
void BootstrapSetConfig (const SharedConfiguration &pConfig)
void BootstrapSetPhase (BootstrapPhases phase)
void BootstrapSetResourcePool (const SPResourcePool &pResourcePool)
BootstrapPhases GetBootstrapState ()
SharedConfigurationGetConfig ()
bool IsBootstrapped ()
Public Method Index: inherited from alib::resources::ResourceHolder
 ResourceHolder (const NCString &resourceCategory=nullptr)
 ResourceHolder (SPResourcePool &pool, const NCString &resourceCategory)
void BootstrapResource (const NString &name, const String &data)
const StringGetResource (const NString &name)
ResourcePoolGetResourcePool ()
SPResourcePoolGetResourcePoolSP ()
bool HasPool ()
void Set (SPResourcePool &pool, const NCString &resourceCategory=nullptr)
const StringTryResource (const NString &name)

Protected Method Index:

void Bootstrap () override
 Implementation of virtual void Bootstrap() =0.
void Shutdown (ShutdownPhases phase) override
Protected Method Index: inherited from alib::camp::Camp
 Camp (Camp &&)=delete
 Deleted move constructor.
 Camp (const Camp &)=delete
 Deleted copy constructor.
 Camp (const NCString &resourceCategory)
virtual ~Camp ()
 Virtual destructor to satisfy C++ abstract type rules.
void operator= (Camp &&)=delete
 Deleted move assignment.
void operator= (const Camp &)=delete
 Deleted copy assignment.

Additional Inherited Members

Public Type Index: inherited from alib::resources::ResourceHolder
using SPResourcePool = SharedPtr<resources::ResourcePool, MonoAllocator>
Public Field Index: inherited from alib::resources::ResourceHolder
NCString ResourceCategory
Protected Field Index: inherited from alib::camp::Camp
int bootstrapState = 0
SharedConfiguration config
Protected Field Index: inherited from alib::resources::ResourceHolder
SPResourcePool resourcePool
 Shared pointer to the resource pool.

Field Details:

◆ CODEPAGE

variables::Declaration alib::lox::ALoxCamp::CODEPAGE
static

Attributes of corresponding configuration variable ALOX/CODEPAGE used by class WindowsConsoleLogger.

Definition at line 139 of file aloxcamp.inl.

Constructor(s) / Destructor Details:

◆ ALoxCamp()

alib::lox::ALoxCamp::ALoxCamp ( )

Constructor.
While this is public, it must not be invoked as this is a strict singleton type. (See notes in 2. Class Camp).

Definition at line 65 of file aloxcamp.cpp.

Method Details:

◆ Bootstrap()

void alib::lox::ALoxCamp::Bootstrap ( )
overrideprotectedvirtual

Implementation of virtual void Bootstrap() =0.

Implements alib::camp::Camp.

Definition at line 104 of file aloxcamp.cpp.

◆ Reset()

void alib::lox::ALoxCamp::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!

Definition at line 73 of file aloxcamp.cpp.

◆ Shutdown()

void alib::lox::ALoxCamp::Shutdown ( ShutdownPhases phase)
overrideprotectedvirtual

Implementation of virtual void Shutdown(ShutdownPhases) =0.

Parameters
phaseThe shutdown phase to perform.

Implements alib::camp::Camp.

Definition at line 316 of file aloxcamp.cpp.


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