LoggerFile Class Reference

Log backend that appends to a file through the platform's devoptab path. More...

#include <LoggerFile.h>

Inheritance diagram for LoggerFile:

Public Member Functions
bool	init (const LogConfig &config) override
	Opens whatever handle/socket/file this backend needs, using only fields from config (nothing hardcoded).
void	shutdown () override
	Releases whatever init() acquired.
void	write (LogLevel level, const char *line, size_t len) override
	Writes one already-formatted, newline-terminated line.
const char *	name () const override
	Short identifier for diagnostics (eg. "UDP", "File").

Detailed Description

Log backend that appends to a file through the platform's devoptab path.

Generic - identical on every platform.

Definition at line 25 of file LoggerFile.h.

Constructor & Destructor Documentation

~LoggerFile()

LoggerFile::~LoggerFile ( )

inlineoverride

Definition at line 29 of file LoggerFile.h.

Member Function Documentation

init()

bool LoggerFile::init ( const LogConfig & config )

overridevirtual

Opens whatever handle/socket/file this backend needs, using only fields from config (nothing hardcoded).

Returning false leaves the backend registered but inert - Logger will simply skip it in dispatch() rather than treat it as fatal, so eg. a missing SD card or unattached USB Gecko degrades gracefully instead of taking the rest of logging down with it.

Implements LoggingDriver.

Definition at line 8 of file LoggerFile.cpp.

name()

const char * LoggerFile::name ( ) const

inlineoverridevirtual

Short identifier for diagnostics (eg. "UDP", "File").

Implements LoggingDriver.

Definition at line 34 of file LoggerFile.h.

shutdown()

void LoggerFile::shutdown ( )

overridevirtual

Releases whatever init() acquired.

Must be safe to call even if init() was never called or returned false.

Implements LoggingDriver.

Definition at line 28 of file LoggerFile.cpp.

write()

void LoggerFile::write ( LogLevel level, const char * line, size_t len )

overridevirtual

Writes one already-formatted, newline-terminated line.

len does not include the terminating NUL. Must not allocate.

Implements LoggingDriver.

Definition at line 39 of file LoggerFile.cpp.

---

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

• source/drivers/LoggerFile.h
• source/drivers/LoggerFile.cpp