tijos.framework.networkcenter.mqtt

Class MqttClient

java.lang.Object

tijos.framework.networkcenter.mqtt.MqttClient

public class MqttClient
extends Object

MQTT client

Constructor Summary

Constructors

Constructor and Description
MqttClient(String serverURI, String clientId) Initialize the MQTT server URI, client id

Method Summary

Modifier and Type	Method and Description
void	close() Close and release the resources
void	connect(MqttConnectOptions options) Connect to the server
void	connect(MqttConnectOptions options, Object userContext) Connect to the server with a context
void	connectAcked(int connResult)
void	disconnect() Disconnect the server
static String	generateClientId() Returns a randomly generated client identifier based on the the fixed prefix (tijos) and the system time.
String	getClientId()
String	getServerURI()
boolean	isConnected()
void	messageArrived(int msgNum) the event to indicate that there are messages arrived from server
void	messageCompleted(int completedNum, int waitNum) the event to indicate that there are messages to server are completed
void	networkStateChange(int oldState, int newState) network state is changed
int	publish(String topic, byte[] payload, int qos, boolean retained) publish topic to the server
void	reconnect() User triggered attempt to reconnect
void	SetMqttClientListener(MqttClientListener listener)
int	subscribe(String topic, int qos) subscribe a topic from the server
int	unsubscribe(String topic) unsubscribe a topic from the server

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttClient

public MqttClient(String serverURI,
                  String clientId)

Initialize the MQTT server URI, client id

Parameters:

serverURI - MQTT server URI

clientId - Current client id

Method Detail

close

public void close()
           throws MqttException

Close and release the resources

Throws:

MqttException - If a MQTT error occurs

connect

public void connect(MqttConnectOptions options)
             throws MqttException

Connect to the server

Parameters:

options - MQTT options

Throws:

MqttException - If a MQTT error occurs

connect

public void connect(MqttConnectOptions options,
                    Object userContext)
             throws MqttException

Connect to the server with a context

Parameters:

options - MQTT options

userContext - user context object

Throws:

MqttException - If a MQTT error occurs

connectAcked

public void connectAcked(int connResult)
                  throws IOException

Parameters:

connResult - the MQTT CONNACT result value

Throws:

IOException - If an I/O error occurs

disconnect

public void disconnect()
                throws MqttException

Disconnect the server

Throws:

MqttException - If a MQTT error occurs

generateClientId

public static String generateClientId()

Returns a randomly generated client identifier based on the the fixed prefix (tijos) and the system time.

When cleanSession is set to false, an application must ensure it uses the same client identifier when it reconnects to the server to resume state and maintain assured message delivery.

Returns:

a generated client identifier

See Also:

MqttConnectOptions.setCleanSession(boolean)

getClientId

public String getClientId()

getServerURI

public String getServerURI()

isConnected

public boolean isConnected()

messageArrived

public void messageArrived(int msgNum)
                    throws IOException

the event to indicate that there are messages arrived from server

Throws:

IOException - If an I/O error occurs

messageCompleted

public void messageCompleted(int completedNum,
                             int waitNum)
                      throws IOException

the event to indicate that there are messages to server are completed

Parameters:

completedNum - the message number completed

waitNum - the message number waiting

Throws:

IOException - If an I/O error occurs

networkStateChange

public void networkStateChange(int oldState,
                               int newState)
                        throws IOException

network state is changed

Parameters:

oldState - the last state

newState - the current state

Throws:

IOException - If an I/O error occurs

publish

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

publish topic to the server

Parameters:

topic - the topic name

payload - the payload data

qos - the qos

retained - if retained in server

Returns:

the message id for the current publish, it is used in the publishCompleted event

Throws:

MqttException - If a MQTT error occurs

reconnect

public void reconnect()
               throws MqttException

User triggered attempt to reconnect

Throws:

MqttException - If a MQTT error occurs

SetMqttClientListener

public void SetMqttClientListener(MqttClientListener listener)

subscribe

public int subscribe(String topic,
                     int qos)
              throws MqttException

subscribe a topic from the server

Parameters:

topic - the topic name to subscribe

qos - the qos to subscribe

Returns:

the message id for the current subscribe, it is used in the subscribeCompleted event

Throws:

MqttException - If a MQTT error occurs

unsubscribe

public int unsubscribe(String topic)
                throws MqttException

unsubscribe a topic from the server

Parameters:

topic - the topic name to subscribe

Returns:

the message id for the current subscribe, it is used in the unsubscribeCompleted event

Throws:

MqttException - If a MQTT error occurs