Inheritance diagram for MqttClient:

Public Member Functions
	MqttClient (bool withDefaultPayloadParser=true, bool autoDestruct=false)

void	setKeepAlive (uint16_t seconds)

void	setPingRepeatTime (unsigned seconds)

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

bool	connect (const Url &url, const String &uniqueClientName, uint32_t sslOptions=0)
	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=0)

void	setConnectedHandler (MqttDelegate handler)

void	setPublishedHandler (MqttDelegate handler)

void	setMessageHandler (MqttDelegate handler)

void	setDisconnectHandler (TcpClientCompleteDelegate handler)

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

bool	connect (const String &server, int port, bool useSsl=false, uint32_t sslOptions=0) override

bool	connect (IPAddress addr, uint16_t port, bool useSsl=false, uint32_t sslOptions=0) 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 ()

bool	addSslValidator (SslValidatorCallback callback, void *data=nullptr)
	Allows setting of multiple SSL validators after a successful handshake. More...

bool	pinCertificate (const uint8_t *fingerprint, SslFingerprintType type)
	Requires (pins) the remote SSL certificate to match certain fingerprints. More...

bool	pinCertificate (SslFingerprints &fingerprints)
	Requires (pins) the remote SSL certificate to match certain fingerprints. More...

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

err_t	onSslConnected (SSL *ssl) override

void	pushAsyncPart ()

void	freeStreams ()

void	setBuffer (ReadWriteStream *stream)

int	writeString (const char *data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)

int	writeString (const String &data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)

virtual int	write (const char *data, int len, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
	Base write operation. More...

int	write (IDataSourceStream *stream)

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	addSslOptions (uint32_t sslOptions)

bool	setSslClientKeyCert (const uint8_t key, int keyLength, const uint8_t certificate, int certificateLength, const char *keyPassword=nullptr, bool freeAfterHandshake=false) SMING_DEPRECATED
	Sets client private key, certificate and password from memory. More...

bool	setSslClientKeyCert (const SslKeyCertPair &clientKeyCert, bool freeAfterHandshake=false) SMING_DEPRECATED
	Sets client private key, certificate and password from memory. More...

void	freeSslClientKeyCert () SMING_DEPRECATED
	Frees the memory used for the key and certificate pair. More...

bool	setSslKeyCert (const uint8_t key, int keyLength, const uint8_t certificate, int certificateLength, const char *keyPassword=nullptr, bool freeAfterHandshake=false)
	Sets private key, certificate and password from memory for the SSL connection If this methods is called from a client then it sets the client key and certificate If it is called from a server then it sets the server certificate and key. Server and Client certificates differ. Client certificate is used for identification. Server certificate is used for encrypt/decrypt the data. Make sure to use the correct certificate for the desired goal. More...

bool	setSslKeyCert (const SslKeyCertPair &keyCert, bool freeAfterHandshake=false)
	Sets private key, certificate and password from memory for the SSL connection If this methods is called from a client then it sets the client key and certificate If it is called from a server then it sets the server certificate and key. Server and Client certificates differ. Client certificate is used for identification. Server certificate is used for encrypt/decrypt the data. Make sure to use the correct certificate for the desired goal. More...

void	freeSslKeyCert ()
	Frees the memory used for the key and certificate pair. More...

void	setSsl (SSL *ssl)

SSL *	getSsl ()

void	initialize (tcp_pcb *pcb)

bool	internalConnect (IPAddress addr, uint16_t port)

virtual err_t	onPoll ()

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)

Protected Attributes
ReadWriteStream *	buffer = nullptr
	Used internally to buffer arbitrary data via send() methods. More...

IDataSourceStream *	stream = nullptr
	The currently active stream being sent. More...

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 *	ssl = nullptr

SSLCTX *	sslContext = nullptr

SSL_EXTENSIONS *	sslExtension = nullptr

bool	sslConnected = false

uint32_t	sslOptions = 0

SslKeyCertPair	sslKeyCert

bool	freeKeyCertAfterHandshake = false

SslSessionId *	sslSessionId = nullptr

bool	useSsl = false

Member Function Documentation

bool TcpClient::addSslValidator	(	SslValidatorCallback	callback,
		void *	data = `nullptr`
	)

inlineinherited

Allows setting of multiple SSL validators after a successful handshake.

Parameters

callback	The callback function to be invoked on validation
data	The data to pass to the callback

Note: The callback is responsible for releasing the data if appropriate. See SslValidatorCallback for further details.

Return values

bool	true on success, false on failure

bool MqttClient::connect	(	const Url &	url,
		const String &	uniqueClientName,
		uint32_t	sslOptions = `0`
	)

Connect to a MQTT server.

Parameters

url,in	the form "mqtt://user:password@server:port" or "mqtts://user:password@server:port"
client	name

void TcpConnection::freeSslClientKeyCert ( )

inlineinherited

Frees the memory used for the key and certificate pair.

Deprecated:: Use freeSslKeyCert() instead

void TcpConnection::freeSslKeyCert ( )

inlineinherited

Frees the memory used for the key and certificate pair.

bool TcpClient::pinCertificate	(	const uint8_t *	fingerprint,
		SslFingerprintType	type
	)

inlineinherited

Requires (pins) the remote SSL certificate to match certain fingerprints.

Parameters

fingerprint	The fingerprint data against which the match should be performed. Must be allocated on the heap and will be deleted after use. Do not re-use outside of this method.
type	The fingerprint type - see SslFingerprintType for details.

Return values

bool	true on success, false on failure

