#include <StackLogger.h>

Inheritance diagram for Boardcore::StackLogger:

Collaboration diagram for Boardcore::StackLogger:

Public Member Functions
void	updateStack (uint8_t threadId)

void	log ()

Public Member Functions inherited from Boardcore::Singleton< StackLogger >
	Singleton (const Singleton &)=delete

Singleton &	operator= (const Singleton &)=delete

Friends
class	Singleton< StackLogger >

Additional Inherited Members
Static Public Member Functions inherited from Boardcore::Singleton< StackLogger >
static StackLogger &	getInstance ()

Protected Member Functions inherited from Boardcore::Singleton< StackLogger >
	Singleton ()

Detailed Description

Log the absolute free stack of each thread 1 times per second StackLogger::update(id) must be called periodically from each thread in order for data to be updated

Definition at line 45 of file StackLogger.h.

Member Function Documentation

◆ log()

void Boardcore::StackLogger::log ( )

inline

Logs the most up-to-date stack data Call this function periodically

Definition at line 72 of file StackLogger.h.

◆ updateStack()

void Boardcore::StackLogger::updateStack ( uint8_t threadId )

inline

Update the stored absolute free stack associated to the calling thread. This function must be called by the thread to be logged.

Parameters

threadId Unique id identifying the thread

Definition at line 55 of file StackLogger.h.

Friends And Related Symbol Documentation

◆ Singleton< StackLogger >

friend class Singleton< StackLogger >

friend

Definition at line 1 of file StackLogger.h.

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

src/shared/diagnostic/StackLogger.h

Public Member Functions