ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
mqtt_backend.h
Go to the documentation of this file.
1#pragma once
3#ifdef USE_MQTT
4#include <string>
5#include <map>
8
9namespace esphome::mqtt {
10
22
24enum class MQTTTransport : uint8_t {
28};
29
32 public:
33 explicit DispatchGuard(bool &flag) : flag_(flag), previous_(flag) { flag = true; }
34 ~DispatchGuard() { this->flag_ = this->previous_; }
35 DispatchGuard(const DispatchGuard &) = delete;
37
38 protected:
39 bool &flag_;
41};
42
45 std::string topic;
46 std::string payload;
47 uint8_t qos;
48 bool retain;
49};
50
52 public:
53 using on_connect_callback_t = void(bool session_present);
55 using on_subscribe_callback_t = void(uint16_t packet_id, uint8_t return_code);
56 using on_unsubscribe_callback_t = void(uint16_t packet_id);
57 using on_message_callback_t = void(const char *topic, const char *payload, size_t len, size_t index, size_t total);
58 using on_publish_user_callback_t = void(uint16_t packet_id);
59
60 virtual void set_keep_alive(uint16_t keep_alive) = 0;
61 virtual void set_client_id(const char *client_id) = 0;
62 virtual void set_clean_session(bool clean_session) = 0;
63 virtual void set_credentials(const char *username, const char *password) = 0;
64 virtual void set_will(const char *topic, uint8_t qos, bool retain, const char *payload) = 0;
65 virtual void set_server(network::IPAddress ip, uint16_t port) = 0;
66 virtual void set_server(const char *host, uint16_t port) = 0;
67 virtual void set_on_connect(std::function<on_connect_callback_t> &&callback) = 0;
68 virtual void set_on_disconnect(std::function<on_disconnect_callback_t> &&callback) = 0;
69 virtual void set_on_subscribe(std::function<on_subscribe_callback_t> &&callback) = 0;
70 virtual void set_on_unsubscribe(std::function<on_unsubscribe_callback_t> &&callback) = 0;
71 virtual void set_on_message(std::function<on_message_callback_t> &&callback) = 0;
72 virtual void set_on_publish(std::function<on_publish_user_callback_t> &&callback) = 0;
73 virtual bool connected() const = 0;
74 virtual void connect() = 0;
75 virtual void disconnect() = 0;
76 virtual bool subscribe(const char *topic, uint8_t qos) = 0;
78 virtual bool can_subscribe() const { return true; }
79 virtual bool unsubscribe(const char *topic) = 0;
80 virtual bool publish(const char *topic, const char *payload, size_t length, uint8_t qos, bool retain) = 0;
83 virtual bool publish_tracked(const MQTTMessage &message) = 0;
85 virtual bool publish_acknowledged() const = 0;
86
87 virtual bool publish(const MQTTMessage &message) {
88 return publish(message.topic.c_str(), message.payload.c_str(), message.payload.length(), message.qos,
89 message.retain);
90 }
91
92 // called from MQTTClient::loop()
93 virtual void loop() {}
94};
95
96} // namespace esphome::mqtt
97#endif
Sets a flag for the guard's scope and restores its previous value on exit.
DispatchGuard & operator=(const DispatchGuard &)=delete
DispatchGuard(const DispatchGuard &)=delete
virtual void set_credentials(const char *username, const char *password)=0
virtual bool subscribe(const char *topic, uint8_t qos)=0
virtual void set_client_id(const char *client_id)=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_clean_session(bool clean_session)=0
virtual void set_on_message(std::function< on_message_callback_t > &&callback)=0
void(MQTTClientDisconnectReason reason) on_disconnect_callback_t
virtual void disconnect()=0
virtual bool publish(const char *topic, const char *payload, size_t length, uint8_t qos, bool retain)=0
virtual void set_on_unsubscribe(std::function< on_unsubscribe_callback_t > &&callback)=0
void(uint16_t packet_id) on_unsubscribe_callback_t
virtual void connect()=0
void(const char *topic, const char *payload, size_t len, size_t index, size_t total) on_message_callback_t
void(uint16_t packet_id, uint8_t return_code) on_subscribe_callback_t
virtual bool unsubscribe(const char *topic)=0
void(uint16_t packet_id) on_publish_user_callback_t
virtual void set_on_disconnect(std::function< on_disconnect_callback_t > &&callback)=0
virtual void set_server(network::IPAddress ip, uint16_t port)=0
virtual void set_on_publish(std::function< on_publish_user_callback_t > &&callback)=0
void(bool session_present) on_connect_callback_t
virtual bool connected() const =0
virtual bool publish_acknowledged() const =0
Whether the broker has confirmed the message from the last publish_tracked().
virtual void set_will(const char *topic, uint8_t qos, bool retain, const char *payload)=0
virtual void set_on_subscribe(std::function< on_subscribe_callback_t > &&callback)=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 ha...
virtual bool can_subscribe() const
Whether another SUBSCRIBE fits the inbound queue.
virtual bool publish(const MQTTMessage &message)
virtual void set_keep_alive(uint16_t keep_alive)=0
const LogString * message
Definition component.cpp:35
MQTTTransport
Transport for the broker connection; only the ESP-IDF backend supports WebSocket.
const void size_t len
Definition hal.h:68
internal struct for MQTT messages.
uint8_t qos
QoS. Only for last will testaments.
uint16_t length
Definition tt21100.cpp:0