Static helpers for developers. More...

#include <easylogging++.h>

Inheritance diagram for el::Helpers:

Collaboration diagram for el::Helpers:

Static Public Member Functions
static void	setStorage (base::type::StoragePointer storage)
	Shares logging repository (base::Storage) More...

static base::type::StoragePointer	storage ()

static void	setArgs (int argc, char **argv)
	Sets application arguments and figures out whats active for logging and whats not. More...

static void	setArgs (int argc, const char **argv)
	Sets application arguments and figures out whats active for logging and whats not. More...

static void	setThreadName (const std::string &name)
	Sets thread name for current thread. Requires std::thread. More...

static std::string	getThreadName ()

static void	installPreRollOutCallback (const PreRollOutCallback &callback)
	Installs pre rollout callback, this callback is triggered when log file is about to be rolled out (can be useful for backing up) More...

static void	uninstallPreRollOutCallback (void)
	Uninstalls pre rollout callback. More...

template<typename T >
static bool	installLogDispatchCallback (const std::string &id)
	Installs post log dispatch callback, this callback is triggered when log is dispatched. More...

template<typename T >
static void	uninstallLogDispatchCallback (const std::string &id)
	Uninstalls log dispatch callback. More...

template<typename T >
static T *	logDispatchCallback (const std::string &id)

template<typename T >
static std::string	convertTemplateToStdString (const T &templ)
	Converts template to std::string - useful for loggable classes to log containers within log(std::ostream&) const. More...

static const el::base::utils::CommandLineArgs *	commandLineArgs (void)
	Returns command line arguments (pointer) provided to easylogging++. More...

static void	reserveCustomFormatSpecifiers (std::size_t size)
	Reserve space for custom format specifiers for performance. More...

static void	installCustomFormatSpecifier (const CustomFormatSpecifier &customFormatSpecifier)
	Installs user defined format specifier and handler. More...

static bool	uninstallCustomFormatSpecifier (const char *formatSpecifier)
	Uninstalls user defined format specifier and handler. More...

static bool	hasCustomFormatSpecifier (const char *formatSpecifier)
	Returns true if custom format specifier is installed. More...

static void	validateFileRolling (Logger *logger, Level level)

Detailed Description

Static helpers for developers.

Definition at line 3715 of file easylogging++.h.

Member Function Documentation

◆ commandLineArgs()

static const el::base::utils::CommandLineArgs* el::Helpers::commandLineArgs ( void )

inlinestatic

Returns command line arguments (pointer) provided to easylogging++.

Definition at line 3819 of file easylogging++.h.

                                                                         {
     return ELPP->commandLineArgs();
   }

◆ convertTemplateToStdString()

template<typename T >

static std::string el::Helpers::convertTemplateToStdString ( const T & templ )

inlinestatic

Converts template to std::string - useful for loggable classes to log containers within log(std::ostream&) const.

Definition at line 3799 of file easylogging++.h.

                                                               {
     el::Logger* logger =
       ELPP->registeredLoggers()->get(el::base::consts::kDefaultLoggerId);
     if (logger == nullptr) {
       return std::string();
     }
     base::MessageBuilder b;
     b.initialize(logger);
     logger->acquireLock();
     b << templ;
 #if defined(ELPP_UNICODE)
     std::string s = std::string(logger->stream().str().begin(), logger->stream().str().end());
 #else
     std::string s = logger->stream().str();
 #endif  // defined(ELPP_UNICODE)
     logger->stream().str(ELPP_LITERAL(""));
     logger->releaseLock();
     return s;
   }

Here is the call graph for this function:

◆ getThreadName()

static std::string el::Helpers::getThreadName ( )

inlinestatic

Definition at line 3737 of file easylogging++.h.

                                           {
     return ELPP->getThreadName(base::threading::getCurrentThreadId());
   }

◆ hasCustomFormatSpecifier()

static bool el::Helpers::hasCustomFormatSpecifier ( const char * formatSpecifier )

inlinestatic

Returns true if custom format specifier is installed.

Definition at line 3836 of file easylogging++.h.

                                                                            {
     return ELPP->hasCustomFormatSpecifier(formatSpecifier);
   }

◆ installCustomFormatSpecifier()

static void el::Helpers::installCustomFormatSpecifier ( const CustomFormatSpecifier & customFormatSpecifier )

inlinestatic

Installs user defined format specifier and handler.

Definition at line 3828 of file easylogging++.h.

                                                                                                       {
     ELPP->installCustomFormatSpecifier(customFormatSpecifier);
   }

◆ installLogDispatchCallback()

template<typename T >

static bool el::Helpers::installLogDispatchCallback ( const std::string & id )

inlinestatic

Installs post log dispatch callback, this callback is triggered when log is dispatched.

Definition at line 3769 of file easylogging++.h.

                                                                      {
     return ELPP->installLogDispatchCallback<T>(id);
   }

◆ installPreRollOutCallback()

static void el::Helpers::installPreRollOutCallback ( const PreRollOutCallback & callback )

inlinestatic

Installs pre rollout callback, this callback is triggered when log file is about to be rolled out (can be useful for backing up)

Definition at line 3760 of file easylogging++.h.

                                                                                    {
     ELPP->setPreRollOutCallback(callback);
   }

Here is the caller graph for this function:

◆ logDispatchCallback()

template<typename T >

static T* el::Helpers::logDispatchCallback ( const std::string & id )

inlinestatic

Definition at line 3778 of file easylogging++.h.

                                                             {
     return ELPP->logDispatchCallback<T>(id);
   }

◆ reserveCustomFormatSpecifiers()

static void el::Helpers::reserveCustomFormatSpecifiers ( std::size_t size )

inlinestatic

Reserve space for custom format specifiers for performance.

See also: std::vector::reserve

Definition at line 3824 of file easylogging++.h.

                                                                    {
     ELPP->m_customFormatSpecifiers.reserve(size);
   }

◆ setArgs() [1/2]

static void el::Helpers::setArgs	(	int	argc,
		char **	argv
	)

inlinestatic

Sets application arguments and figures out whats active for logging and whats not.

Definition at line 3726 of file easylogging++.h.

                                                     {
     ELPP->setApplicationArguments(argc, argv);
   }

◆ setArgs() [2/2]

static void el::Helpers::setArgs	(	int	argc,
		const char **	argv
	)

inlinestatic

Sets application arguments and figures out whats active for logging and whats not.

Definition at line 3730 of file easylogging++.h.

                                                           {
     ELPP->setApplicationArguments(argc, const_cast<char**>(argv));
   }

◆ setStorage()

static void el::Helpers::setStorage ( base::type::StoragePointer storage )

inlinestatic

Shares logging repository (base::Storage)

Definition at line 3718 of file easylogging++.h.

                                                                 {
     ELPP = storage;
   }

◆ setThreadName()

static void el::Helpers::setThreadName ( const std::string & name )

inlinestatic

Sets thread name for current thread. Requires std::thread.

Definition at line 3734 of file easylogging++.h.

                                                           {
     ELPP->setThreadName(name);
   }

◆ storage()

static base::type::StoragePointer el::Helpers::storage ( )

inlinestatic

Returns: Main storage repository

Definition at line 3722 of file easylogging++.h.

                                                  {
     return ELPP;
   }

◆ uninstallCustomFormatSpecifier()

static bool el::Helpers::uninstallCustomFormatSpecifier ( const char * formatSpecifier )

inlinestatic

Uninstalls user defined format specifier and handler.

Definition at line 3832 of file easylogging++.h.

                                                                                  {
     return ELPP->uninstallCustomFormatSpecifier(formatSpecifier);
   }

◆ uninstallLogDispatchCallback()

template<typename T >

static void el::Helpers::uninstallLogDispatchCallback ( const std::string & id )

inlinestatic

Uninstalls log dispatch callback.

Definition at line 3774 of file easylogging++.h.

                                                                        {
     ELPP->uninstallLogDispatchCallback<T>(id);
   }

◆ uninstallPreRollOutCallback()

static void el::Helpers::uninstallPreRollOutCallback ( void )

inlinestatic

Uninstalls pre rollout callback.

Definition at line 3764 of file easylogging++.h.

                                                        {
     ELPP->unsetPreRollOutCallback();
   }

◆ validateFileRolling()

static void el::Helpers::validateFileRolling	(	Logger *	logger,
		Level	level
	)

inlinestatic

Definition at line 3839 of file easylogging++.h.

                                                                       {
     if (ELPP == nullptr || logger == nullptr) return;
     logger->m_typedConfigurations->validateFileRolling(level, ELPP->preRollOutCallback());
   }

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

/home/abuild/rpmbuild/BUILD/electroneum-4.0.0.0/external/easylogging++/easylogging++.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ commandLineArgs()

◆ convertTemplateToStdString()

◆ getThreadName()

◆ hasCustomFormatSpecifier()

◆ installCustomFormatSpecifier()

◆ installLogDispatchCallback()

◆ installPreRollOutCallback()

◆ logDispatchCallback()

◆ reserveCustomFormatSpecifiers()

◆ setArgs() [1/2]

◆ setArgs() [2/2]

◆ setStorage()

◆ setThreadName()

◆ storage()

◆ uninstallCustomFormatSpecifier()

◆ uninstallLogDispatchCallback()

◆ uninstallPreRollOutCallback()

◆ validateFileRolling()