org.eclipse.paho.client.mqttv3.internal

Class ClientComms

java.lang.Object

org.eclipse.paho.client.mqttv3.internal.ClientComms

public class ClientComms
extends Object

Handles client communications with the server. Sends and receives MQTT V3 messages.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILD_LEVEL
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
ClientComms(IMqttAsyncClient client, MqttClientPersistence persistence, MqttPingSender pingSender, ExecutorService executorService) Creates a new ClientComms object, using the specified module to handle the network calls.

Method Summary

Modifier and Type	Method and Description
MqttToken	checkForActivity()
MqttToken	checkForActivity(IMqttActionListener pingCallback)
void	close() Close and tidy up.
void	connect(MqttConnectOptions options, MqttToken token) Sends a connect message and waits for an ACK or NACK.
void	connectComplete(MqttConnack cack, MqttException mex)
void	deleteBufferedMessage(int bufferIndex)
protected void	deliveryComplete(int messageId)
protected void	deliveryComplete(MqttPublish msg)
void	disconnect(MqttDisconnect disconnect, long quiesceTimeout, MqttToken token)
void	disconnectForcibly(long quiesceTimeout, long disconnectTimeout) Disconnect the connection and reset all the states.
MqttMessage	getBufferedMessage(int bufferIndex)
int	getBufferedMessageCount()
IMqttAsyncClient	getClient()
ClientState	getClientState()
MqttConnectOptions	getConOptions()
Properties	getDebug()
long	getKeepAlive()
int	getNetworkModuleIndex()
NetworkModule[]	getNetworkModules()
MqttDeliveryToken[]	getPendingDeliveryTokens()
protected MqttTopic	getTopic(String topic)
boolean	isClosed()
boolean	isConnected()
boolean	isConnecting()
boolean	isDisconnected()
boolean	isDisconnecting()
boolean	isResting()
void	messageArrivedComplete(int messageId, int qos)
void	notifyReconnect() When the client automatically reconnects, we want to send all messages from the buffer first before allowing the user to send any messages
void	removeMessageListener(String topicFilter)
void	sendNoWait(MqttWireMessage message, MqttToken token) Sends a message to the broker if in connected state, but only waits for the message to be stored, before returning.
void	setCallback(MqttCallback mqttCallback)
void	setDisconnectedMessageBuffer(DisconnectedMessageBuffer disconnectedMessageBuffer)
void	setManualAcks(boolean manualAcks)
void	setMessageListener(String topicFilter, IMqttMessageListener messageListener)
void	setNetworkModuleIndex(int index)
void	setNetworkModules(NetworkModule[] networkModules)
void	setReconnectCallback(MqttCallbackExtended callback)
void	setRestingState(boolean resting) When Automatic reconnect is enabled, we want ClientComs to enter the 'resting' state if disconnected.
void	shutdownConnection(MqttToken token, MqttException reason) Shuts down the connection to the server.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static String VERSION

BUILD_LEVEL

public static String BUILD_LEVEL

Constructor Detail

ClientComms

public ClientComms(IMqttAsyncClient client,
                   MqttClientPersistence persistence,
                   MqttPingSender pingSender,
                   ExecutorService executorService)
            throws MqttException

Creates a new ClientComms object, using the specified module to handle the network calls.

Throws:

MqttException

Method Detail

sendNoWait

public void sendNoWait(MqttWireMessage message,
                       MqttToken token)
                throws MqttException

Sends a message to the broker if in connected state, but only waits for the message to be stored, before returning.

Throws:

MqttException

close

public void close()
           throws MqttException

Close and tidy up. Call each main class and let it tidy up e.g. releasing the token store which normally survives a disconnect.

Throws:

MqttException - if not disconnected

connect

public void connect(MqttConnectOptions options,
                    MqttToken token)
             throws MqttException

Sends a connect message and waits for an ACK or NACK. Connecting is a special case which will also start up the network connection, receive thread, and keep alive thread.

Throws:

MqttException

connectComplete

public void connectComplete(MqttConnack cack,
                            MqttException mex)
                     throws MqttException

Throws:

MqttException

shutdownConnection

public void shutdownConnection(MqttToken token,
                               MqttException reason)

Shuts down the connection to the server. This may have been invoked as a result of a user calling disconnect or an abnormal disconnection. The method may be invoked multiple times in parallel as each thread when it receives an error uses this method to ensure that shutdown completes successfully.

disconnect

public void disconnect(MqttDisconnect disconnect,
                       long quiesceTimeout,
                       MqttToken token)
                throws MqttException

Throws:

MqttException

disconnectForcibly

public void disconnectForcibly(long quiesceTimeout,
                               long disconnectTimeout)
                        throws MqttException

Disconnect the connection and reset all the states.

Throws:

MqttException

isConnected

public boolean isConnected()

isConnecting

public boolean isConnecting()

isDisconnected

public boolean isDisconnected()

isDisconnecting

public boolean isDisconnecting()

isClosed

public boolean isClosed()

isResting

public boolean isResting()

setCallback

public void setCallback(MqttCallback mqttCallback)

setReconnectCallback

public void setReconnectCallback(MqttCallbackExtended callback)

setManualAcks

public void setManualAcks(boolean manualAcks)

messageArrivedComplete

public void messageArrivedComplete(int messageId,
                                   int qos)
                            throws MqttException

Throws:

MqttException

setMessageListener

public void setMessageListener(String topicFilter,
                               IMqttMessageListener messageListener)

removeMessageListener

public void removeMessageListener(String topicFilter)

getTopic

protected MqttTopic getTopic(String topic)

setNetworkModuleIndex

public void setNetworkModuleIndex(int index)

getNetworkModuleIndex

public int getNetworkModuleIndex()

getNetworkModules

public NetworkModule[] getNetworkModules()

setNetworkModules

public void setNetworkModules(NetworkModule[] networkModules)

getPendingDeliveryTokens

public MqttDeliveryToken[] getPendingDeliveryTokens()

deliveryComplete

protected void deliveryComplete(MqttPublish msg)
                         throws MqttPersistenceException

Throws:

MqttPersistenceException

deliveryComplete

protected void deliveryComplete(int messageId)
                         throws MqttPersistenceException

Throws:

MqttPersistenceException

getClient

public IMqttAsyncClient getClient()

getKeepAlive

public long getKeepAlive()

getClientState

public ClientState getClientState()

getConOptions

public MqttConnectOptions getConOptions()

getDebug

public Properties getDebug()

checkForActivity

public MqttToken checkForActivity()

checkForActivity

public MqttToken checkForActivity(IMqttActionListener pingCallback)

setRestingState

public void setRestingState(boolean resting)

When Automatic reconnect is enabled, we want ClientComs to enter the 'resting' state if disconnected. This will allow us to publish messages

Parameters:

resting -

setDisconnectedMessageBuffer

public void setDisconnectedMessageBuffer(DisconnectedMessageBuffer disconnectedMessageBuffer)

getBufferedMessageCount

public int getBufferedMessageCount()

getBufferedMessage

public MqttMessage getBufferedMessage(int bufferIndex)

deleteBufferedMessage

public void deleteBufferedMessage(int bufferIndex)

notifyReconnect

public void notifyReconnect()

When the client automatically reconnects, we want to send all messages from the buffer first before allowing the user to send any messages

Throws:

MqttException