com.cinterion.mqtt

Class MqttClient

java.lang.Object

com.cinterion.mqtt.MqttClient

All Implemented Interfaces:

AutoCloseable

public class MqttClient
extends Object
implements AutoCloseable

The MqttClient class can be used to create MQTT client instances.

Constructor Summary

Constructors

Constructor and Description
MqttClient() Creates an MQTT context.

Method Summary

Modifier and Type	Method and Description
void	close() Destroys an MQTT context.
void	connect(MqttConfig config) Connects to an MQTT broker.
void	disconnect() Disconnects from an MQTT broker.
void	publish(String topic, byte[] payload, int qos, boolean retained) Publishes a message to a particular topic.
short	publishGetMsgId(String topic, byte[] payload, int qos, boolean retained) Publishes a message to a particular topic.
void	setConnectCallback(MqttConnectCallback callback) Sets a connect callback, which is invoked when the connect is successful.
void	setMessageCallback(MqttMessageCallback callback) Sets a message callback, which is invoked when a message is received for a subscribed topic.
void	setPublishCallback(MqttPublishCallback callback) Sets a publish callback, which is invoked when PUBACK(QOS1)/PUBREC,PUBCOMP(QOS2).
void	setSubscribeCallback(MqttSubscribeCallback callback) Sets a subscribe callback, which is invoked when a subscription is granted or denied.
void	subscribe(String topic, int qos) Subscribes to a topic.
void	unsubscribe(String topic) Unsubscribes from a topic.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MqttClient

public MqttClient()

Creates an MQTT context.

Method Detail

close

public void close()

Destroys an MQTT context.

Specified by:

close in interface AutoCloseable

connect

public void connect(MqttConfig config)
             throws IOException

Connects to an MQTT broker.

Parameters:

config - MQTT client configuration.

Throws:

IOException - on failure.

disconnect

public void disconnect()

Disconnects from an MQTT broker.

publish

public void publish(String topic,
                    byte[] payload,
                    int qos,
                    boolean retained)
             throws IOException

Publishes a message to a particular topic.

Parameters:

topic - MQTT topic.

payload - MQTT payload.

qos - QOS to be used for the message.

retained - Retain flag.

Throws:

IOException - on failure.

publishGetMsgId

public short publishGetMsgId(String topic,
                             byte[] payload,
                             int qos,
                             boolean retained)
                      throws IOException

Publishes a message to a particular topic.

Parameters:

topic - MQTT topic.

payload - MQTT payload.

qos - QOS to be used for the message.

retained - Retain flag.

Returns:

Message ID of the MQTT publish message.

Throws:

IOException - on failure.

setConnectCallback

public void setConnectCallback(@Nullable
                               MqttConnectCallback callback)

Sets a connect callback, which is invoked when the connect is successful.

Parameters:

callback - Callback to be invoked.

setMessageCallback

public void setMessageCallback(@Nullable
                               MqttMessageCallback callback)

Sets a message callback, which is invoked when a message is received for a subscribed topic.

Parameters:

callback - Callback to be invoked.

setPublishCallback

public void setPublishCallback(@Nullable
                               MqttPublishCallback callback)

Sets a publish callback, which is invoked when PUBACK(QOS1)/PUBREC,PUBCOMP(QOS2).

Parameters:

callback - Callback to be invoked.

setSubscribeCallback

public void setSubscribeCallback(@Nullable
                                 MqttSubscribeCallback callback)

Sets a subscribe callback, which is invoked when a subscription is granted or denied.

Parameters:

callback - Callback to be invoked.

subscribe

public void subscribe(String topic,
                      int qos)
               throws IOException

Subscribes to a topic.

Parameters:

topic - Subscription topic.

qos - QoS to be used.

Throws:

IOException - on failure.

unsubscribe

public void unsubscribe(String topic)
                 throws IOException

Unsubscribes from a topic.

Parameters:

topic - Topic from which to unsubscribe.

Throws:

IOException - on failure.