Thread-safe Configuration repository. More...

#include <easylogging++.h>

Inheritance diagram for el::Configurations:

Collaboration diagram for el::Configurations:

Classes
class	Parser
	Parser used internally to parse configurations from file or text. More...

Public Member Functions
	Configurations (void)
	Default constructor with empty repository.
	Configurations (const std::string &configurationFile, bool useDefaultsForRemaining=true, Configurations *base=nullptr)
	Constructor used to set configurations using configuration file.
virtual	~Configurations (void)
bool	parseFromFile (const std::string &configurationFile, Configurations *base=nullptr)
	Parses configuration from file.
bool	parseFromText (const std::string &configurationsString, Configurations *base=nullptr)
	Parse configurations from configuration string.
void	setFromBase (Configurations *base)
	Sets configuration based-off an existing configurations.
bool	hasConfiguration (ConfigurationType configurationType)
	Determines whether or not specified configuration type exists in the repository.
bool	hasConfiguration (Level level, ConfigurationType configurationType)
	Determines whether or not specified configuration type exists for specified level.
void	set (Level level, ConfigurationType configurationType, const std::string &value)
	Sets value of configuration for specified level.
void	set (Configuration *conf)
	Sets single configuration based on other single configuration.
Configuration *	get (Level level, ConfigurationType configurationType)
void	setGlobally (ConfigurationType configurationType, const std::string &value)
	Sets configuration for all levels.
void	clear (void)
	Clears repository so that all the configurations are unset.
const std::string &	configurationFile (void) const
	Gets configuration file used in parsing this configurations.
void	setToDefault (void)
	Sets configurations to "factory based" configurations.
void	setRemainingToDefault (void)
	Lets you set the remaining configurations to default.
Public Member Functions inherited from el::base::utils::RegistryWithPred< Configuration, Configuration::Predicate >
	RegistryWithPred (void)
virtual	~RegistryWithPred (void)
RegistryWithPred &	operator= (const RegistryWithPred &sr)
	Assignment operator that unregisters all the existing registeries and deeply copies each of repo element.
Public Member Functions inherited from el::base::utils::AbstractRegistry< Configuration, std::vector< Configuration * > >
	AbstractRegistry (void)
	Default constructor.
bool	operator== (const AbstractRegistry< Configuration, std::vector< Configuration * > > &other)
bool	operator!= (const AbstractRegistry< Configuration, std::vector< Configuration * > > &other)
AbstractRegistry &	operator= (AbstractRegistry &&sr)
	Assignment move operator.
virtual	~AbstractRegistry (void)
virtual iterator	begin (void) ELPP_FINAL
virtual iterator	end (void) ELPP_FINAL
virtual const_iterator	cbegin (void) const ELPP_FINAL
virtual const_iterator	cend (void) const ELPP_FINAL
virtual bool	empty (void) const ELPP_FINAL
virtual std::size_t	size (void) const ELPP_FINAL
virtual std::vector< Configuration * > &	list (void) ELPP_FINAL
	Returns underlying container by reference.
Public Member Functions inherited from el::base::threading::ThreadSafe
virtual void	acquireLock (void) ELPP_FINAL
virtual void	releaseLock (void) ELPP_FINAL
virtual base::threading::Mutex &	lock (void) ELPP_FINAL

Private Member Functions
void	unsafeSetIfNotExist (Level level, ConfigurationType configurationType, const std::string &value)
	Unsafely sets configuration if does not already exist.
void	unsafeSet (Level level, ConfigurationType configurationType, const std::string &value)
	Thread unsafe set.
void	setGlobally (ConfigurationType configurationType, const std::string &value, bool includeGlobalLevel)
	Sets configurations for all levels including Level::Global if includeGlobalLevel is true.
void	unsafeSetGlobally (ConfigurationType configurationType, const std::string &value, bool includeGlobalLevel)
	Sets configurations (Unsafely) for all levels including Level::Global if includeGlobalLevel is true.

Private Attributes
std::string	m_configurationFile
bool	m_isFromFile

Friends
class	el::Loggers

Additional Inherited Members
Public Types inherited from el::base::utils::RegistryWithPred< Configuration, Configuration::Predicate >
typedef RegistryWithPred< Configuration, Configuration::Predicate >::iterator	iterator
typedef RegistryWithPred< Configuration, Configuration::Predicate >::const_iterator	const_iterator
Public Types inherited from el::base::utils::AbstractRegistry< Configuration, std::vector< Configuration * > >
typedef std::vector< Configuration * >::iterator	iterator
typedef std::vector< Configuration * >::const_iterator	const_iterator
Protected Member Functions inherited from el::base::utils::RegistryWithPred< Configuration, Configuration::Predicate >
virtual void	unregisterAll (void) ELPP_FINAL
	Unregisters all the pointers from current repository.
virtual void	unregister (Configuration *&ptr) ELPP_FINAL
virtual void	registerNew (Configuration *ptr) ELPP_FINAL
Configuration *	get (const T &arg1, const T2 arg2)
	Gets pointer from repository with speicifed arguments. Arguments are passed to predicate in order to validate pointer.
Protected Member Functions inherited from el::base::utils::AbstractRegistry< Configuration, std::vector< Configuration * > >
void	reinitDeepCopy (const AbstractRegistry< Configuration, std::vector< Configuration * > > &sr)
Protected Member Functions inherited from el::base::threading::ThreadSafe
	ThreadSafe (void)
virtual	~ThreadSafe (void)

Detailed Description

Thread-safe Configuration repository.

@detail This repository represents configurations for all the levels and configuration type mapped to a value.

Constructor & Destructor Documentation

◆ Configurations() [1/2]

el::Configurations::Configurations ( void )

Default constructor with empty repository.

◆ Configurations() [2/2]

el::Configurations::Configurations	(	const std::string &	configurationFile,
		bool	useDefaultsForRemaining = true,
		Configurations *	base = nullptr )

Constructor used to set configurations using configuration file.

Parameters

configurationFile	Full path to configuration file
useDefaultsForRemaining	Lets you set the remaining configurations to default.
base	If provided, this configuration will be based off existing repository that this argument is pointing to.

See also: parseFromFile(const std::string&, Configurations* base); setRemainingToDefault()

◆ ~Configurations()

virtual el::Configurations::~Configurations ( void )

inlinevirtual

Member Function Documentation

◆ clear()

void el::Configurations::clear ( void )

inline

Clears repository so that all the configurations are unset.

◆ configurationFile()

const std::string & el::Configurations::configurationFile ( void ) const

inline

Gets configuration file used in parsing this configurations.

@detail If this repository was set manually or by text this returns empty string.

◆ get()

Configuration * el::Configurations::get	(	Level	level,
		ConfigurationType	configurationType )

inline

◆ hasConfiguration() [1/2]

bool el::Configurations::hasConfiguration ( ConfigurationType configurationType )

Determines whether or not specified configuration type exists in the repository.

@detail Returns as soon as first level is found.

Parameters

configurationType Type of configuration to check existence for.

◆ hasConfiguration() [2/2]

bool el::Configurations::hasConfiguration	(	Level	level,
		ConfigurationType	configurationType )

Determines whether or not specified configuration type exists for specified level.

Parameters

level	Level to check
configurationType	Type of configuration to check existence for.

◆ parseFromFile()

bool el::Configurations::parseFromFile	(	const std::string &	configurationFile,
		Configurations *	base = nullptr )

Parses configuration from file.

Parameters

configurationFile	Full path to configuration file
base	Configurations to base new configuration repository off. This value is used when you want to use existing Configurations to base all the values and then set rest of configuration via configuration file.

Returns: True if successfully parsed, false otherwise. You may define 'ELPP_DEBUG_ASSERT_FAILURE' to make sure you do not proceed without successful parse.

◆ parseFromText()

bool el::Configurations::parseFromText	(	const std::string &	configurationsString,
		Configurations *	base = nullptr )

Parse configurations from configuration string.

@detail This configuration string has same syntax as configuration file contents. Make sure all the necessary new line characters are provided.

Parameters

base	Configurations to base new configuration repository off. This value is used when you want to use existing Configurations to base all the values and then set rest of configuration via configuration text.

Returns: True if successfully parsed, false otherwise. You may define 'ELPP_DEBUG_ASSERT_FAILURE' to make sure you do not proceed without successful parse.

