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 ()
Mutex &	operator= (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 924 of file helpers.h.

Constructor & Destructor Documentation

Mutex() [1/2]

esphome::Mutex::Mutex

(

)

Definition at line 23 of file helpers.cpp.

Mutex() [2/2]

esphome::Mutex::Mutex ( const Mutex & )

delete

~Mutex()

esphome::Mutex::~Mutex

(

)

Definition at line 24 of file helpers.cpp.

Member Function Documentation

lock()

void esphome::Mutex::lock

(

)

Definition at line 25 of file helpers.cpp.

operator=()

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

delete

try_lock()

bool esphome::Mutex::try_lock

(

)

Definition at line 26 of file helpers.cpp.

unlock()

void esphome::Mutex::unlock

(

)

Definition at line 27 of file helpers.cpp.

---

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

• esphome/core/helpers.h
• esphome/components/esp32/helpers.cpp
• esphome/components/esp8266/helpers.cpp
• esphome/components/host/helpers.cpp
• esphome/components/libretiny/helpers.cpp
• esphome/components/rp2040/helpers.cpp
• esphome/components/zephyr/core.cpp