Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.async_client.AsyncMQTTClient Class Reference
Inheritance diagram for homeassistant.components.mqtt.async_client.AsyncMQTTClient:
[legend]
Collaboration diagram for homeassistant.components.mqtt.async_client.AsyncMQTTClient:
[legend]

Public Member Functions

None setup (self)
 

Private Attributes

 _callback_mutex
 
 _in_callback_mutex
 
 _in_message_mutex
 
 _mid_generate_mutex
 
 _msgtime_mutex
 
 _out_message_mutex
 
 _reconnect_delay_mutex
 

Detailed Description

Async MQTT Client.

Wrapper around paho.mqtt.client.Client to remove the locking
that is not needed since we are running in an async event loop.

Definition at line 40 of file async_client.py.

Member Function Documentation

◆ setup()

None homeassistant.components.mqtt.async_client.AsyncMQTTClient.setup (   self)
Async MQTT Client.

Wrapper around paho.mqtt.client.Client to remove the locking
that is not needed since we are running in an async event loop.
Set up the client.

All the threading locks are replaced with NullLock
since the client is running in an async event loop
and will never run in multiple threads.

Definition at line 47 of file async_client.py.

Member Data Documentation

◆ _callback_mutex

homeassistant.components.mqtt.async_client.AsyncMQTTClient._callback_mutex
private

Definition at line 55 of file async_client.py.

◆ _in_callback_mutex

homeassistant.components.mqtt.async_client.AsyncMQTTClient._in_callback_mutex
private

Definition at line 54 of file async_client.py.

◆ _in_message_mutex

homeassistant.components.mqtt.async_client.AsyncMQTTClient._in_message_mutex
private

Definition at line 58 of file async_client.py.

◆ _mid_generate_mutex

homeassistant.components.mqtt.async_client.AsyncMQTTClient._mid_generate_mutex
private

Definition at line 60 of file async_client.py.

◆ _msgtime_mutex

homeassistant.components.mqtt.async_client.AsyncMQTTClient._msgtime_mutex
private

Definition at line 56 of file async_client.py.

◆ _out_message_mutex

homeassistant.components.mqtt.async_client.AsyncMQTTClient._out_message_mutex
private

Definition at line 57 of file async_client.py.

◆ _reconnect_delay_mutex

homeassistant.components.mqtt.async_client.AsyncMQTTClient._reconnect_delay_mutex
private

Definition at line 59 of file async_client.py.


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