TwiceAsNice  2019-02-18
Public Member Functions | Static Public Member Functions | List of all members
ILog4zManager Class Referenceabstract

log4z class More...

#include <log4z.h>

Collaboration diagram for ILog4zManager:
Collaboration graph

Public Member Functions

 ILog4zManager ()
 
virtual ~ILog4zManager ()
 
virtual bool config (const char *configPath)=0
 Config or overwrite configure Needs to be called before ILog4zManager::Start,, OR Do not call. More...
 
virtual bool configFromString (const char *configContent)=0
 
virtual LoggerId createLogger (const char *key)=0
 Create or overwrite logger. More...
 
virtual bool start ()=0
 Start Log Thread. This method can only be called once by one process. More...
 
virtual bool stop ()=0
 Default the method will be calling at process exit auto. More...
 
virtual LoggerId findLogger (const char *key)=0
 Find logger. thread safe. More...
 
virtual bool prePushLog (LoggerId id, int level)=0
 
virtual bool pushLog (LoggerId id, int level, const char *log, const char *file=NULL, int line=0)=0
 Push log, thread safe. More...
 
virtual bool enableLogger (LoggerId id, bool enable)=0
 set logger's attribute, thread safe. More...
 
virtual bool setLoggerName (LoggerId id, const char *name)=0
 
virtual bool setLoggerPath (LoggerId id, const char *path)=0
 
virtual bool setLoggerLevel (LoggerId id, int nLevel)=0
 
virtual bool setLoggerFileLine (LoggerId id, bool enable)=0
 
virtual bool setLoggerDisplay (LoggerId id, bool enable)=0
 
virtual bool setLoggerOutFile (LoggerId id, bool enable)=0
 
virtual bool setLoggerLimitsize (LoggerId id, unsigned int limitsize)=0
 
virtual bool setLoggerMonthdir (LoggerId id, bool enable)=0
 
virtual bool setAutoUpdate (int interval)=0
 Update logger's attribute from config file, thread safe. More...
 
virtual bool updateConfig ()=0
 
virtual bool isLoggerEnable (LoggerId id)=0
 Log4z status statistics, thread safe. More...
 
virtual unsigned long long getStatusTotalWriteCount ()=0
 
virtual unsigned long long getStatusTotalWriteBytes ()=0
 
virtual unsigned long long getStatusWaitingCount ()=0
 
virtual unsigned int getStatusActiveLoggers ()=0
 

Static Public Member Functions

static ILog4zManagergetInstance ()
 Log4z Singleton. More...
 
static ILog4zManagergetRef ()
 
static ILog4zManagergetPtr ()
 

Detailed Description

log4z class

Constructor & Destructor Documentation

◆ ILog4zManager()

ILog4zManager::ILog4zManager ( )
inline

◆ ~ILog4zManager()

virtual ILog4zManager::~ILog4zManager ( )
inlinevirtual

Member Function Documentation

◆ config()

virtual bool ILog4zManager::config ( const char *  configPath)
pure virtual

Config or overwrite configure Needs to be called before ILog4zManager::Start,, OR Do not call.

◆ configFromString()

virtual bool ILog4zManager::configFromString ( const char *  configContent)
pure virtual

◆ createLogger()

virtual LoggerId ILog4zManager::createLogger ( const char *  key)
pure virtual

Create or overwrite logger.

Needs to be called before ILog4zManager::Start, OR Do not call.

◆ enableLogger()

virtual bool ILog4zManager::enableLogger ( LoggerId  id,
bool  enable 
)
pure virtual

set logger's attribute, thread safe.

◆ findLogger()

virtual LoggerId ILog4zManager::findLogger ( const char *  key)
pure virtual

Find logger. thread safe.

◆ getInstance()

static ILog4zManager* ILog4zManager::getInstance ( )
static

Log4z Singleton.

◆ getPtr()

static ILog4zManager* ILog4zManager::getPtr ( )
inlinestatic

◆ getRef()

static ILog4zManager& ILog4zManager::getRef ( )
inlinestatic

◆ getStatusActiveLoggers()

virtual unsigned int ILog4zManager::getStatusActiveLoggers ( )
pure virtual

◆ getStatusTotalWriteBytes()

virtual unsigned long long ILog4zManager::getStatusTotalWriteBytes ( )
pure virtual

◆ getStatusTotalWriteCount()

virtual unsigned long long ILog4zManager::getStatusTotalWriteCount ( )
pure virtual

◆ getStatusWaitingCount()

virtual unsigned long long ILog4zManager::getStatusWaitingCount ( )
pure virtual

◆ isLoggerEnable()

virtual bool ILog4zManager::isLoggerEnable ( LoggerId  id)
pure virtual

Log4z status statistics, thread safe.

◆ prePushLog()

virtual bool ILog4zManager::prePushLog ( LoggerId  id,
int  level 
)
pure virtual

◆ pushLog()

virtual bool ILog4zManager::pushLog ( LoggerId  id,
int  level,
const char *  log,
const char *  file = NULL,
int  line = 0 
)
pure virtual

Push log, thread safe.

◆ setAutoUpdate()

virtual bool ILog4zManager::setAutoUpdate ( int  interval)
pure virtual

Update logger's attribute from config file, thread safe.

◆ setLoggerDisplay()

virtual bool ILog4zManager::setLoggerDisplay ( LoggerId  id,
bool  enable 
)
pure virtual

◆ setLoggerFileLine()

virtual bool ILog4zManager::setLoggerFileLine ( LoggerId  id,
bool  enable 
)
pure virtual

◆ setLoggerLevel()

virtual bool ILog4zManager::setLoggerLevel ( LoggerId  id,
int  nLevel 
)
pure virtual

◆ setLoggerLimitsize()

virtual bool ILog4zManager::setLoggerLimitsize ( LoggerId  id,
unsigned int  limitsize 
)
pure virtual

◆ setLoggerMonthdir()

virtual bool ILog4zManager::setLoggerMonthdir ( LoggerId  id,
bool  enable 
)
pure virtual

◆ setLoggerName()

virtual bool ILog4zManager::setLoggerName ( LoggerId  id,
const char *  name 
)
pure virtual

◆ setLoggerOutFile()

virtual bool ILog4zManager::setLoggerOutFile ( LoggerId  id,
bool  enable 
)
pure virtual

◆ setLoggerPath()

virtual bool ILog4zManager::setLoggerPath ( LoggerId  id,
const char *  path 
)
pure virtual

◆ start()

virtual bool ILog4zManager::start ( )
pure virtual

Start Log Thread. This method can only be called once by one process.

◆ stop()

virtual bool ILog4zManager::stop ( )
pure virtual

Default the method will be calling at process exit auto.

Default no need to call and no recommended.

◆ updateConfig()

virtual bool ILog4zManager::updateConfig ( )
pure virtual

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