ESPHome  2024.11.2
Public Member Functions
esphome::Mutex Class Reference

Mutex implementation, with API based on the unavailable std::mutex. More...

#include <helpers.h>

Public Member Functions

 Mutex ()
 
 Mutex (const Mutex &)=delete
 
 ~Mutex ()
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
Mutexoperator= (const Mutex &)=delete
 

Detailed Description

Mutex implementation, with API based on the unavailable std::mutex.

Note
This mutex is non-recursive, so take care not to try to obtain the mutex while it is already taken.

Definition at line 545 of file helpers.h.

Constructor & Destructor Documentation

◆ Mutex() [1/2]

esphome::Mutex::Mutex ( )

Definition at line 626 of file helpers.cpp.

◆ Mutex() [2/2]

esphome::Mutex::Mutex ( const Mutex )
delete

◆ ~Mutex()

esphome::Mutex::~Mutex ( )

Definition at line 627 of file helpers.cpp.

Member Function Documentation

◆ lock()

void esphome::Mutex::lock ( )

Definition at line 628 of file helpers.cpp.

◆ operator=()

Mutex& esphome::Mutex::operator= ( const Mutex )
delete

◆ try_lock()

bool esphome::Mutex::try_lock ( )

Definition at line 629 of file helpers.cpp.

◆ unlock()

void esphome::Mutex::unlock ( )

Definition at line 630 of file helpers.cpp.


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