bool TcpClient::pinCertificate ( SslFingerprints & fingerprints )

inlineinherited

Requires (pins) the remote SSL certificate to match certain fingerprints.

Note: The data inside the fingerprints parameter is passed by reference

Parameters

fingerprints - passes the certificate fingerprints by reference.

Return values

bool	true on success, false on failure

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.

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.

void TcpClient::setCompleteDelegate ( TcpClientCompleteDelegate completeCb = nullptr )

inlineinherited

Set or clear the callback for connection close.

Parameters

completeCb callback delegate or nullptr

void MqttClient::setConnectedHandler ( MqttDelegate handler )

inline

Sets a handler to be called after successful MQTT connection

Parameters

MqttDelegate handler

void TcpConnection::setDestroyedDelegate ( TcpConnectionDestroyedDelegate destroyedDelegate )

inlineinherited

Sets a callback to be called when the object instance is destroyed.

Parameters

TcpServerConnectionDestroyedDelegate destroyedDelegate - callback

void MqttClient::setDisconnectHandler ( TcpClientCompleteDelegate handler )

inline

Sets a handler to be called on disconnect from the server

Parameters

TcpClientCompleteDelegate handler

void MqttClient::setKeepAlive ( uint16_t seconds )

inline

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

Parameters

uint16_t seconds

void MqttClient::setMessageHandler ( MqttDelegate handler )

inline

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

Parameters

MqttDelegate handler

void MqttClient::setPayloadParser ( MqttPayloadParser payloadParser = 0 )

inline

Sets or clears a payload parser (for PUBLISH messages from the server to us) Notice: 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

void MqttClient::setPingRepeatTime ( unsigned seconds )

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

Parameters

unsigned int seconds

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

MqttDelegate handler

void TcpClient::setReceiveDelegate ( TcpClientDataDelegate receiveCb = nullptr )

inlineinherited

Set or clear the callback for received data.

Parameters

receiveCb callback delegate or nullptr

bool TcpConnection::setSslClientKeyCert	(	const uint8_t *	key,
		int	keyLength,
		const uint8_t *	certificate,
		int	certificateLength,
		const char *	keyPassword = `nullptr`,
		bool	freeAfterHandshake = `false`
	)

inlineinherited

Sets client private key, certificate and password from memory.

Deprecated:: Use setSslKeyCert(const uint8_t*, int, const uint8_t*, int, const char*, bool) instead

Note: This method makes copy of the data.

Parameters

const	uint8_t *keyData
int	keyLength
const	uint8_t *certificateData
int	certificateLength
const	char *keyPassword
bool	freeAfterHandshake

Returns: bool true of success, false or failure

bool TcpConnection::setSslClientKeyCert	(	const SslKeyCertPair &	clientKeyCert,
		bool	freeAfterHandshake = `false`
	)

inlineinherited

Sets client private key, certificate and password from memory.

Deprecated:: Use setSslKeyCert(const SslKeyCertPair&, bool) instead

Note: This method passes the certificate key chain by reference

Parameters

SSLKeyCertPair
bool	freeAfterHandshake

Returns: bool true of success, false or failure

bool TcpConnection::setSslKeyCert	(	const uint8_t *	key,
		int	keyLength,
		const uint8_t *	certificate,
		int	certificateLength,
		const char *	keyPassword = `nullptr`,
		bool	freeAfterHandshake = `false`
	)

inlineinherited

Sets private key, certificate and password from memory for the SSL connection If this methods is called from a client then it sets the client key and certificate If it is called from a server then it sets the server certificate and key. Server and Client certificates differ. Client certificate is used for identification. Server certificate is used for encrypt/decrypt the data. Make sure to use the correct certificate for the desired goal.

Note: This method makes copy of the data.

Parameters

const	uint8_t *keyData
int	keyLength
const	uint8_t *certificateData
int	certificateLength
const	char *keyPassword
bool	freeAfterHandshake

Returns: bool true of success, false or failure

bool TcpConnection::setSslKeyCert	(	const SslKeyCertPair &	keyCert,
		bool	freeAfterHandshake = `false`
	)

inlineinherited

Sets private key, certificate and password from memory for the SSL connection If this methods is called from a client then it sets the client key and certificate If it is called from a server then it sets the server certificate and key. Server and Client certificates differ. Client certificate is used for identification. Server certificate is used for encrypt/decrypt the data. Make sure to use the correct certificate for the desired goal.

Note: This method passes the certificate key chain by reference

Parameters

SSLKeyCertPair
bool	freeAfterHandshake

Returns: bool true of success, false or failure

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

Sets last will and testament

Parameters

const	String& topic
const	String& message
uint8_t	flags -QoS, retain, etc flags

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

inline

Todo:: deprecate: Use setWill(const String& topic, const String& message,uint8_t flags) instead

virtual int TcpConnection::write	(	const char *	data,
		int	len,
		uint8_t	apiflags = `TCP_WRITE_FLAG_COPY`
	)

virtualinherited

Base write operation.

Parameters

data
len
apiflags	TCP_WRITE_FLAG_COPY, TCP_WRITE_FLAG_MORE

Return values

int	-1 on error

Reimplemented in FtpDataStream.

Member Data Documentation

ReadWriteStream* TcpClient::buffer = nullptr

protectedinherited

Used internally to buffer arbitrary data via send() methods.

IDataSourceStream* TcpClient::stream = nullptr

protectedinherited

The currently active stream being sent.

uint16_t TcpConnection::timeOut = USHRT_MAX

protectedinherited

By default a TCP connection does not have a time out.

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation