ALib C++ Library
Library Version: 2412 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
ConfigCamp Class Reference

Description:

The module class.

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

Definition at line 39 of file configcamp.hpp.

#include <configcamp.hpp>

Inheritance diagram for ConfigCamp:
[legend]
Collaboration diagram for ConfigCamp:
[legend]

Public Method Index:

 ConfigCamp ()
 
- Public Method Index: inherited from 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 (config::Configuration *pConfig)
 
void BootstrapSetResourcePool (lang::resources::ResourcePool *pool)
 
config::ConfigurationGetConfig ()
 
threads::SharedLockGetConfigLock ()
 
const StringGetResource (const NString &name)
 
resources::ResourcePoolGetResourcePool ()
 
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 (BootstrapPhases phase) override
 
virtual void shutdown (ShutdownPhases phase) override
 
- Protected Method Index: inherited from Camp

Additional Inherited Members

- Public Field Index: inherited from Camp
NCString ResourceCategory
 
- Protected Field Index: inherited from Camp
int bootstrapState = 0
 
config::Configurationconfig = nullptr
 
SharedLockconfigLock
 A shared lock associated to member config.
 
bool isConfigOwner = false
 
bool isResourceOwner = false
 
lang::resources::ResourcePoolresourcePool = nullptr
 

Constructor(s) / Destructor Details:

◆ ConfigCamp()

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

Definition at line 35 of file configcamp.cpp.

Method Details:

◆ bootstrap()

void bootstrap ( BootstrapPhases phase)
overrideprotectedvirtual

Initializes this camp.

Parameters
phaseThe initialization phase to perform.

Implements Camp.

Definition at line 43 of file configcamp.cpp.

Here is the call graph for this function:

◆ shutdown()

virtual void shutdown ( ShutdownPhases phase)
inlineoverrideprotectedvirtual

Terminates this camp. (Nothing to do.)

Parameters
phaseThe shutdown phase to perform.

Implements Camp.

Definition at line 60 of file configcamp.hpp.


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