RF24Log  0.1.3
Unified logging library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RF24LogAbstractHandler Class Referenceabstract

An abstract base class for handling log messages. More...

#include <AbstractHandler.h>

Inheritance diagram for RF24LogAbstractHandler:
RF24LogBaseHandler RF24LogPrintfParser ArduinoPrintLogger NativePrintLogger OStreamLogger

Public Member Functions

 RF24LogAbstractHandler ()
 Sets log level to INFO upon instantiation.
 
void log (uint8_t logLevel, const char *vendorId, const char *message, va_list *args)
 log a message. More...
 
void setLogLevel (uint8_t logLevel)
 

Protected Member Functions

virtual void write (uint8_t logLevel, const char *vendorId, const char *message, va_list *args)=0
 

Protected Attributes

uint8_t _logLevel
 

Detailed Description

An abstract base class for handling log messages.

Definition at line 33 of file AbstractHandler.h.

Member Function Documentation

◆ log()

void RF24LogAbstractHandler::log ( uint8_t  logLevel,
const char *  vendorId,
const char *  message,
va_list *  args 
)
virtual

log a message.

Parameters
logLevelThe level of the logging message
vendorIdThe prefixed origin of the message
messageThe message format string. Review the supported format spcifiers.
argsThe sequence of variables used to replace the format specifiers in the same order for which they appear in the message

Implements RF24LogBaseHandler.

Definition at line 26 of file AbstractHandler.cpp.

◆ setLogLevel()

void RF24LogAbstractHandler::setLogLevel ( uint8_t  logLevel)
virtual

set the maximal level of the logged messages.

Parameters
logLevelThe verbosity level used to filter which of the logged messages are output.
See also
Review the descriptions in the Log Levels

Implements RF24LogBaseHandler.

Definition at line 54 of file AbstractHandler.cpp.

◆ write()

virtual void RF24LogAbstractHandler::write ( uint8_t  logLevel,
const char *  vendorId,
const char *  message,
va_list *  args 
)
protectedpure virtual

write log message to its destination

Parameters
logLevelThe level of the logging message
vendorIdThe prefixed origin of the message
messageThe message
argsThe sequence of variables used to replace the format specifiers in the same order for which they appear in the message

Implemented in RF24LogPrintfParser.

Member Data Documentation

◆ _logLevel

uint8_t RF24LogAbstractHandler::_logLevel
protected

The configured log level used to filter which messages are output.

Definition at line 66 of file AbstractHandler.h.


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