◆ set() [1/2]

void el::Configurations::set ( Configuration * conf )

Sets single configuration based on other single configuration.

See also: set(Level level, ConfigurationType configurationType, const std::string& value)

◆ set() [2/2]

void el::Configurations::set	(	Level	level,
		ConfigurationType	configurationType,
		const std::string &	value )

Sets value of configuration for specified level.

@detail Any existing configuration for specified level will be replaced. Also note that configuration types ConfigurationType::SubsecondPrecision and ConfigurationType::PerformanceTracking will be ignored if not set for Level::Global because these configurations are not dependant on level.

Parameters

level	Level to set configuration for (el::Level).
configurationType	Type of configuration (el::ConfigurationType)
value	A string based value. Regardless of what the data type of configuration is, it will always be string from users' point of view. This is then parsed later to be used internally.

See also: Configuration::setValue(const std::string& value); el::Level; el::ConfigurationType

◆ setFromBase()

void el::Configurations::setFromBase ( Configurations * base )

Sets configuration based-off an existing configurations.

Parameters

base	Pointer to existing configurations.

◆ setGlobally() [1/2]

void el::Configurations::setGlobally	(	ConfigurationType	configurationType,
		const std::string &	value )

inline

Sets configuration for all levels.

Parameters

configurationType	Type of configuration
value	String based value

See also: Configurations::set(Level level, ConfigurationType configurationType, const std::string& value)

◆ setGlobally() [2/2]

void el::Configurations::setGlobally	(	ConfigurationType	configurationType,
		const std::string &	value,
		bool	includeGlobalLevel )

private

Sets configurations for all levels including Level::Global if includeGlobalLevel is true.

See also: Configurations::setGlobally(ConfigurationType configurationType, const std::string& value)

◆ setRemainingToDefault()

void el::Configurations::setRemainingToDefault ( void )

Lets you set the remaining configurations to default.

@detail By remaining, it means that the level/type a configuration does not exist for. This function is useful when you want to minimize chances of failures, e.g, if you have a configuration file that sets configuration for all the configurations except for Enabled or not, we use this so that ENABLED is set to default i.e, true. If you dont do this explicitly (either by calling this function or by using second param in Constructor and try to access a value, an error is thrown

◆ setToDefault()

void el::Configurations::setToDefault ( void )

Sets configurations to "factory based" configurations.

◆ unsafeSet()

void el::Configurations::unsafeSet	(	Level	level,
		ConfigurationType	configurationType,
		const std::string &	value )

private

Thread unsafe set.

◆ unsafeSetGlobally()

void el::Configurations::unsafeSetGlobally	(	ConfigurationType	configurationType,
		const std::string &	value,
		bool	includeGlobalLevel )

private

Sets configurations (Unsafely) for all levels including Level::Global if includeGlobalLevel is true.

See also: Configurations::setGlobally(ConfigurationType configurationType, const std::string& value)

◆ unsafeSetIfNotExist()

void el::Configurations::unsafeSetIfNotExist	(	Level	level,
		ConfigurationType	configurationType,
		const std::string &	value )

private

Unsafely sets configuration if does not already exist.

◆ el::Loggers

friend class el::Loggers

friend

Member Data Documentation

◆ m_configurationFile

std::string el::Configurations::m_configurationFile

private

◆ m_isFromFile

bool el::Configurations::m_isFromFile

private

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

external/easylogging++/easylogging++.h
external/easylogging++/easylogging++.cc

Classes

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Configurations() [1/2]

◆ Configurations() [2/2]

◆ ~Configurations()

Member Function Documentation

◆ clear()

◆ configurationFile()

◆ get()

◆ hasConfiguration() [1/2]

◆ hasConfiguration() [2/2]

◆ parseFromFile()

◆ parseFromText()

◆ set() [1/2]

◆ set() [2/2]

◆ setFromBase()

◆ setGlobally() [1/2]

◆ setGlobally() [2/2]

◆ setRemainingToDefault()

◆ setToDefault()

◆ unsafeSet()

◆ unsafeSetGlobally()

◆ unsafeSetIfNotExist()

Friends And Related Symbol Documentation

◆ el::Loggers

Member Data Documentation

◆ m_configurationFile

◆ m_isFromFile