el::Helpers Class Reference

Static helpers for developers. More...

#include <easylogging++.h>

Inheritance 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	setCrashHandler (const el::base::debug::CrashHandler::Handler &crashHandler)
	Overrides default crash handler and installs custom handler. More...
static void	crashAbort (int sig, const char *sourceFile="", unsigned int long line=0)
	Abort due to crash with signal in parameter. More...
static void	logCrashReason (int sig, bool stackTraceIfAvailable=false, Level level=Level::Fatal, const char *logger=base::consts::kDefaultLoggerId)
	Logs reason of crash as per sig. More...
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 bool	installPerformanceTrackingCallback (const std::string &id)
	Installs post performance tracking callback, this callback is triggered when performance tracking is finished. More...
template<typename T >
static void	uninstallPerformanceTrackingCallback (const std::string &id)
	Uninstalls post performance tracking handler. More...
template<typename T >
static T *	performanceTrackingCallback (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	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)
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	setCrashHandler (const el::base::debug::CrashHandler::Handler &crashHandler)
	Overrides default crash handler and installs custom handler. More...
static void	crashAbort (int sig, const char *sourceFile="", unsigned int long line=0)
	Abort due to crash with signal in parameter. More...
static void	logCrashReason (int sig, bool stackTraceIfAvailable=false, Level level=Level::Fatal, const char *logger=base::consts::kDefaultLoggerId)
	Logs reason of crash as per sig. More...
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 bool	installPerformanceTrackingCallback (const std::string &id)
	Installs post performance tracking callback, this callback is triggered when performance tracking is finished. More...
template<typename T >
static void	uninstallPerformanceTrackingCallback (const std::string &id)
	Uninstalls post performance tracking handler. More...
template<typename T >
static T *	performanceTrackingCallback (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	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)
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	setCrashHandler (const el::base::debug::CrashHandler::Handler &crashHandler)
	Overrides default crash handler and installs custom handler. More...
static void	crashAbort (int sig, const char *sourceFile="", unsigned int long line=0)
	Abort due to crash with signal in parameter. More...
static void	logCrashReason (int sig, bool stackTraceIfAvailable=false, Level level=Level::Fatal, const char *logger=base::consts::kDefaultLoggerId)
	Logs reason of crash as per sig. More...
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 bool	installPerformanceTrackingCallback (const std::string &id)
	Installs post performance tracking callback, this callback is triggered when performance tracking is finished. More...
template<typename T >
static void	uninstallPerformanceTrackingCallback (const std::string &id)
	Uninstalls post performance tracking handler. More...
template<typename T >
static T *	performanceTrackingCallback (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	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.

Member Function Documentation

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

inlinestatic

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

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

inlinestatic

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

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

inlinestatic

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

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.

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.

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.

static void el::Helpers::crashAbort ( int  sig, const char *  sourceFile = "", unsigned int long  line = 0  )

inlinestatic

Abort due to crash with signal in parameter.

Parameters

sig	Crash signal

static void el::Helpers::crashAbort ( int  sig, const char *  sourceFile = "", unsigned int long  line = 0  )

inlinestatic

Abort due to crash with signal in parameter.

Parameters

sig	Crash signal

static void el::Helpers::crashAbort ( int  sig, const char *  sourceFile = "", unsigned int long  line = 0  )

inlinestatic

Abort due to crash with signal in parameter.

Parameters

sig	Crash signal

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

inlinestatic

Returns true if custom format specifier is installed.

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

inlinestatic

Returns true if custom format specifier is installed.

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

inlinestatic

Returns true if custom format specifier is installed.

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

inlinestatic

Installs user defined format specifier and handler.

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

inlinestatic

Installs user defined format specifier and handler.

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

inlinestatic

Installs user defined format specifier and handler.

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.

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.

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.

template<typename T >

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

inlinestatic

Installs post performance tracking callback, this callback is triggered when performance tracking is finished.

template<typename T >

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

inlinestatic

Installs post performance tracking callback, this callback is triggered when performance tracking is finished.

template<typename T >

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

inlinestatic

Installs post performance tracking callback, this callback is triggered when performance tracking is finished.

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)

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)

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)

static void el::Helpers::logCrashReason ( int  sig, bool  stackTraceIfAvailable = false, Level  level = Level::Fatal, const char *  logger = base::consts::kDefaultLoggerId  )

inlinestatic

Logs reason of crash as per sig.

Parameters

sig	Crash signal
stackTraceIfAvailable	Includes stack trace if available
level	Logging level
logger	Logger to use for logging

static void el::Helpers::logCrashReason ( int  sig, bool  stackTraceIfAvailable = false, Level  level = Level::Fatal, const char *  logger = base::consts::kDefaultLoggerId  )

inlinestatic

Logs reason of crash as per sig.

Parameters

sig	Crash signal
stackTraceIfAvailable	Includes stack trace if available
level	Logging level
logger	Logger to use for logging

static void el::Helpers::logCrashReason ( int  sig, bool  stackTraceIfAvailable = false, Level  level = Level::Fatal, const char *  logger = base::consts::kDefaultLoggerId  )

inlinestatic

Logs reason of crash as per sig.

Parameters

sig	Crash signal
stackTraceIfAvailable	Includes stack trace if available
level	Logging level
logger	Logger to use for logging

template<typename T >

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

inlinestatic

template<typename T >

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

inlinestatic

template<typename T >

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

inlinestatic

template<typename T >

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

inlinestatic

template<typename T >

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

inlinestatic

template<typename T >

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

inlinestatic

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

inlinestatic

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

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

inlinestatic

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

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

inlinestatic

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

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

inlinestatic

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

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

inlinestatic

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

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

inlinestatic

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

static void el::Helpers::setCrashHandler ( const el::base::debug::CrashHandler::Handler &  crashHandler )

inlinestatic

Overrides default crash handler and installs custom handler.

Parameters

crashHandler

A functor with no return type that takes single int argument. Handler is a typedef with specification: void (*Handler)(int)

static void el::Helpers::setCrashHandler ( const el::base::debug::CrashHandler::Handler &  crashHandler )

inlinestatic

Overrides default crash handler and installs custom handler.

Parameters

crashHandler

A functor with no return type that takes single int argument. Handler is a typedef with specification: void (*Handler)(int)

static void el::Helpers::setCrashHandler ( const el::base::debug::CrashHandler::Handler &  crashHandler )

inlinestatic

Overrides default crash handler and installs custom handler.

Parameters

crashHandler

A functor with no return type that takes single int argument. Handler is a typedef with specification: void (*Handler)(int)

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

inlinestatic

Shares logging repository (base::Storage)

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

inlinestatic

Shares logging repository (base::Storage)

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

inlinestatic

Shares logging repository (base::Storage)

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

inlinestatic

Returns

Main storage repository

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

inlinestatic

Returns

Main storage repository

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

inlinestatic

Returns

Main storage repository

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

inlinestatic

Uninstalls user defined format specifier and handler.

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

inlinestatic

Uninstalls user defined format specifier and handler.

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

inlinestatic

Uninstalls user defined format specifier and handler.

template<typename T >

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

inlinestatic

Uninstalls log dispatch callback.

template<typename T >

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

inlinestatic

Uninstalls log dispatch callback.

template<typename T >

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

inlinestatic

Uninstalls log dispatch callback.

template<typename T >

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

inlinestatic

Uninstalls post performance tracking handler.

template<typename T >

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

inlinestatic

Uninstalls post performance tracking handler.

template<typename T >

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

inlinestatic

Uninstalls post performance tracking handler.

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

inlinestatic

Uninstalls pre rollout callback.

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

inlinestatic

Uninstalls pre rollout callback.

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

inlinestatic

Uninstalls pre rollout callback.

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

inlinestatic

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

inlinestatic

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

inlinestatic

---

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

• INTROOT/include/easylogging++.h
• INTROOT/sources/tools/easylogging/src/include/easylogging++.h
• tools/easylogging/src/include/easylogging++.h