#include <MqttClient.h>

Inheritance diagram for MqttClient:
[legend]
Collaboration diagram for MqttClient:
[legend]

Public Member Functions

 MqttClient (bool withDefaultPayloadParser=true, bool autoDestruct=false)
 
 ~MqttClient ()
 
void setKeepAlive (uint16_t seconds)
 Sets keep-alive time. That information is sent during connection to the server. More...
 
void setPingRepeatTime (uint16_t seconds)
 
bool setWill (const String &topic, const String &message, uint8_t flags=0)
 
bool connect (const Url &url, const String &uniqueClientName)
 Connect to a MQTT server. More...
 
bool publish (const String &topic, const String &message, uint8_t flags=0)
 
bool publish (const String &topic, IDataSourceStream *stream, uint8_t flags=0)
 
bool subscribe (const String &topic)
 
bool unsubscribe (const String &topic)
 
void setEventHandler (mqtt_type_t type, MqttDelegate handler)
 
void setPayloadParser (MqttPayloadParser payloadParser=nullptr)
 Sets or clears a payload parser (for PUBLISH messages from the server to us) More...
 
void setConnectedHandler (MqttDelegate handler)
 Sets a handler to be called after successful MQTT connection. More...
 
void setPublishedHandler (MqttDelegate handler)
 Sets a handler to be called after receiving confirmation from the server for a published message from the client. More...
 
void setMessageHandler (MqttDelegate handler)
 Sets a handler to be called after receiving a PUBLISH message from the server. More...
 
void setDisconnectHandler (TcpClientCompleteDelegate handler)
 Sets a handler to be called on disconnect from the server. More...
 
bool setWill (const String &topic, const String &message, int QoS, bool retained=false)
 
bool publishWithQoS (const String &topic, const String &message, int QoS, bool retained=false, MqttMessageDeliveredCallback onDelivery=nullptr)
 
void setCallback (MqttStringSubscriptionCallback subscriptionCallback=nullptr)
 Provide a function to be called when a message is received from the broker. More...
 

Protected Member Functions

void onReadyToSendData (TcpConnectionEvent sourceEvent) override
 
void onFinished (TcpClientState finishState) override
 
- Protected Member Functions inherited from TcpClient
err_t onConnected (err_t err) override
 
err_t onReceive (pbuf *buf) override
 
err_t onSent (uint16_t len) override
 
void onError (err_t err) override
 
void onClosed () override
 Gets called when there is/was a tcp connection, the latter does not have to be established, that is closed due to error or normal disconnect. More...
 
void onReadyToSendData (TcpConnectionEvent sourceEvent) override
 
void pushAsyncPart ()
 
void freeStreams ()
 
void setBuffer (ReadWriteStream *stream)
 
 TcpClient (bool autoDestruct)
 
 TcpClient (tcp_pcb *clientTcp, TcpClientDataDelegate clientReceive, TcpClientCompleteDelegate onCompleted)
 
 TcpClient (TcpClientCompleteDelegate onCompleted, TcpClientEventDelegate onReadyToSend, TcpClientDataDelegate onReceive=nullptr)
 
 TcpClient (TcpClientCompleteDelegate onCompleted, TcpClientDataDelegate onReceive=nullptr)
 
 TcpClient (TcpClientDataDelegate onReceive)
 
 ~TcpClient ()
 
bool connect (const String &server, int port, bool useSsl=false) override
 
bool connect (IpAddress addr, uint16_t port, bool useSsl=false) override
 
void close () override
 
void setReceiveDelegate (TcpClientDataDelegate receiveCb=nullptr)
 Set or clear the callback for received data. More...
 
void setCompleteDelegate (TcpClientCompleteDelegate completeCb=nullptr)
 Set or clear the callback for connection close. More...
 
bool send (const char *data, uint16_t len, bool forceCloseAfterSent=false)
 
bool sendString (const String &data, bool forceCloseAfterSent=false)
 
bool isProcessing ()
 
TcpClientState getConnectionState ()
 
void setCloseAfterSent (bool ignoreIncomingData=false)
 
void commit ()
 Tries to send the pending data immediately. More...
 
- Protected Member Functions inherited from TcpConnection
void initialize (tcp_pcb *pcb)
 
bool internalConnect (IpAddress addr, uint16_t port)
 
bool sslCreateSession ()
 
virtual void sslInitSession (Ssl::Session &session)
 Override in inherited classes to perform custom session initialisation. More...
 
virtual err_t onPoll ()
 
void trySend (TcpConnectionEvent event)
 
err_t internalOnConnected (err_t err)
 
err_t internalOnReceive (pbuf *p, err_t err)
 
err_t internalOnSent (uint16_t len)
 
err_t internalOnPoll ()
 
void internalOnError (err_t err)
 
void internalOnDnsResponse (const char *name, LWIP_IP_ADDR_T *ipaddr, int port)
 
 TcpConnection (bool autoDestruct)
 
 TcpConnection (tcp_pcb *connection, bool autoDestruct)
 
virtual ~TcpConnection ()
 
int writeString (const char *data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 Writes string data directly to the TCP buffer. More...
 
int writeString (const String &data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 Writes string data directly to the TCP buffer. More...
 
virtual int write (const char *data, int len, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 Base write operation. More...
 
int write (IDataSourceStream *stream)
 Writes stream data directly to the TCP buffer. More...
 
uint16_t getAvailableWriteSize ()
 
void flush ()
 
void setTimeOut (uint16_t waitTimeOut)
 
IpAddress getRemoteIp () const
 
uint16_t getRemotePort () const
 
void setDestroyedDelegate (TcpConnectionDestroyedDelegate destroyedDelegate)
 Sets a callback to be called when the object instance is destroyed. More...
 
void setSslInitHandler (Ssl::Session::InitDelegate handler)
 Set the SSL session initialisation callback. More...
 
bool setSslConnection (Ssl::Connection *connection)
 
Ssl::SessiongetSsl ()
 Get a pointer to the current SSL session object. More...
 
- Protected Member Functions inherited from IpConnection
bool joinMulticastGroup (IpAddress localIp, IpAddress multicastIp)
 Uses IGMP to add a local network interface to multicast group. More...
 
bool joinMulticastGroup (IpAddress multicastIp)
 Uses IGMP to add all local network interfaces to multicast group. More...
 
bool leaveMulticastGroup (IpAddress localIp, IpAddress multicastIp)
 Uses IGMP to remove a local network interface from multicast group. More...
 
bool leaveMulticastGroup (IpAddress multicastIp)
 Uses IGMP to remove all local network interfaces from multicast group. More...
 

Additional Inherited Members

- Protected Attributes inherited from TcpClient
ReadWriteStreambuffer = nullptr
 Used internally to buffer arbitrary data via send() methods. More...
 
IDataSourceStreamstream = nullptr
 The currently active stream being sent. More...
 
- Protected Attributes inherited from TcpConnection
tcp_pcb * tcp = nullptr
 
uint16_t sleep = 0
 
uint16_t timeOut = USHRT_MAX
 By default a TCP connection does not have a time out. More...
 
bool canSend = true
 
bool autoSelfDestruct = true
 
Ssl::Sessionssl = nullptr
 
Ssl::Session::InitDelegate sslInit
 
bool useSsl = false
 

Constructor & Destructor Documentation

◆ MqttClient()

MqttClient::MqttClient ( bool  withDefaultPayloadParser = true,
bool  autoDestruct = false 
)

◆ ~MqttClient()

MqttClient::~MqttClient ( )

Member Function Documentation

◆ connect()

bool MqttClient::connect ( const Url url,
const String uniqueClientName 
)

Connect to a MQTT server.

Parameters
urlURL in the form "mqtt://user:password@server:port" or "mqtts://user:password@server:port"
uniqueClientName
Return values
bool

◆ onFinished()

void MqttClient::onFinished ( TcpClientState  finishState)
overrideprotectedvirtual

Reimplemented from TcpClient.

◆ onReadyToSendData()

void MqttClient::onReadyToSendData ( TcpConnectionEvent  sourceEvent)
overrideprotectedvirtual

Reimplemented from TcpConnection.

◆ publish() [1/2]

bool MqttClient::publish ( const String topic,
const String message,
uint8_t  flags = 0 
)

◆ publish() [2/2]

bool MqttClient::publish ( const String topic,
IDataSourceStream stream,
uint8_t  flags = 0 
)

◆ publishWithQoS()

bool MqttClient::publishWithQoS ( const String topic,
const String message,
int  QoS,
bool  retained = false,
MqttMessageDeliveredCallback  onDelivery = nullptr 
)
inline

bool publish(String& topic, String& message, bool retained = false) Use publish(const String& topic, const String& message, uint8_t flags = 0) instead.

Todo:
deprecate: Use publish(const String& topic, const String& message, uint8_t flags = 0) instead. If you want to have a callback that should be triggered on successful delivery of messages then use setEventHandler(MQTT_TYPE_PUBACK, youCallback) instead.

◆ setCallback()

void MqttClient::setCallback ( MqttStringSubscriptionCallback  subscriptionCallback = nullptr)
inline

Provide a function to be called when a message is received from the broker.

Todo:
deprecate: Use setEventHandler(MQTT_TYPE_PUBLISH, MqttDelegate handler) instead.

◆ setConnectedHandler()

void MqttClient::setConnectedHandler ( MqttDelegate  handler)
inline

Sets a handler to be called after successful MQTT connection.

Parameters
handler

◆ setDisconnectHandler()

void MqttClient::setDisconnectHandler ( TcpClientCompleteDelegate  handler)
inline

Sets a handler to be called on disconnect from the server.

Parameters
handler

◆ setEventHandler()

void MqttClient::setEventHandler ( mqtt_type_t  type,
MqttDelegate  handler 
)
inline

◆ setKeepAlive()

void MqttClient::setKeepAlive ( uint16_t  seconds)
inline

Sets keep-alive time. That information is sent during connection to the server.

Parameters
seconds

◆ setMessageHandler()

void MqttClient::setMessageHandler ( MqttDelegate  handler)
inline

Sets a handler to be called after receiving a PUBLISH message from the server.

Parameters
handler

◆ setPayloadParser()

void MqttClient::setPayloadParser ( MqttPayloadParser  payloadParser = nullptr)
inline

Sets or clears a payload parser (for PUBLISH messages from the server to us)

Note
We no longer have size limitation for incoming or outgoing messages but in order to prevent running out of memory we have a "sane" payload parser that will read up to 1K of payload

◆ setPingRepeatTime()

void MqttClient::setPingRepeatTime ( uint16_t  seconds)
inline

Sets the interval in which to ping the remote server if there was no activity

Parameters
seconds

◆ setPublishedHandler()

void MqttClient::setPublishedHandler ( MqttDelegate  handler)
inline

Sets a handler to be called after receiving confirmation from the server for a published message from the client.

Parameters
handler

◆ setWill() [1/2]

bool MqttClient::setWill ( const String topic,
const String message,
uint8_t  flags = 0 
)

Sets last will and testament

Parameters
topic
message
flagsQoS, retain, etc flags
Return values
bool

◆ setWill() [2/2]

bool MqttClient::setWill ( const String topic,
const String message,
int  QoS,
bool  retained = false 
)
inline

◆ subscribe()

bool MqttClient::subscribe ( const String topic)

◆ unsubscribe()

bool MqttClient::unsubscribe ( const String topic)

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