#include <SystemLogger.h>
Public Types | |
| enum | { RTL_SILENT, RTL_FATAL, RTL_ERROR, RTL_WARN, RTL_INFO, RTL_DEBUG, RTL_TRACE, RTL_VERBOSE, RTL_PARANOID } |
Public Member Functions | |
| Logger (const char *name="") | |
| Constructor. | |
| Logger (LogStreamBuf *streambuf) | |
| Constructor. | |
| void | setDateFormat (const char *format) |
| Set date/time format for adding the header. | |
| bool | setLevel (const char *level) |
| Set log level by string. | |
| void | setName (const char *name) |
| Set suffix of date/time string of header. | |
| virtual | ~Logger (void) |
| Virtual destructor. | |
Protected Member Functions | |
| std::string | getDate (void) |
| Get the current formatted date/time string Get the current datetime described by specified format. | |
| virtual void | header (int level) |
| Message prefix appender function. | |
| int | strToLevel (const char *level) |
| Set the log level Set the log level corresponding to the given string. | |
Private Attributes | |
| std::string | m_dateFormat |
| int | m_msEnable |
| std::string | m_name |
| int | m_usEnable |
Static Private Attributes | |
| static const char * | m_levelString [] |
Detailed Description
Logger class.
This class is composed of the buffer class and the format class.
- The buffer class
- The buffer class serializes to the MultiThreading writing and does buffering.
- The buffer class can output the log at two or more output destination. As the example of the output destination, filing, the standard, the log server etc.
- The output destination can be added to the buffer with addStream.
- The format class
- The format class can output it by specifying the log level.
- The format is [Time] [Loglevel] [Ssuffix] [Message].
- [Time] [Loglevel] [Suffix] are added by the automatic operation.
- [Suffix] can be specified.
- Loglevel
- RTL_SILENT
- RTL_FATAL
- RTL_ERROR
- RTL_WARN
- RTL_INFO
- RTL_DEBUG
- RTL_TRACE
- RTL_VERBOSE
- RTL_PARANOID
- The format class can be locked/unlocked to this format object.
Definition at line 99 of file SystemLogger.h.
Member Enumeration Documentation
| anonymous enum |
- Enumerator:
RTL_SILENT RTL_FATAL RTL_ERROR RTL_WARN RTL_INFO RTL_DEBUG RTL_TRACE RTL_VERBOSE RTL_PARANOID
Definition at line 103 of file SystemLogger.h.
Constructor & Destructor Documentation
| Logger::Logger | ( | const char * | name = "" | ) |
Constructor.
Constructor
- Parameters:
-
name suffix of date/time string of header.
Definition at line 41 of file SystemLogger.cpp.
| Logger::Logger | ( | LogStreamBuf * | streambuf | ) |
Constructor.
Constructor
- Parameters:
-
streambuf LogStream object
Definition at line 52 of file SystemLogger.cpp.
| Logger::~Logger | ( | void | ) | [virtual] |
Virtual destructor.
Definition at line 62 of file SystemLogger.cpp.
Member Function Documentation
| std::string Logger::getDate | ( | void | ) | [protected] |
Get the current formatted date/time string Get the current datetime described by specified format.
Get the current formatted date/time string.
- Returns:
- Format specification current datetime
Reimplemented in Tests::LoggerMock.
Definition at line 123 of file SystemLogger.cpp.
| void Logger::header | ( | int | level | ) | [protected, virtual] |
Message prefix appender function.
Subclasses of this class should override this operation, and this function should be defined to append some prefix to the log messages.
Reimplemented from coil::log_stream< _CharT, _Traits >.
Reimplemented in Tests::LoggerMock.
Definition at line 111 of file SystemLogger.cpp.
| void Logger::setDateFormat | ( | const char * | format | ) |
Set date/time format for adding the header.
The format specification string is as follows:
%a abbreviated weekday name %A full weekday name %b abbreviated month name %B full month name %c the standard date and time string %d day of the month, as a number (1-31) %H hour, 24 hour format (0-23) %I hour, 12 hour format (1-12) %j day of the year, as a number (1-366) %m month as a number (1-12). Note: some versions of Microsoft Visual C++ may use values that range from 0-11. %M minute as a number (0-59) %p locale's equivalent of AM or PM %Q millisecond as a number (0-999) from ver 1.1 %q microsecond as a number (0-999) from ver 1.1 %S second as a number (0-59) %U week of the year, sunday as the first day %w weekday as a decimal (0-6, sunday=0) %W week of the year, monday as the first day %x standard date string %X standard time string %y year in decimal, without the century (0-99) %Y year in decimal, with the century %Z time zone name %% a percent sign
- Parameters:
-
fmt Datetime format
Reimplemented in Tests::LoggerMock.
Definition at line 85 of file SystemLogger.cpp.
| bool Logger::setLevel | ( | const char * | level | ) |
| void Logger::setName | ( | const char * | name | ) |
Set suffix of date/time string of header.
Set the suffix string added after the datatime of the header.
- Parameters:
-
suffix Suffix string
Reimplemented in Tests::LoggerMock.
Definition at line 99 of file SystemLogger.cpp.
| int Logger::strToLevel | ( | const char * | level | ) | [protected] |
Set the log level Set the log level corresponding to the given string.
Set the log level.
- Parameters:
-
lv Log level string
- Returns:
- The set log level
Reimplemented in Tests::LoggerMock.
Definition at line 171 of file SystemLogger.cpp.
Member Data Documentation
std::string RTC::Logger::m_dateFormat [private] |
Definition at line 341 of file SystemLogger.h.
const char * Logger::m_levelString [static, private] |
{
" SILENT: ",
" FATAL: ",
" ERROR: ",
" WARNING: ",
" INFO: ",
" DEBUG: ",
" TRACE: ",
" VERBOSE: ",
" PARANOID: "
}
Definition at line 342 of file SystemLogger.h.
int RTC::Logger::m_msEnable [private] |
Definition at line 343 of file SystemLogger.h.
std::string RTC::Logger::m_name [private] |
Definition at line 340 of file SystemLogger.h.
int RTC::Logger::m_usEnable [private] |
Definition at line 344 of file SystemLogger.h.
The documentation for this class was generated from the following files: