org.eclipse.paho.android.service

Class MqttTokenAndroid

java.lang.Object

org.eclipse.paho.android.service.MqttTokenAndroid

All Implemented Interfaces:

org.eclipse.paho.client.mqttv3.IMqttToken

Direct Known Subclasses:

MqttDeliveryTokenAndroid

 class MqttTokenAndroid
extends java.lang.Object
implements org.eclipse.paho.client.mqttv3.IMqttToken

Implementation of the IMqttToken interface for use from within the MqttAndroidClient implementation

Constructor Summary

Constructors

Constructor and Description
MqttTokenAndroid(MqttAndroidClient client, java.lang.Object userContext, org.eclipse.paho.client.mqttv3.IMqttActionListener listener) Standard constructor
MqttTokenAndroid(MqttAndroidClient client, java.lang.Object userContext, org.eclipse.paho.client.mqttv3.IMqttActionListener listener, java.lang.String[] topics) Constructor for use with subscribe operations

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.paho.client.mqttv3.IMqttActionListener	getActionCallback()
org.eclipse.paho.client.mqttv3.IMqttAsyncClient	getClient()
org.eclipse.paho.client.mqttv3.MqttException	getException()
int	getMessageId()
java.lang.String[]	getTopics()
java.lang.Object	getUserContext()
boolean	isComplete()
(package private) void	notifyComplete() notify successful completion of the operation
(package private) void	notifyFailure(java.lang.Throwable exception) notify unsuccessful completion of the operation
void	setActionCallback(org.eclipse.paho.client.mqttv3.IMqttActionListener listener)
(package private) void	setComplete(boolean complete)
(package private) void	setDelegate(org.eclipse.paho.client.mqttv3.IMqttToken delegate)
(package private) void	setException(org.eclipse.paho.client.mqttv3.MqttException exception)
void	setUserContext(java.lang.Object userContext)
void	waitForCompletion()
void	waitForCompletion(long timeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttTokenAndroid

MqttTokenAndroid(MqttAndroidClient client,
                java.lang.Object userContext,
                org.eclipse.paho.client.mqttv3.IMqttActionListener listener)

Standard constructor

Parameters:

client - used to pass MqttAndroidClient object

userContext - used to pass context

listener - optional listener that will be notified when the action completes. Use null if not required.

MqttTokenAndroid

MqttTokenAndroid(MqttAndroidClient client,
                java.lang.Object userContext,
                org.eclipse.paho.client.mqttv3.IMqttActionListener listener,
                java.lang.String[] topics)

Constructor for use with subscribe operations

Parameters:

client - used to pass MqttAndroidClient object

userContext - used to pass context

listener - optional listener that will be notified when the action completes. Use null if not required.

topics - topics to subscribe to, which can include wildcards.

Method Detail

waitForCompletion

public void waitForCompletion()
                       throws org.eclipse.paho.client.mqttv3.MqttException,
                              org.eclipse.paho.client.mqttv3.MqttSecurityException

Specified by:

waitForCompletion in interface org.eclipse.paho.client.mqttv3.IMqttToken

Throws:

org.eclipse.paho.client.mqttv3.MqttException

org.eclipse.paho.client.mqttv3.MqttSecurityException

See Also:

IMqttToken.waitForCompletion()

waitForCompletion

public void waitForCompletion(long timeout)
                       throws org.eclipse.paho.client.mqttv3.MqttException,
                              org.eclipse.paho.client.mqttv3.MqttSecurityException

Specified by:

waitForCompletion in interface org.eclipse.paho.client.mqttv3.IMqttToken

Throws:

org.eclipse.paho.client.mqttv3.MqttException

org.eclipse.paho.client.mqttv3.MqttSecurityException

See Also:

IMqttToken.waitForCompletion(long)

notifyComplete

void notifyComplete()

notify successful completion of the operation

notifyFailure

void notifyFailure(java.lang.Throwable exception)

notify unsuccessful completion of the operation

isComplete

public boolean isComplete()

Specified by:

isComplete in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.isComplete()

setComplete

void setComplete(boolean complete)

getException

public org.eclipse.paho.client.mqttv3.MqttException getException()

Specified by:

getException in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.getException()

setException

void setException(org.eclipse.paho.client.mqttv3.MqttException exception)

getClient

public org.eclipse.paho.client.mqttv3.IMqttAsyncClient getClient()

Specified by:

getClient in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.getClient()

setActionCallback

public void setActionCallback(org.eclipse.paho.client.mqttv3.IMqttActionListener listener)

Specified by:

setActionCallback in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.setActionCallback(IMqttActionListener)

getActionCallback

public org.eclipse.paho.client.mqttv3.IMqttActionListener getActionCallback()

Specified by:

getActionCallback in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.getActionCallback()

getTopics

public java.lang.String[] getTopics()

Specified by:

getTopics in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.getTopics()

setUserContext

public void setUserContext(java.lang.Object userContext)

Specified by:

setUserContext in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.setUserContext(Object)

getUserContext

public java.lang.Object getUserContext()

Specified by:

getUserContext in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.getUserContext()

setDelegate

void setDelegate(org.eclipse.paho.client.mqttv3.IMqttToken delegate)

getMessageId

public int getMessageId()

Specified by:

getMessageId in interface org.eclipse.paho.client.mqttv3.IMqttToken

See Also:

IMqttToken.getMessageId()