ESPHome 2026.3.0
Loading...
Searching...
No Matches
esphome::LwIPLock Class Reference

Helper class to lock the lwIP TCPIP core when making lwIP API calls from non-TCPIP threads. More...

#include <helpers.h>

Public Member Functions

 LwIPLock (const LwIPLock &)=delete
 
LwIPLockoperator= (const LwIPLock &)=delete
 
 LwIPLock ()
 
 ~LwIPLock ()
 
 LwIPLock ()
 
 ~LwIPLock ()
 

Detailed Description

Helper class to lock the lwIP TCPIP core when making lwIP API calls from non-TCPIP threads.

This is needed on multi-threaded platforms (ESP32) when CONFIG_LWIP_TCPIP_CORE_LOCKING is enabled, and on RP2040 when CYW43 WiFi is active (cyw43_arch_lwip_begin/end).

On platforms without lwIP core locking (ESP8266, LibreTiny, Zephyr), this is a no-op defined inline so the compiler can eliminate all call overhead.

Definition at line 1810 of file helpers.h.

Constructor & Destructor Documentation

◆ LwIPLock() [1/3]

esphome::LwIPLock::LwIPLock ( const LwIPLock & )
delete

◆ LwIPLock() [2/3]

esphome::LwIPLock::LwIPLock ( )

Definition at line 38 of file helpers.cpp.

◆ ~LwIPLock() [1/2]

esphome::LwIPLock::~LwIPLock ( )

Definition at line 55 of file helpers.cpp.

◆ LwIPLock() [3/3]

esphome::LwIPLock::LwIPLock ( )
inline

Definition at line 1822 of file helpers.h.

◆ ~LwIPLock() [2/2]

esphome::LwIPLock::~LwIPLock ( )
inline

Definition at line 1823 of file helpers.h.

Member Function Documentation

◆ operator=()

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

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