|
ESPHome 2026.11.0b6
|
#include <mqtt_backend.h>
Public Types | |
| using | on_connect_callback_t = void(bool session_present) |
| using | on_disconnect_callback_t = void(MQTTClientDisconnectReason reason) |
| using | on_subscribe_callback_t = void(uint16_t packet_id, uint8_t return_code) |
| using | on_unsubscribe_callback_t = void(uint16_t packet_id) |
| using | on_message_callback_t = void(const char *topic, const char *payload, size_t len, size_t index, size_t total) |
| using | on_publish_user_callback_t = void(uint16_t packet_id) |
Public Member Functions | |
| virtual void | set_keep_alive (uint16_t keep_alive)=0 |
| virtual void | set_client_id (const char *client_id)=0 |
| virtual void | set_clean_session (bool clean_session)=0 |
| virtual void | set_credentials (const char *username, const char *password)=0 |
| virtual void | set_will (const char *topic, uint8_t qos, bool retain, const char *payload)=0 |
| virtual void | set_server (network::IPAddress ip, uint16_t port)=0 |
| virtual void | set_server (const char *host, uint16_t port)=0 |
| virtual void | set_on_connect (std::function< on_connect_callback_t > &&callback)=0 |
| virtual void | set_on_disconnect (std::function< on_disconnect_callback_t > &&callback)=0 |
| virtual void | set_on_subscribe (std::function< on_subscribe_callback_t > &&callback)=0 |
| virtual void | set_on_unsubscribe (std::function< on_unsubscribe_callback_t > &&callback)=0 |
| virtual void | set_on_message (std::function< on_message_callback_t > &&callback)=0 |
| virtual void | set_on_publish (std::function< on_publish_user_callback_t > &&callback)=0 |
| virtual bool | connected () const =0 |
| virtual void | connect ()=0 |
| virtual void | disconnect ()=0 |
| virtual bool | subscribe (const char *topic, uint8_t qos)=0 |
| virtual bool | can_subscribe () const |
| Whether another SUBSCRIBE fits the inbound queue. | |
| virtual bool | unsubscribe (const char *topic)=0 |
| virtual bool | publish (const char *topic, const char *payload, size_t length, uint8_t qos, bool retain)=0 |
| virtual bool | publish_tracked (const MQTTMessage &message)=0 |
| Publish at QoS 1 or higher and keep the packet id, so publish_acknowledged() tells when the broker has confirmed it. | |
| virtual bool | publish_acknowledged () const =0 |
| Whether the broker has confirmed the message from the last publish_tracked(). | |
| virtual bool | publish (const MQTTMessage &message) |
| virtual void | loop () |
Definition at line 51 of file mqtt_backend.h.
| using esphome::mqtt::MQTTBackend::on_connect_callback_t = void(bool session_present) |
Definition at line 53 of file mqtt_backend.h.
| using esphome::mqtt::MQTTBackend::on_disconnect_callback_t = void(MQTTClientDisconnectReason reason) |
Definition at line 54 of file mqtt_backend.h.
| using esphome::mqtt::MQTTBackend::on_message_callback_t = void(const char *topic, const char *payload, size_t len, size_t index, size_t total) |
Definition at line 57 of file mqtt_backend.h.
| using esphome::mqtt::MQTTBackend::on_publish_user_callback_t = void(uint16_t packet_id) |
Definition at line 58 of file mqtt_backend.h.
| using esphome::mqtt::MQTTBackend::on_subscribe_callback_t = void(uint16_t packet_id, uint8_t return_code) |
Definition at line 55 of file mqtt_backend.h.
| using esphome::mqtt::MQTTBackend::on_unsubscribe_callback_t = void(uint16_t packet_id) |
Definition at line 56 of file mqtt_backend.h.
|
inlinevirtual |
Whether another SUBSCRIBE fits the inbound queue.
Reimplemented in esphome::mqtt::MQTTBackendESP32.
Definition at line 78 of file mqtt_backend.h.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
inlinevirtual |
Reimplemented in esphome::mqtt::MQTTBackendESP32.
Definition at line 93 of file mqtt_backend.h.
|
pure virtual |
|
inlinevirtual |
Reimplemented in esphome::mqtt::MQTTBackendESP32, esphome::mqtt::MQTTBackendESP8266, and esphome::mqtt::MQTTBackendLibreTiny.
Definition at line 87 of file mqtt_backend.h.
|
pure virtual |
Whether the broker has confirmed the message from the last publish_tracked().
Implemented in esphome::mqtt::MQTTBackendESP32, esphome::mqtt::MQTTBackendESP8266, and esphome::mqtt::MQTTBackendLibreTiny.
|
pure virtual |
Publish at QoS 1 or higher and keep the packet id, so publish_acknowledged() tells when the broker has confirmed it.
Used for the shutdown message, whose connection is about to close.
Implemented in esphome::mqtt::MQTTBackendESP32, esphome::mqtt::MQTTBackendESP8266, and esphome::mqtt::MQTTBackendLibreTiny.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |