ALib C++ Library
Library Version: 2510 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 alib::lox.

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

Definition at line 120 of file aloxcamp.inl.

Inheritance diagram for alib::lox::ALoxCamp:
[legend]
Collaboration diagram for alib::lox::ALoxCamp:
[legend]

Public Static Field Index:

static ALIB_DLL variables::Declaration CODEPAGE
 

Public Method Index:

 ALoxCamp ()
 
ALIB_DLL void Reset ()
 
- Public 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 BootstrapResource (const NString &name, const String &data)
 
void BootstrapSetConfig (const SharedConfiguration &pConfig)
 
void BootstrapSetPhase (BootstrapPhases phase)
 
void BootstrapSetResourcePool (const SPResourcePool &pResourcePool)
 
BootstrapPhases GetBootstrapState ()
 
SharedConfigurationGetConfig ()
 
const StringGetResource (const NString &name)
 
SPResourcePoolGetResourcePool ()
 
bool IsBootstrapped ()
 
void operator= (Camp &&)=delete
 Deleted move assignment.
 
void operator= (const Camp &)=delete
 Deleted copy assignment.
 
const StringTryResource (const NString &name)
 

Protected Method Index:

virtual void Bootstrap () override
 Implementation of Camp::Bootstrap.
 
virtual void Shutdown (ShutdownPhases phase) override
 

Additional Inherited Members

- Public Type Index: inherited from alib::camp::Camp
using SPResourcePool = SharedPtr<resources::ResourcePool, MonoAllocator>
 
- Public Field Index: inherited from alib::camp::Camp
NCString ResourceCategory
 
- Protected Field Index: inherited from alib::camp::Camp
int bootstrapState = 0
 
SharedConfiguration config
 
SPResourcePool resourcePool
 

Field Details:

◆ CODEPAGE

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

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

Definition at line 134 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 64 of file aloxcamp.cpp.

Here is the call graph for this function:

Method Details:

◆ Bootstrap()

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

Implementation of Camp::Bootstrap.

Implements alib::camp::Camp.

Definition at line 105 of file aloxcamp.cpp.

Here is the call graph for this function:

◆ 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.

Here is the call graph for this function:

◆ Shutdown()

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

Implementation of Camp::Shutdown.

Parameters
phaseThe shutdown phase to perform.

Implements alib::camp::Camp.

Definition at line 323 of file aloxcamp.cpp.

Here is the call graph for this function:

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