|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.paho.client.mqttv3.internal.CommsTokenStore
public class CommsTokenStore
Provides a "token" based system for storing and tracking actions across
multiple threads.
When a message is sent, a token is associated with the message
and saved using the saveToken(MqttToken, MqttWireMessage)
method. Anyone interested
in tacking the state can call one of the wait methods on the token or using
the asynchronous listener callback method on the operation.
The CommsReceiver
class, on another thread, reads responses back from
the network. It uses the response to find the relevant token, which it can then
notify.
Note:
Ping, connect and disconnect do not have a unique message id as
only one outstanding request of each type is allowed to be outstanding
Constructor Summary | |
---|---|
CommsTokenStore(String logContext)
|
Method Summary | |
---|---|
void |
clear()
Empties the token store without notifying any of the tokens. |
int |
count()
|
MqttDeliveryToken[] |
getOutstandingDelTokens()
|
Vector |
getOutstandingTokens()
|
MqttToken |
getToken(MqttWireMessage message)
Based on the message type that has just been received return the associated token from the token store or null if one does not exist. |
MqttToken |
getToken(String key)
|
void |
open()
|
protected void |
quiesce(MqttException quiesceResponse)
|
MqttToken |
removeToken(MqttWireMessage message)
|
MqttToken |
removeToken(String key)
|
protected MqttDeliveryToken |
restoreToken(MqttPublish message)
Restores a token after a client restart. |
protected void |
saveToken(MqttToken token,
MqttWireMessage message)
|
protected void |
saveToken(MqttToken token,
String key)
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CommsTokenStore(String logContext)
Method Detail |
---|
public MqttToken getToken(MqttWireMessage message)
message
- whose token is to be returned
public MqttToken getToken(String key)
public MqttToken removeToken(MqttWireMessage message)
public MqttToken removeToken(String key)
protected MqttDeliveryToken restoreToken(MqttPublish message)
protected void saveToken(MqttToken token, MqttWireMessage message) throws MqttException
MqttException
protected void saveToken(MqttToken token, String key)
protected void quiesce(MqttException quiesceResponse)
public void open()
public MqttDeliveryToken[] getOutstandingDelTokens()
public Vector getOutstandingTokens()
public void clear()
public int count()
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |