From cc8ace92f17c8e5aef7d68ff316e5cd038cd36b5 Mon Sep 17 00:00:00 2001 From: Nathan Lasseter Date: Wed, 22 May 2013 15:34:00 +0100 Subject: Initial Commit --- .../eclipse/paho/client/mqttv3/MqttCallback.html | 298 +++++++ .../org/eclipse/paho/client/mqttv3/MqttClient.html | 959 +++++++++++++++++++++ .../paho/client/mqttv3/MqttClientPersistence.html | 421 +++++++++ .../paho/client/mqttv3/MqttConnectOptions.html | 726 ++++++++++++++++ .../client/mqttv3/MqttDefaultFilePersistence.html | 506 +++++++++++ .../paho/client/mqttv3/MqttDeliveryToken.html | 322 +++++++ .../eclipse/paho/client/mqttv3/MqttException.html | 803 +++++++++++++++++ .../eclipse/paho/client/mqttv3/MqttMessage.html | 520 +++++++++++ .../paho/client/mqttv3/MqttPersistable.html | 387 +++++++++ .../client/mqttv3/MqttPersistenceException.html | 332 +++++++ .../paho/client/mqttv3/MqttSecurityException.html | 290 +++++++ .../org/eclipse/paho/client/mqttv3/MqttTopic.html | 323 +++++++ .../paho/client/mqttv3/class-use/MqttCallback.html | 160 ++++ .../paho/client/mqttv3/class-use/MqttClient.html | 135 +++ .../mqttv3/class-use/MqttClientPersistence.html | 178 ++++ .../mqttv3/class-use/MqttConnectOptions.html | 159 ++++ .../class-use/MqttDefaultFilePersistence.html | 135 +++ .../client/mqttv3/class-use/MqttDeliveryToken.html | 194 +++++ .../client/mqttv3/class-use/MqttException.html | 357 ++++++++ .../paho/client/mqttv3/class-use/MqttMessage.html | 196 +++++ .../client/mqttv3/class-use/MqttPersistable.html | 193 +++++ .../mqttv3/class-use/MqttPersistenceException.html | 374 ++++++++ .../mqttv3/class-use/MqttSecurityException.html | 225 +++++ .../paho/client/mqttv3/class-use/MqttTopic.html | 198 +++++ .../eclipse/paho/client/mqttv3/package-frame.html | 72 ++ .../paho/client/mqttv3/package-summary.html | 422 +++++++++ .../eclipse/paho/client/mqttv3/package-tree.html | 157 ++++ .../eclipse/paho/client/mqttv3/package-use.html | 210 +++++ 28 files changed, 9252 insertions(+) create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttCallback.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttClient.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttClientPersistence.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttDefaultFilePersistence.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttDeliveryToken.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttException.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttMessage.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttPersistable.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttPersistenceException.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttSecurityException.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttTopic.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttCallback.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttClient.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttClientPersistence.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttConnectOptions.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttDefaultFilePersistence.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttDeliveryToken.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttException.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttMessage.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttPersistable.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttPersistenceException.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttSecurityException.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttTopic.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-frame.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-summary.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-tree.html create mode 100644 libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-use.html (limited to 'libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3') diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttCallback.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttCallback.html new file mode 100644 index 0000000..9fb4015 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttCallback.html @@ -0,0 +1,298 @@ + + + + + + +MqttCallback (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Interface MqttCallback

+
+
+
public interface MqttCallback
+ +

+Asynchronous message listener. Classes implementing this interface + can be passed to MqttClient.setCallback(MqttCallback), + which will create a call back on this interface. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconnectionLost(java.lang.Throwable cause) + +
+          This method is called when the connection to the server is lost.
+ voiddeliveryComplete(MqttDeliveryToken token) + +
+          Called when delivery for a message has been completed, and all + acknowledgements have been received.
+ voidmessageArrived(MqttTopic topic, + MqttMessage message) + +
+          This method is called when a message arrives from the server. + +
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+connectionLost

+
+public void connectionLost(java.lang.Throwable cause)
+
+
This method is called when the connection to the server is lost. +

+

+
Parameters:
cause - the reason behind the loss of connection.
+
+
+
+ +

+messageArrived

+
+public void messageArrived(MqttTopic topic,
+                           MqttMessage message)
+                    throws java.lang.Exception
+
+
This method is called when a message arrives from the server. + +

+ This method is invoked synchronously by the MQTT client. An + acknowledgment on the network is not sent back to the server until this + method returns cleanly.

+

+ If an implementation of this method throws an Exception, then the + client will be shut down. When the client is next re-connected, any QoS + 1 or 2 messages will be redelivered.

+

+ Any additional messages which arrive while an + implementation of this method is running, will build up in memory, and + will then back up on the network.

+

+ If an application needs to persist data, then it + should ensure the data is persisted prior to returning from this method, as + after returning from this method, the message is considered to have been + delivered, and will not be reproducable.

+

+ It is possible to send a new message within an implementation of this callback + (for example, a response to this message), but the implementation must not + disconnect the client, as it will be impossible to send an acknowledgement for + the message being processed, and a deadlock will occur.

+

+

+
Parameters:
topic - the topic on which the message arrived.
message - the actual message. +
Throws: +
java.lang.Exception - if a terminal error has occurred, and the client should be + shut down.
+
+
+
+ +

+deliveryComplete

+
+public void deliveryComplete(MqttDeliveryToken token)
+
+
Called when delivery for a message has been completed, and all + acknowledgements have been received. The supplied token will be same + token which was returned when the message was first sent, if it was + sent using MqttTopic.publish(MqttMessage). +

+

+
Parameters:
token - the delivery token associated with the message.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttClient.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttClient.html new file mode 100644 index 0000000..3a14a1a --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttClient.html @@ -0,0 +1,959 @@ + + + + + + +MqttClient (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttClient

+
+java.lang.Object
+  extended byorg.eclipse.paho.client.mqttv3.MqttClient
+
+
+
All Implemented Interfaces:
org.eclipse.paho.client.mqttv3.internal.DestinationProvider
+
+
+
+
public class MqttClient
extends java.lang.Object
implements org.eclipse.paho.client.mqttv3.internal.DestinationProvider
+ +

+Lightweight client for talking to a server via the MQTT version 3 + protocol. The client allows an application to use publish/subscribe + messaging. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Constructor Summary
MqttClient(java.lang.String serverURI, + java.lang.String clientId) + +
+          Creates an MqttClient to connect to the specified address, using the + specified client identifier.
MqttClient(java.lang.String serverURI, + java.lang.String clientId, + MqttClientPersistence persistence) + +
+          Creates an MqttClient to connect to the specified address, using the + specified client identifer and persistence implementation.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconnect() + +
+          Connects to a server using the default options. +
+ voidconnect(MqttConnectOptions options) + +
+          Connects to a server using the specified options. +
+ voiddisconnect() + +
+          Disconnects from the server, which quiesces for up to a + maximum of thirty seconds, to allow the client to finish any work it + currently has.
+ voiddisconnect(long quiesceTimeout) + +
+          Disconnects from the server. +
+static java.lang.StringgenerateClientId() + +
+          Returns a randomly generated client identifier based on the current user's login + name and the system time. +
+ java.lang.StringgetClientId() + +
+          Returns the client ID used by this client.
+ MqttDeliveryToken[]getPendingDeliveryTokens() + +
+          Returns the delivery tokens for any outstanding publish operations.
+ java.lang.StringgetServerURI() + +
+          Returns the address of the server used by this client, as a URI. +
+ MqttTopicgetTopic(java.lang.String topic) + +
+          Gets a topic object which can be used to publish messages. +
+ booleanisConnected() + +
+          Determines if this client is currently connected to the + server.
+ voidsetCallback(MqttCallback callback) + +
+          Sets the callback listener to use for asynchronously received + messages. +
+ voidsubscribe(java.lang.String topicFilter) + +
+          Subscribes to a topic, which may include wildcards, using the default + options.
+ voidsubscribe(java.lang.String[] topicFilters) + +
+          Subscribes to multiple topics, each of which may include wildcards, + using the default options.
+ voidsubscribe(java.lang.String[] topicFilters, + int[] qos) + +
+          Subscribes to multiple topics, each of which may include wildcards, + using the specified options.
+ voidsubscribe(java.lang.String topicFilter, + int qos) + +
+          Subscribes to a topic, which may include wildcards, using the specified + options.
+ voidunsubscribe(java.lang.String topicFilter) + +
+          Unsubscribes from a topic.
+ voidunsubscribe(java.lang.String[] topicFilters) + +
+          Unsubscribes from multiple topics.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+MqttClient

+
+public MqttClient(java.lang.String serverURI,
+                  java.lang.String clientId)
+           throws MqttException
+
+
Creates an MqttClient to connect to the specified address, using the + specified client identifier. The address + should be a URI, using a scheme of either "tcp://" for a TCP connection + or "ssl://" for a TCP connection secured by SSL/TLS. For example: +
    +
  • tcp://localhost:1883
    • +
  • ssl://localhost:8883
    • +
+

+ If the port is not specified, it will + default to 1883 for "tcp://" URIs, and 8883 for "ssl://" URIs. +

+

+ The client identifier should be unique across all clients connecting to the same + server. A convenience method is provided to generate a random client id that + should satisfy this criteria - generateClientId(). As the client identifier + is used by the server to identify a client when it reconnects, the client must use the + same identifier between connections if durable subscriptions are to be used. +

+

+ In Java SE, SSL can be configured in one of several ways, which the + client will use in the following order: +

+ + +

In Java ME, the platform settings are used for SSL connections.

+ +

A default instance of MqttDefaultFilePersistence is used by + the client. To specify a different persistence implementation, or to turn + off persistence, use the MqttClient(String, String, MqttClientPersistence) constructor. +

+

Parameters:
serverURI - the address to connect to, specified as a URI
clientId - the client ID to use +
Throws: +
java.lang.IllegalArgumentException - if the URI does not start with + "tcp://", "ssl://" or "local://". +
java.lang.IllegalArgumentException - if the clientId is null or is greater than 23 characters in length +
MqttException - if any other problem was encountered
+
+ +

+MqttClient

+
+public MqttClient(java.lang.String serverURI,
+                  java.lang.String clientId,
+                  MqttClientPersistence persistence)
+           throws MqttException
+
+
Creates an MqttClient to connect to the specified address, using the + specified client identifer and persistence implementation. The address + should be a URI, using a scheme of either "tcp://" for a TCP connection + or "ssl://" for a TCP connection secured by SSL/TLS. For example: +
    +
  • tcp://localhost:1883
    • +
  • ssl://localhost:8883
    • +
  • local://FirstBroker
    • +
+

+ If the port is not specified, it will + default to 1883 for "tcp://" URIs, and 8883 for "ssl://" URIs. +

+

+ The client identifier should be unique across all clients connecting to the same + server. A convenience method is provided to generate a random client id that + should satisfy this criteria - generateClientId(). As the client identifier + is used by the server to identify a client when it reconnects, the client must use the + same identifier between connections if durable subscriptions are to be used. +

+

+ In Java SE, SSL can be configured in one of several ways, which the + client will use in the following order: +

+ + +

In Java ME, the platform settings are used for SSL connections.

+ + The persistence mechanism is used to enable reliable messaging. + For qualities of server (QoS) 1 or 2 to work, messages must be persisted + to disk by both the client and the server. If this is not done, then + a failure in the client or server will result in lost messages. It + is the application's responsibility to provide an implementation of the + MqttClientPersistence interface, which the client can use to + persist messages. If the application is only sending QoS 0 messages, + then this is not needed. + +

An implementation of file-based persistence is provided in the + class MqttDefaultFilePersistence. + If no persistence is needed, it can be explicitly set to null.

+

+

Parameters:
serverURI - the address to connect to, specified as a URI
clientId - the client ID to use
persistence - the persistence mechanism to use. +
Throws: +
java.lang.IllegalArgumentException - if the URI does not start with + "tcp://", "ssl://" or "local://". +
java.lang.IllegalArgumentException - if the clientId is null or is greater than 23 characters in length +
MqttException - if any other problem was encountered
+ + + + + + + + +
+Method Detail
+ +

+connect

+
+public void connect()
+             throws MqttSecurityException,
+                    MqttException
+
+
Connects to a server using the default options. + It is recommended to call setCallback(MqttCallback) prior to + connecting. +

+

+
+
+
+ +
Throws: +
MqttSecurityException +
MqttException
+
+
+
+ +

+connect

+
+public void connect(MqttConnectOptions options)
+             throws MqttSecurityException,
+                    MqttException
+
+
Connects to a server using the specified options. + It is recommended to call setCallback(MqttCallback) prior to + connecting. +

+

+
+
+
+ +
Throws: +
MqttSecurityException +
MqttException
+
+
+
+ +

+disconnect

+
+public void disconnect()
+                throws MqttException
+
+
Disconnects from the server, which quiesces for up to a + maximum of thirty seconds, to allow the client to finish any work it + currently has. +

+

+
+
+
+ +
Throws: +
MqttException
See Also:
disconnect(long)
+
+
+
+ +

+disconnect

+
+public void disconnect(long quiesceTimeout)
+                throws MqttException
+
+
Disconnects from the server. + This method must not be called from inside MqttCallback methods. +

+ Firstly, the client will wait for all MqttCallback methods to + complete. It will then quiesce for the specified time, to allow for + work which has already been accepted to complete - for example, it will + wait for the QoS 2 flows from earlier publications to complete. After + the quiesce timeout, the client will disconnect from the server. When + the client is next connected, any QoS 1 or 2 messages which have not + completed will be retried.

+

+

+
+
+
+
Parameters:
quiesceTimeout - the amount of time in milliseconds to allow for existing work to finish + before disconnecting. A value of zero or less means the client will + not quiesce. +
Throws: +
MqttException
+
+
+
+ +

+isConnected

+
+public boolean isConnected()
+
+
Determines if this client is currently connected to the + server. +

+

+
+
+
+ +
Returns:
true if connected, false otherwise.
+
+
+
+ +

+getClientId

+
+public java.lang.String getClientId()
+
+
Returns the client ID used by this client. +

+

+
+
+
+ +
Returns:
the client ID used by this client.
+
+
+
+ +

+getServerURI

+
+public java.lang.String getServerURI()
+
+
Returns the address of the server used by this client, as a URI. + The format is the same as specified on the constructor. +

+

+
+
+
+ +
Returns:
the server's address, as a URI String.
See Also:
MqttClient(String, String)
+
+
+
+ +

+getTopic

+
+public MqttTopic getTopic(java.lang.String topic)
+
+
Gets a topic object which can be used to publish messages. +

When you build an application, + the design of the topic tree should take into account the following principles + of topic name syntax and semantics:

+ +
    +
  • A topic must be at least one character long.
    • +
  • Topic names are case sensitive. For example, ACCOUNTS and Accounts are + two different topics.
    • +
  • Topic names can include the space character. For example, Accounts + payable is a valid topic.
    • +
  • A leading "/" creates a distinct topic. For example, /finance is + different from finance. /finance matches "+/+" and "/+", but + not "+".
    • +
  • Do not include the null character (Unicode \x0000) in + any topic.
    • +
+ +

The following principles apply to the construction and content of a topic + tree:

+ +
    +
  • The length is limited to 64k but within that there are no limits to the + number of levels in a topic tree.
    • +
  • There can be any number of root nodes; that is, there can be any number + of topic trees.
    • +
+

+

+

+
Specified by:
getTopic in interface org.eclipse.paho.client.mqttv3.internal.DestinationProvider
+
+
+
Parameters:
topic - the topic to use, for example "finance/stock/ibm". +
Returns:
an MqttTopic object, which can be used to publish messages to + the topic. +
Throws: +
java.lang.IllegalArgumentException - if the topic contains a '+' or '#' + wildcard character.
+
+
+
+ +

+subscribe

+
+public void subscribe(java.lang.String topicFilter)
+               throws MqttException,
+                      MqttSecurityException
+
+
Subscribes to a topic, which may include wildcards, using the default + options. The setCallback(MqttCallback) method should be called + before this method, otherwise any received messages will be discarded. +

+

+
+
+
+ +
Throws: +
MqttException +
MqttSecurityException
See Also:
subscribe(String[], int[])
+
+
+
+ +

+subscribe

+
+public void subscribe(java.lang.String[] topicFilters)
+               throws MqttException,
+                      MqttSecurityException
+
+
Subscribes to multiple topics, each of which may include wildcards, + using the default options. The setCallback(MqttCallback) method should be called + before this method, otherwise any received messages will be discarded. +

+

+
+
+
+ +
Throws: +
MqttException +
MqttSecurityException
See Also:
subscribe(String[], int[])
+
+
+
+ +

+subscribe

+
+public void subscribe(java.lang.String topicFilter,
+                      int qos)
+               throws MqttException,
+                      MqttSecurityException
+
+
Subscribes to a topic, which may include wildcards, using the specified + options. The setCallback(MqttCallback) method should be called + before this method, otherwise any received messages will be discarded. +

+

+
+
+
+
Parameters:
topicFilter - the topic to subscribe to, which can include wildcards.
qos - the quality of service at which to subscribe. +
Throws: +
MqttException +
MqttSecurityException
See Also:
subscribe(String[], int[])
+
+
+
+ +

+subscribe

+
+public void subscribe(java.lang.String[] topicFilters,
+                      int[] qos)
+               throws MqttException,
+                      MqttSecurityException
+
+
Subscribes to multiple topics, each of which may include wildcards, + using the specified options. The setCallback(MqttCallback) method should be called + before this method, otherwise any received messages will be discarded. + +

The "topic filter" string used when subscribing + may contain special characters, which allow you to subscribe to multiple topics + at once.

+

The topic level separator is used to introduce structure into the topic, and + can therefore be specified within the topic for that purpose. The multi-level + wildcard and single-level wildcard can be used for subscriptions, but they + cannot be used within a topic by the publisher of a message. +

+
Topic level separator
+
The forward slash (/) is used to separate each level within + a topic tree and provide a hierarchical structure to the topic space. The + use of the topic level separator is significant when the two wildcard characters + are encountered in topics specified by subscribers.
+ +
Multi-level wildcard
+

The number sign (#) is a wildcard character that matches + any number of levels within a topic. For example, if you subscribe to finance/stock/ibm/#, you receive + messages on these topics:

   finance/stock/ibm
   finance/stock/ibm/closingprice
   finance/stock/ibm/currentprice
+

+

The multi-level wildcard + can represent zero or more levels. Therefore, finance/# can also match + the singular finance, where # represents zero levels. The topic + level separator is meaningless in this context, because there are no levels + to separate.

+ +

The multi-level wildcard can + be specified only on its own or next to the topic level separator character. + Therefore, # and finance/# are both valid, but finance# is + not valid. The multi-level wildcard must be the last character + used within the topic tree. For example, finance/# is valid but finance/#/closingprice is + not valid.

+ +
Single-level wildcard
+

The plus sign (+) is a wildcard character that matches only one topic + level. For example, finance/stock/+ matches finance/stock/ibm and finance/stock/xyz, + but not finance/stock/ibm/closingprice. Also, because the single-level + wildcard matches only a single level, finance/+ does not match finance.

+ +

Use + the single-level wildcard at any level in the topic tree, and in conjunction + with the multilevel wildcard. Specify the single-level wildcard next to the + topic level separator, except when it is specified on its own. Therefore, + and finance/+ are + both valid, but finance+ is not valid. The single-level + wildcard can be used at the end of the topic tree or within the topic tree. + For example, finance/+ and finance/+/ibm are both valid.

+
+
+

+

+

+
+
+
+
Parameters:
topicFilters - the topics to subscribe to, which can include wildcards.
qos - the qualities of service levels at which to subscribe. +
Throws: +
MqttException - if there was an error registering the subscription. +
java.lang.IllegalArgumentException - if the two supplied arrays are not the same size. +
MqttSecurityException
+
+
+
+ +

+unsubscribe

+
+public void unsubscribe(java.lang.String topicFilter)
+                 throws MqttException
+
+
Unsubscribes from a topic. +

+

+
+
+
+
Parameters:
topicFilter - the topic to unsubscribe from. +
Throws: +
MqttException
+
+
+
+ +

+unsubscribe

+
+public void unsubscribe(java.lang.String[] topicFilters)
+                 throws MqttException
+
+
Unsubscribes from multiple topics. +

+

+
+
+
+
Parameters:
topicFilters - the topics to unsubscribe from. +
Throws: +
MqttException
+
+
+
+ +

+setCallback

+
+public void setCallback(MqttCallback callback)
+                 throws MqttException
+
+
Sets the callback listener to use for asynchronously received + messages. + The + MqttCallback.messageArrived(MqttTopic, MqttMessage) + method will be called back whenever a message arrives. +

+

+
+
+
+
Parameters:
callback - the class to callback when a message arrives. +
Throws: +
MqttException
+
+
+
+ +

+generateClientId

+
+public static java.lang.String generateClientId()
+
+
Returns a randomly generated client identifier based on the current user's login + name and the system time. +

When cleanSession is set to false, an application should 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)
+
+
+
+ +

+getPendingDeliveryTokens

+
+public MqttDeliveryToken[] getPendingDeliveryTokens()
+
+
Returns the delivery tokens for any outstanding publish operations. +

+

+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttClientPersistence.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttClientPersistence.html new file mode 100644 index 0000000..41e51ce --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttClientPersistence.html @@ -0,0 +1,421 @@ + + + + + + +MqttClientPersistence (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Interface MqttClientPersistence

+
+
All Known Implementing Classes:
MqttDefaultFilePersistence
+
+
+
+
public interface MqttClientPersistence
+ +

+Represents a persistent data store, used to store outbound and inbound messages while they + are in flight, enabling delivery to the QOS specified. You can specify an implementation + of this interface using MqttClient.MqttClient(String, String, MqttClientPersistence), + which the MqttClient will use to persist QoS 1 and 2 messages. +

+ If the methods defined throw the MqttPersistenceException then the state of the data persisted + should remain as prior to the method being called. For example, if put(String, MqttPersistable) + throws an exception at any point then the data will be assumed to not be in the persistent store. + Similarly if remove(String) throws an exception then the data will be + assumed to still be held in the persistent store.

+

+ It is up to the persistence interface to log any exceptions or error information + which may be required when diagnosing a persistence failure.

+

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclear() + +
+          Clears persistence, so that it no longer contains any persisted data.
+ voidclose() + +
+          Close the persistent store that was previously opened. +
+ booleancontainsKey(java.lang.String key) + +
+          Returns whether or not data is persisted using the specified key.
+ MqttPersistableget(java.lang.String key) + +
+          Gets the specified data out of the persistent store.
+ java.util.Enumerationkeys() + +
+          Returns an Enumeration over the keys in this persistent data store.
+ voidopen(java.lang.String clientId, + java.lang.String serverURI) + +
+          Initialise the persistent store. +
+ voidput(java.lang.String key, + MqttPersistable persistable) + +
+          Puts the specified data into the persistent store.
+ voidremove(java.lang.String key) + +
+          Remove the data for the specified key.
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+open

+
+public void open(java.lang.String clientId,
+                 java.lang.String serverURI)
+          throws MqttPersistenceException
+
+
Initialise the persistent store. + If a persistent store exists for this client ID then open it, otherwise + create a new one. If the persistent store is already open then just return. + An application may use the same client ID to connect to many different + servers, so the client ID in conjunction with the + connection will uniquely identify the persistence store required. +

+

+
Parameters:
clientId - The client for which the persistent store should be opened.
serverURI - The connection string as specified when the MQTT client instance was created. +
Throws: +
MqttPersistenceException - if there was a problem opening the persistent store.
+
+
+
+ +

+close

+
+public void close()
+           throws MqttPersistenceException
+
+
Close the persistent store that was previously opened. + This will be called when a client application disconnects from the broker. +

+

+ +
Throws: +
MqttPersistenceException
+
+
+
+ +

+put

+
+public void put(java.lang.String key,
+                MqttPersistable persistable)
+         throws MqttPersistenceException
+
+
Puts the specified data into the persistent store. +

+

+
Parameters:
key - the key for the data, which will be used later to retrieve it.
persistable - the data to persist +
Throws: +
MqttPersistenceException - if there was a problem putting the data + into the persistent store.
+
+
+
+ +

+get

+
+public MqttPersistable get(java.lang.String key)
+                    throws MqttPersistenceException
+
+
Gets the specified data out of the persistent store. +

+

+
Parameters:
key - the key for the data, which was used when originally saving it. +
Returns:
the un-persisted data +
Throws: +
MqttPersistenceException - if there was a problem getting the data + from the persistent store.
+
+
+
+ +

+remove

+
+public void remove(java.lang.String key)
+            throws MqttPersistenceException
+
+
Remove the data for the specified key. +

+

+ +
Throws: +
MqttPersistenceException
+
+
+
+ +

+keys

+
+public java.util.Enumeration keys()
+                           throws MqttPersistenceException
+
+
Returns an Enumeration over the keys in this persistent data store. +

+

+ +
Returns:
an enumeration of String objects. +
Throws: +
MqttPersistenceException
+
+
+
+ +

+clear

+
+public void clear()
+           throws MqttPersistenceException
+
+
Clears persistence, so that it no longer contains any persisted data. +

+

+ +
Throws: +
MqttPersistenceException
+
+
+
+ +

+containsKey

+
+public boolean containsKey(java.lang.String key)
+                    throws MqttPersistenceException
+
+
Returns whether or not data is persisted using the specified key. +

+

+
Parameters:
key - the key for data, which was used when originally saving it. +
Throws: +
MqttPersistenceException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html new file mode 100644 index 0000000..8f221a8 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttConnectOptions.html @@ -0,0 +1,726 @@ + + + + + + +MqttConnectOptions (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttConnectOptions

+
+java.lang.Object
+  extended byorg.eclipse.paho.client.mqttv3.MqttConnectOptions
+
+
+
+
public class MqttConnectOptions
extends java.lang.Object
+ +

+Stores options used when connecting to a server. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
MqttConnectOptions() + +
+          Constructs a new MqttConnectOptions object using the + default values. + +
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetConnectionTimeout() + +
+          Returns the connection timeout value.
+ intgetKeepAliveInterval() + +
+          Returns the "keep alive" interval.
+ char[]getPassword() + +
+          Returns the password to use for the connection.
+ javax.net.SocketFactorygetSocketFactory() + +
+          Returns the socket factory that will be used when connecting, or + null if one has not been set.
+ java.util.PropertiesgetSSLProperties() + +
+          Returns the SSL properties for the connection.
+ java.lang.StringgetUserName() + +
+          Returns the user name to use for the connection.
+ MqttTopicgetWillDestination() + +
+          Returns the topic to be used for last will and testament (LWT).
+ MqttMessagegetWillMessage() + +
+          Returns the message to be sent as last will and testament (LWT). +
+ booleanisCleanSession() + +
+          Returns whether the server should remember state for the client across reconnects.
+ voidsetCleanSession(boolean cleanSession) + +
+          Sets whether the server should remember state for the client across reconnects. +
+ voidsetConnectionTimeout(int connectionTimeout) + +
+          Sets the connection timeout value. +
+ voidsetKeepAliveInterval(int keepAliveInterval) + +
+          Sets the "keep alive" interval. +
+ voidsetPassword(char[] password) + +
+          Sets the password to use for the connection.
+ voidsetSocketFactory(javax.net.SocketFactory socketFactory) + +
+          Sets the SocketFactory to use.
+ voidsetSSLProperties(java.util.Properties props) + +
+          Sets the SSL properties for the connection.
+ voidsetUserName(java.lang.String userName) + +
+          Sets the user name to use for the connection.
+ voidsetWill(MqttTopic topic, + byte[] payload, + int qos, + boolean retained) + +
+          Sets the "Last Will and Testament" (LWT) for the connection. +
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+MqttConnectOptions

+
+public MqttConnectOptions()
+
+
Constructs a new MqttConnectOptions object using the + default values. + + The defaults are: +
    +
  • The keepalive interval is 60 seconds
    • +
  • Clean Session is true
    • +
  • The message delivery retry interval is 15 seconds
    • +
  • The connection timeout period is 30 seconds
    • +
  • No Will message is set
    • +
  • A standard SocketFactory is used
    • +
+ More information about these values can be found in the setter methods. +

+

+ + + + + + + + +
+Method Detail
+ +

+getPassword

+
+public char[] getPassword()
+
+
Returns the password to use for the connection. +

+

+ +
Returns:
the password to use for the connection.
+
+
+
+ +

+setPassword

+
+public void setPassword(char[] password)
+
+
Sets the password to use for the connection. +

+

+
+
+
+
+ +

+getUserName

+
+public java.lang.String getUserName()
+
+
Returns the user name to use for the connection. +

+

+ +
Returns:
the user name to use for the connection.
+
+
+
+ +

+setUserName

+
+public void setUserName(java.lang.String userName)
+
+
Sets the user name to use for the connection. +

+

+ +
Throws: +
java.lang.IllegalArgumentException - if the user name is blank or only + contains whitespace characters.
+
+
+
+ +

+setWill

+
+public void setWill(MqttTopic topic,
+                    byte[] payload,
+                    int qos,
+                    boolean retained)
+
+
Sets the "Last Will and Testament" (LWT) for the connection. + In the event that this client unexpectedly loses its connection to the + server, the server will publish a message to itself using the supplied + details. +

+

+
Parameters:
topic - the topic to publish to.
payload - the byte payload for the message.
qos - the quality of service to publish the message at (0, 1 or 2).
retained - whether or not the message should be retained.
+
+
+
+ +

+getKeepAliveInterval

+
+public int getKeepAliveInterval()
+
+
Returns the "keep alive" interval. +

+

+ +
Returns:
the keep alive interval.
See Also:
setKeepAliveInterval(int)
+
+
+
+ +

+setKeepAliveInterval

+
+public void setKeepAliveInterval(int keepAliveInterval)
+
+
Sets the "keep alive" interval. + This value, measured in seconds, defines the maximum time interval + between messages sent or received. It enables the client to + detect that if the server is no longer available, without + having to wait for the long TCP/IP timeout. The client will ensure + that at least one message travels across the network within each + keep alive period. In the absence of a data-related message during + the time period, the client sends a very small "ping" message, which + the server will acknowledge. +

The default value is 60 seconds

+

+

+
Parameters:
keepAliveInterval - the interval, measured in seconds.
+
+
+
+ +

+getConnectionTimeout

+
+public int getConnectionTimeout()
+
+
Returns the connection timeout value. +

+

+ +
Returns:
the connection timeout value.
See Also:
setConnectionTimeout(int)
+
+
+
+ +

+setConnectionTimeout

+
+public void setConnectionTimeout(int connectionTimeout)
+
+
Sets the connection timeout value. + This value, measured in seconds, defines the maximum time interval + the client will wait for calls to connect, + subscribe and + unsubscribe to complete. + The default timeout is 30 seconds. +

+

+
Parameters:
connectionTimeout - the timeout value, measured in seconds.
+
+
+
+ +

+getSocketFactory

+
+public javax.net.SocketFactory getSocketFactory()
+
+
Returns the socket factory that will be used when connecting, or + null if one has not been set. +

+

+
+
+
+
+ +

+setSocketFactory

+
+public void setSocketFactory(javax.net.SocketFactory socketFactory)
+
+
Sets the SocketFactory to use. This allows an application + to apply its own policies around the creation of network sockets. If + using an SSL connection, an SSLSocketFactory can be used + to supply application-specific security settings. +

+

+
Parameters:
socketFactory - the factory to use.
+
+
+
+ +

+getWillDestination

+
+public MqttTopic getWillDestination()
+
+
Returns the topic to be used for last will and testament (LWT). +

+

+ +
Returns:
the MqttTopic to use, or null if LWT is not set.
See Also:
setWill(MqttTopic, byte[], int, boolean)
+
+
+
+ +

+getWillMessage

+
+public MqttMessage getWillMessage()
+
+
Returns the message to be sent as last will and testament (LWT). + The returned object is "read only". Calling any "setter" methods on + the returned object will result in an + IllegalStateException being thrown. +

+

+ +
Returns:
the message to use, or null if LWT is not set.
+
+
+
+ +

+getSSLProperties

+
+public java.util.Properties getSSLProperties()
+
+
Returns the SSL properties for the connection. +

+

+ +
Returns:
the properties for the SSL connection
+
+
+
+ +

+setSSLProperties

+
+public void setSSLProperties(java.util.Properties props)
+
+
Sets the SSL properties for the connection. Note that these + properties are only valid if an implementation of the Java + Secure Socket Extensions (JSSE) is available. These properties are + not used if a SocketFactory has been set using + setSocketFactory(SocketFactory). + The following properties can be used:

+
+
com.ibm.ssl.protocol
+
One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS.
+
com.ibm.ssl.contextProvider +
Underlying JSSE provider. For example "IBMJSSE2" or "SunJSSE"
+ +
com.ibm.ssl.keyStore
+
The name of the file that contains the KeyStore object that you + want the KeyManager to use. For example /mydir/etc/key.p12
+ +
com.ibm.ssl.keyStorePassword
+
The password for the KeyStore object that you want the KeyManager to use. + The password can either be in plain-text, + or may be obfuscated using the static method: + com.ibm.micro.security.Password.obfuscate(char[] password). + This obfuscates the password using a simple and insecure XOR and Base64 + encoding mechanism. Note that this is only a simple scrambler to + obfuscate clear-text passwords.
+ +
com.ibm.ssl.keyStoreType
+
Type of key store, for example "PKCS12", "JKS", or "JCEKS".
+ +
com.ibm.ssl.keyStoreProvider
+
Key store provider, for example "IBMJCE" or "IBMJCEFIPS".
+ +
com.ibm.ssl.trustStore
+
The name of the file that contains the KeyStore object that you + want the TrustManager to use.
+ +
com.ibm.ssl.trustStorePassword
+
The password for the TrustStore object that you want the + TrustManager to use. The password can either be in plain-text, + or may be obfuscated using the static method: + com.ibm.micro.security.Password.obfuscate(char[] password). + This obfuscates the password using a simple and insecure XOR and Base64 + encoding mechanism. Note that this is only a simple scrambler to + obfuscate clear-text passwords.
+ +
com.ibm.ssl.trustStoreType
+
The type of KeyStore object that you want the default TrustManager to use. + Same possible values as "keyStoreType".
+ +
com.ibm.ssl.trustStoreProvider
+
Trust store provider, for example "IBMJCE" or "IBMJCEFIPS".
+ +
com.ibm.ssl.enabledCipherSuites
+
A list of which ciphers are enabled. Values are dependent on the provider, + for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA.
+ +
com.ibm.ssl.keyManager
+
Sets the algorithm that will be used to instantiate a KeyManagerFactory object + instead of using the default algorithm available in the platform. Example values: + "IbmX509" or "IBMJ9X509". +
+ +
com.ibm.ssl.trustManager
+
Sets the algorithm that will be used to instantiate a TrustManagerFactory object + instead of using the default algorithm available in the platform. Example values: + "PKIX" or "IBMJ9X509". +
+
+

+

+
+
+
+
+ +

+isCleanSession

+
+public boolean isCleanSession()
+
+
Returns whether the server should remember state for the client across reconnects. +

+

+ +
Returns:
the clean session flag
+
+
+
+ +

+setCleanSession

+
+public void setCleanSession(boolean cleanSession)
+
+
Sets whether the server should remember state for the client across reconnects. + This includes subscriptions and the state of any in-flight messages. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttDefaultFilePersistence.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttDefaultFilePersistence.html new file mode 100644 index 0000000..7f73ce0 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttDefaultFilePersistence.html @@ -0,0 +1,506 @@ + + + + + + +MqttDefaultFilePersistence (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttDefaultFilePersistence

+
+java.lang.Object
+  extended byorg.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence
+
+
+
All Implemented Interfaces:
MqttClientPersistence
+
+
+
+
public class MqttDefaultFilePersistence
extends java.lang.Object
implements MqttClientPersistence
+ +

+An implementation of the MqttClientPersistence interface that provides + file based persistence. + + A directory is specified when the Persistence object is created. When the persistence + is then opened (see open(String, String)), a sub-directory is made beneath the base + for this particular client ID and connection key. This allows one persistence base directory + to be shared by multiple clients. + + The sub-directory's name is created from a concatenation of the client ID and connection key + with any instance of '/', '\\', ':' or ' ' removed. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Constructor Summary
MqttDefaultFilePersistence() + +
+           
MqttDefaultFilePersistence(java.lang.String directory) + +
+          Create an file-based persistent data store within the specified directory.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclear() + +
+          Clears persistence, so that it no longer contains any persisted data.
+ voidclose() + +
+          Close the persistent store that was previously opened. +
+ booleancontainsKey(java.lang.String key) + +
+          Returns whether or not data is persisted using the specified key.
+ MqttPersistableget(java.lang.String key) + +
+          Gets the specified data out of the persistent store.
+ java.util.Enumerationkeys() + +
+          Returns all of the persistent data from the previously specified persistence directory.
+ voidopen(java.lang.String clientId, + java.lang.String theConnection) + +
+          Initialise the persistent store. +
+ voidput(java.lang.String key, + MqttPersistable message) + +
+          Writes the specified persistent data to the previously specified persistence directory. +
+ voidremove(java.lang.String key) + +
+          Deletes the data with the specified key from the previously specified persistence directory.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+MqttDefaultFilePersistence

+
+public MqttDefaultFilePersistence()
+                           throws MqttPersistenceException
+
+
+
+ +

+MqttDefaultFilePersistence

+
+public MqttDefaultFilePersistence(java.lang.String directory)
+                           throws MqttPersistenceException
+
+
Create an file-based persistent data store within the specified directory. +

+

Parameters:
directory - the directory to use.
+ + + + + + + + +
+Method Detail
+ +

+open

+
+public void open(java.lang.String clientId,
+                 java.lang.String theConnection)
+          throws MqttPersistenceException
+
+
Description copied from interface: MqttClientPersistence
+
Initialise the persistent store. + If a persistent store exists for this client ID then open it, otherwise + create a new one. If the persistent store is already open then just return. + An application may use the same client ID to connect to many different + servers, so the client ID in conjunction with the + connection will uniquely identify the persistence store required. +

+

+
Specified by:
open in interface MqttClientPersistence
+
+
+
Parameters:
clientId - The client for which the persistent store should be opened.
theConnection - The connection string as specified when the MQTT client instance was created. +
Throws: +
MqttPersistenceException - if there was a problem opening the persistent store.
+
+
+
+ +

+close

+
+public void close()
+           throws MqttPersistenceException
+
+
Description copied from interface: MqttClientPersistence
+
Close the persistent store that was previously opened. + This will be called when a client application disconnects from the broker. +

+

+
Specified by:
close in interface MqttClientPersistence
+
+
+ +
Throws: +
MqttPersistenceException
+
+
+
+ +

+put

+
+public void put(java.lang.String key,
+                MqttPersistable message)
+         throws MqttPersistenceException
+
+
Writes the specified persistent data to the previously specified persistence directory. + This method uses a safe overwrite policy to ensure IO errors do not lose messages. +

+

+
Specified by:
put in interface MqttClientPersistence
+
+
+
Parameters:
message -
key - the key for the data, which will be used later to retrieve it. +
Throws: +
MqttPersistenceException
+
+
+
+ +

+get

+
+public MqttPersistable get(java.lang.String key)
+                    throws MqttPersistenceException
+
+
Description copied from interface: MqttClientPersistence
+
Gets the specified data out of the persistent store. +

+

+
Specified by:
get in interface MqttClientPersistence
+
+
+
Parameters:
key - the key for the data, which was used when originally saving it. +
Returns:
the un-persisted data +
Throws: +
MqttPersistenceException - if there was a problem getting the data + from the persistent store.
+
+
+
+ +

+remove

+
+public void remove(java.lang.String key)
+            throws MqttPersistenceException
+
+
Deletes the data with the specified key from the previously specified persistence directory. +

+

+
Specified by:
remove in interface MqttClientPersistence
+
+
+ +
Throws: +
MqttPersistenceException
+
+
+
+ +

+keys

+
+public java.util.Enumeration keys()
+                           throws MqttPersistenceException
+
+
Returns all of the persistent data from the previously specified persistence directory. +

+

+
Specified by:
keys in interface MqttClientPersistence
+
+
+ +
Returns:
all of the persistent data from the persistence directory. +
Throws: +
MqttPersistenceException
+
+
+
+ +

+containsKey

+
+public boolean containsKey(java.lang.String key)
+                    throws MqttPersistenceException
+
+
Description copied from interface: MqttClientPersistence
+
Returns whether or not data is persisted using the specified key. +

+

+
Specified by:
containsKey in interface MqttClientPersistence
+
+
+
Parameters:
key - the key for data, which was used when originally saving it. +
Throws: +
MqttPersistenceException
+
+
+
+ +

+clear

+
+public void clear()
+           throws MqttPersistenceException
+
+
Description copied from interface: MqttClientPersistence
+
Clears persistence, so that it no longer contains any persisted data. +

+

+
Specified by:
clear in interface MqttClientPersistence
+
+
+ +
Throws: +
MqttPersistenceException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttDeliveryToken.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttDeliveryToken.html new file mode 100644 index 0000000..323bb24 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttDeliveryToken.html @@ -0,0 +1,322 @@ + + + + + + +MqttDeliveryToken (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Interface MqttDeliveryToken

+
+
+
public interface MqttDeliveryToken
+ +

+Provides a mechanism for tracking the delivery of messages. + + Calls to MqttTopic.publish(MqttMessage) + return after the message has been sent, but do not wait for acknowledgements + to be received. This allows the + client to have multiple messages in-flight at one time. + + In order to track the delivery of a message, those methods + return an instance of this class which can be used in one of two ways: +

+

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ MqttMessagegetMessage() + +
+          Returns the message associated with this token, or null if the message has + already been successfully sent.
+ booleanisComplete() + +
+          Returns whether or not the delivery has finished.
+ voidwaitForCompletion() + +
+          Blocks the current thread until the message this is the token + for completes delivery.
+ voidwaitForCompletion(long timeout) + +
+          Blocks the current thread until the message this is the token + for completes delivery. +
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+waitForCompletion

+
+public void waitForCompletion()
+                       throws MqttException,
+                              MqttSecurityException
+
+
Blocks the current thread until the message this is the token + for completes delivery. +

+

+ +
Throws: +
MqttException - if there was a problem completing delivery of the message. +
MqttSecurityException
+
+
+
+ +

+waitForCompletion

+
+public void waitForCompletion(long timeout)
+                       throws MqttException,
+                              MqttSecurityException
+
+
Blocks the current thread until the message this is the token + for completes delivery. + This will only block for specified timeout period. If the delivery has not + completed before the timeout occurs, this method will return - the + isComplete() method can be used to determine if the delivery is + complete, or if the wait has timed out. +

+

+
Parameters:
timeout - the maximum amount of time to wait for, in milliseconds. +
Throws: +
MqttException - if there was a problem completing delivery of the message +
MqttSecurityException
+
+
+
+ +

+isComplete

+
+public boolean isComplete()
+
+
Returns whether or not the delivery has finished. Note that a token will + be marked as complete even if the delivery failed. +

+

+
+
+
+
+ +

+getMessage

+
+public MqttMessage getMessage()
+                       throws MqttException
+
+
Returns the message associated with this token, or null if the message has + already been successfully sent. +

+

+ +
Returns:
the message associated with this token +
Throws: +
MqttException - if there was a problem completing retrieving the message
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttException.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttException.html new file mode 100644 index 0000000..1c7c06e --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttException.html @@ -0,0 +1,803 @@ + + + + + + +MqttException (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttException

+
+java.lang.Object
+  extended byjava.lang.Throwable
+      extended byjava.lang.Exception
+          extended byorg.eclipse.paho.client.mqttv3.MqttException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
Direct Known Subclasses:
MqttPersistenceException, MqttSecurityException
+
+
+
+
public class MqttException
extends java.lang.Exception
+ +

+Thrown if an error occurs communicating with the server. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static shortREASON_CODE_BROKER_UNAVAILABLE + +
+          The broker was not available to handle the request.
+static shortREASON_CODE_CLIENT_ALREADY_CONNECTED + +
+          The client is already connected.
+static shortREASON_CODE_CLIENT_ALREADY_DISCONNECTED + +
+          The client is already disconnected.
+static shortREASON_CODE_CLIENT_DISCONNECT_PROHIBITED + +
+          Thrown when an attempt to call MqttClient.disconnect() has been + made from within a method on MqttCallback.
+static shortREASON_CODE_CLIENT_DISCONNECTING + +
+          The client is currently disconnecting and cannot accept any new work. +
+static shortREASON_CODE_CLIENT_EXCEPTION + +
+          Client encountered an exception.
+static shortREASON_CODE_CLIENT_NOT_CONNECTED + +
+          The client is not connected to the server.
+static shortREASON_CODE_CLIENT_TIMEOUT + +
+          Client timed out while waiting for a response from the server. +
+static shortREASON_CODE_CONNECTION_LOST + +
+          The client has been unexpectedly disconnected from the server.
+static shortREASON_CODE_FAILED_AUTHENTICATION + +
+          Authentication with the server has failed, due to a bad user name or password.
+static shortREASON_CODE_INVALID_CLIENT_ID + +
+          The server has rejected the supplied client ID
+static shortREASON_CODE_INVALID_MESSAGE + +
+          Protocol error: the message was not recognized as a valid MQTT packet. +
+static shortREASON_CODE_INVALID_PROTOCOL_VERSION + +
+          The protocol version requested is not supported by the server.
+static shortREASON_CODE_NO_MESSAGE_IDS_AVAILABLE + +
+          Internal error, caused by no new message IDs being available.
+static shortREASON_CODE_NOT_AUTHORIZED + +
+          Not authorized to perform the requested operation
+static shortREASON_CODE_SERVER_CONNECT_ERROR + +
+          Unable to connect to server
+static shortREASON_CODE_SOCKET_FACTORY_MISMATCH + +
+          Server URI and supplied SocketFactory do not match. +
+static shortREASON_CODE_SSL_CONFIG_ERROR + +
+          SSL configuration error.
+static shortREASON_CODE_UNEXPECTED_ERROR + +
+          An unexpected error has occurred.
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
MqttException(int reasonCode) + +
+          Constructs a new MqttException with the specified code + as the underlying reason.
MqttException(int reason, + java.lang.Throwable cause) + +
+          Constructs a new MqttException with the specified + Throwable as the underlying reason.
MqttException(java.lang.Throwable cause) + +
+          Constructs a new MqttException with the specified + Throwable as the underlying reason.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.ThrowablegetCause() + +
+          Returns the underlying cause of this exception, if available.
+ java.lang.StringgetMessage() + +
+          Returns the detail message for this exception.
+ intgetReasonCode() + +
+          Returns the reason code for this exception.
+ java.lang.StringtoString() + +
+          Returns a String representation of this exception.
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+REASON_CODE_CLIENT_EXCEPTION

+
+public static final short REASON_CODE_CLIENT_EXCEPTION
+
+
Client encountered an exception. Use the getCause() + method to get the underlying reason. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_INVALID_PROTOCOL_VERSION

+
+public static final short REASON_CODE_INVALID_PROTOCOL_VERSION
+
+
The protocol version requested is not supported by the server. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_INVALID_CLIENT_ID

+
+public static final short REASON_CODE_INVALID_CLIENT_ID
+
+
The server has rejected the supplied client ID +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_BROKER_UNAVAILABLE

+
+public static final short REASON_CODE_BROKER_UNAVAILABLE
+
+
The broker was not available to handle the request. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_FAILED_AUTHENTICATION

+
+public static final short REASON_CODE_FAILED_AUTHENTICATION
+
+
Authentication with the server has failed, due to a bad user name or password. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_NOT_AUTHORIZED

+
+public static final short REASON_CODE_NOT_AUTHORIZED
+
+
Not authorized to perform the requested operation +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_UNEXPECTED_ERROR

+
+public static final short REASON_CODE_UNEXPECTED_ERROR
+
+
An unexpected error has occurred. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_CLIENT_TIMEOUT

+
+public static final short REASON_CODE_CLIENT_TIMEOUT
+
+
Client timed out while waiting for a response from the server. + The server is no longer responding to keep-alive messages. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_NO_MESSAGE_IDS_AVAILABLE

+
+public static final short REASON_CODE_NO_MESSAGE_IDS_AVAILABLE
+
+
Internal error, caused by no new message IDs being available. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_CLIENT_ALREADY_CONNECTED

+
+public static final short REASON_CODE_CLIENT_ALREADY_CONNECTED
+
+
The client is already connected. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_CLIENT_ALREADY_DISCONNECTED

+
+public static final short REASON_CODE_CLIENT_ALREADY_DISCONNECTED
+
+
The client is already disconnected. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_CLIENT_DISCONNECTING

+
+public static final short REASON_CODE_CLIENT_DISCONNECTING
+
+
The client is currently disconnecting and cannot accept any new work. + This can occur when waiting on a token, and then disconnecting the client. + If the message delivery does not complete within the quiesce timeout + period, then the waiting token will be notified with an exception. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_SERVER_CONNECT_ERROR

+
+public static final short REASON_CODE_SERVER_CONNECT_ERROR
+
+
Unable to connect to server +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_CLIENT_NOT_CONNECTED

+
+public static final short REASON_CODE_CLIENT_NOT_CONNECTED
+
+
The client is not connected to the server. The MqttClient.connect() + or MqttClient.connect(MqttConnectOptions) method must be called + first. It is also possible that the connection was lost - see + MqttClient.setCallback(MqttCallback) for a way to track lost + connections. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_SOCKET_FACTORY_MISMATCH

+
+public static final short REASON_CODE_SOCKET_FACTORY_MISMATCH
+
+
Server URI and supplied SocketFactory do not match. + URIs beginning tcp:// must use a javax.net.SocketFactory, + and URIs beginning ssl:// must use a javax.net.ssl.SSLSocketFactory. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_SSL_CONFIG_ERROR

+
+public static final short REASON_CODE_SSL_CONFIG_ERROR
+
+
SSL configuration error. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_CLIENT_DISCONNECT_PROHIBITED

+
+public static final short REASON_CODE_CLIENT_DISCONNECT_PROHIBITED
+
+
Thrown when an attempt to call MqttClient.disconnect() has been + made from within a method on MqttCallback. These methods are invoked + by the client's thread, and must not be used to control disconnection. +

+

+
See Also:
MqttCallback.messageArrived(MqttTopic, MqttMessage), +Constant Field Values
+
+
+ +

+REASON_CODE_INVALID_MESSAGE

+
+public static final short REASON_CODE_INVALID_MESSAGE
+
+
Protocol error: the message was not recognized as a valid MQTT packet. + Possible reasons for this include connecting to a non-MQTT server, or + connecting to an SSL server port when the client isn't using SSL. +

+

+
See Also:
Constant Field Values
+
+
+ +

+REASON_CODE_CONNECTION_LOST

+
+public static final short REASON_CODE_CONNECTION_LOST
+
+
The client has been unexpectedly disconnected from the server. The cause + will provide more details. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+MqttException

+
+public MqttException(int reasonCode)
+
+
Constructs a new MqttException with the specified code + as the underlying reason. +

+

Parameters:
reasonCode - the reason code for the exception.
+
+ +

+MqttException

+
+public MqttException(java.lang.Throwable cause)
+
+
Constructs a new MqttException with the specified + Throwable as the underlying reason. +

+

Parameters:
cause - the underlying cause of the exception.
+
+ +

+MqttException

+
+public MqttException(int reason,
+                     java.lang.Throwable cause)
+
+
Constructs a new MqttException with the specified + Throwable as the underlying reason. +

+

Parameters:
reason - the reason code for the exception.
cause - the underlying cause of the exception.
+ + + + + + + + +
+Method Detail
+ +

+getReasonCode

+
+public int getReasonCode()
+
+
Returns the reason code for this exception. +

+

+ +
Returns:
the code representing the reason for this exception.
+
+
+
+ +

+getCause

+
+public java.lang.Throwable getCause()
+
+
Returns the underlying cause of this exception, if available. +

+

+ +
Returns:
the Throwable that was the root cause of this exception, + which may be null.
+
+
+
+ +

+getMessage

+
+public java.lang.String getMessage()
+
+
Returns the detail message for this exception. +

+

+ +
Returns:
the detail message, which may be null.
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
Returns a String representation of this exception. +

+

+ +
Returns:
a String representation of this exception.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttMessage.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttMessage.html new file mode 100644 index 0000000..46d0e2d --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttMessage.html @@ -0,0 +1,520 @@ + + + + + + +MqttMessage (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttMessage

+
+java.lang.Object
+  extended byorg.eclipse.paho.client.mqttv3.MqttMessage
+
+
+
+
public class MqttMessage
extends java.lang.Object
+ +

+An MQTT message. The message includes a "payload" (the body of the message) + represented as a byte[]. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Constructor Summary
MqttMessage() + +
+          Constructs a message with an empty payload, and all other values + set to defaults. + +
MqttMessage(byte[] payload) + +
+          Constructs a message with the specified byte array as a payload, + and all other values set to defaults.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclearPayload() + +
+          Clears the payload, resetting it to be empty.
+ byte[]getPayload() + +
+          Returns the payload as a byte array.
+ intgetQos() + +
+          Returns the quality of service for this message.
+ booleanisDuplicate() + +
+          Returns whether or not this message might be a duplicate of one which has + already been received.
+ booleanisRetained() + +
+          Returns whether or not this message should be/was retained by the server. +
+ voidsetPayload(byte[] payload) + +
+          Sets the payload of this message to be the specified byte array.
+ voidsetQos(int qos) + +
+          Sets the quality of service for this message. +
+ voidsetRetained(boolean retained) + +
+          Whether or not the publish message should be retained by the messaging engine. +
+ java.lang.StringtoString() + +
+          Returns a string representation of this message.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+MqttMessage

+
+public MqttMessage()
+
+
Constructs a message with an empty payload, and all other values + set to defaults. + + The defaults are: +
    +
  • Message QoS set to 1
    • +
  • Message will not be "retained" by the server
    • +
+

+

+
+ +

+MqttMessage

+
+public MqttMessage(byte[] payload)
+
+
Constructs a message with the specified byte array as a payload, + and all other values set to defaults. +

+

+ + + + + + + + +
+Method Detail
+ +

+getPayload

+
+public byte[] getPayload()
+                  throws MqttException
+
+
Returns the payload as a byte array. +

+

+ +
Returns:
the payload as a byte array. +
Throws: +
MqttException
+
+
+
+ +

+clearPayload

+
+public void clearPayload()
+
+
Clears the payload, resetting it to be empty. +

+

+ +
Throws: +
java.lang.IllegalStateException - if this message cannot be edited
+
+
+
+ +

+setPayload

+
+public void setPayload(byte[] payload)
+
+
Sets the payload of this message to be the specified byte array. +

+

+
Parameters:
payload - the payload for this message. +
Throws: +
java.lang.IllegalStateException - if this message cannot be edited
+
+
+
+ +

+isRetained

+
+public boolean isRetained()
+
+
Returns whether or not this message should be/was retained by the server. + For messages received from the server, this method returns whether or not + the message was from a current publisher, or was "retained" by the server as + the last message published on the topic. +

+

+ +
Returns:
true if the message should be, or was, retained by + the server.
See Also:
setRetained(boolean)
+
+
+
+ +

+setRetained

+
+public void setRetained(boolean retained)
+
+
Whether or not the publish message should be retained by the messaging engine. + Sending a message with the retained set to false will clear the + retained message from the server. The default value is false +

+

+
Parameters:
retained - whether or not the messaging engine should retain the message. +
Throws: +
java.lang.IllegalStateException - if this message cannot be edited
+
+
+
+ +

+getQos

+
+public int getQos()
+
+
Returns the quality of service for this message. +

+

+ +
Returns:
the quality of service to use, either 0, 1, or 2.
See Also:
setQos(int)
+
+
+
+ +

+setQos

+
+public void setQos(int qos)
+
+
Sets the quality of service for this message. +
    +
  • Quality of service 0 - indicates that a message should + be delivered at most once (zero or one times). The message will not be persisted to disk, + and will not be acknowledged across the network. This QoS is the fastest, + but should only be used for messages which are not valuable - note that + if the server cannot process the message (for example, there + is an authorization problem), then an + MqttCallback.deliveryComplete(MqttDeliveryToken). + Also known as "fire and forget".
    • + +
  • Quality of service 1 - indicates that a message should + be delivered at least once (one or more times). The message can only be delivered safely if + it can be persisted, so the application must supply a means of + persistence using MqttConnectOptions. + If a persistence mechanism is not specified, the message will not be + delivered in the event of a client failure. + The message will be acknowledged across the network. + This is the default QoS.
    • + +
  • Quality of service 2 - indicates that a message should + be delivered once. The message will be persisted to disk, and will + be subject to a two-phase acknowledgement across the network. + The message can only be delivered safely if + it can be persisted, so the application must supply a means of + persistence using MqttConnectOptions. + If a persistence mechanism is not specified, the message will not be + delivered in the event of a client failure.
    • + + If persistence is not configured, QOS 1 and 2 messages will still be delivered + in the event of a network or server problem as the client will hold state in memory. + If the MQTT client is shutdown or fails and persistence is not configured then + delivery of QOS 1 and 2 messages can not be maintained as client side state will + be lost. +

    +

    +
    Parameters:
    qos - the "quality of service" to use. Set to 0, 1, 2. +
    Throws: +
    java.lang.IllegalArgumentException - if value of QoS is not 0, 1 or 2. +
    java.lang.IllegalStateException - if this message cannot be edited
    +
    +
+
+ +

+toString

+
+public java.lang.String toString()
+
+
Returns a string representation of this message. +

+

+ +
Returns:
a string representation of this message.
+
+
+
+ +

+isDuplicate

+
+public boolean isDuplicate()
+
+
Returns whether or not this message might be a duplicate of one which has + already been received. This will only be set on messages received from + the server. +

+

+ +
Returns:
true if the message might be a duplicate.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttPersistable.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttPersistable.html new file mode 100644 index 0000000..153e026 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttPersistable.html @@ -0,0 +1,387 @@ + + + + + + +MqttPersistable (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Interface MqttPersistable

+
+
+
public interface MqttPersistable
+ +

+Represents an object used to pass data to be persisted across the + MqttClientPersistence + interface. +

+ When data is passed across the interface the header and payload are + separated, so that unnecessary message copies may be avoided. + For example, if a 10 MB payload was published it would be inefficient + to create a byte array a few bytes larger than 10 MB and copy the + MQTT message header and payload into a contiguous byte array.

+

+ When the request to persist data is made a separate byte array and offset + is passed for the header and payload. Only the data between + offset and length need be persisted. + So for example, a message to be persisted consists of a header byte + array starting at offset 1 and length 4, plus a payload byte array + starting at offset 30 and length 40000. There are three ways in which + the persistence implementation may return data to the client on + recovery: +

+

+

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]getHeaderBytes() + +
+          Returns the header bytes in an array. +
+ intgetHeaderLength() + +
+          Returns the length of the header.
+ intgetHeaderOffset() + +
+          Returns the offset of the header within the byte array returned by getHeaderBytes().
+ byte[]getPayloadBytes() + +
+          Returns the payload bytes in an array. +
+ intgetPayloadLength() + +
+          Returns the length of the payload.
+ intgetPayloadOffset() + +
+          Returns the offset of the payload within the byte array returned by getPayloadBytes().
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+getHeaderBytes

+
+public byte[] getHeaderBytes()
+                      throws MqttPersistenceException
+
+
Returns the header bytes in an array. + The bytes start at getHeaderOffset() + and continue for getHeaderLength(). +

+

+ +
Returns:
the header bytes. +
Throws: +
MqttPersistenceException
+
+
+
+ +

+getHeaderLength

+
+public int getHeaderLength()
+                    throws MqttPersistenceException
+
+
Returns the length of the header. +

+

+ +
Returns:
the header length +
Throws: +
MqttPersistenceException
+
+
+
+ +

+getHeaderOffset

+
+public int getHeaderOffset()
+                    throws MqttPersistenceException
+
+
Returns the offset of the header within the byte array returned by getHeaderBytes(). +

+

+ +
Returns:
the header offset. +
Throws: +
MqttPersistenceException
+
+
+
+ +

+getPayloadBytes

+
+public byte[] getPayloadBytes()
+                       throws MqttPersistenceException
+
+
Returns the payload bytes in an array. + The bytes start at getPayloadOffset() + and continue for getPayloadLength(). +

+

+ +
Returns:
the payload bytes. +
Throws: +
MqttPersistenceException
+
+
+
+ +

+getPayloadLength

+
+public int getPayloadLength()
+                     throws MqttPersistenceException
+
+
Returns the length of the payload. +

+

+ +
Returns:
the payload length. +
Throws: +
MqttPersistenceException
+
+
+
+ +

+getPayloadOffset

+
+public int getPayloadOffset()
+                     throws MqttPersistenceException
+
+
Returns the offset of the payload within the byte array returned by getPayloadBytes(). +

+

+ +
Returns:
the payload offset. +
Throws: +
MqttPersistenceException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttPersistenceException.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttPersistenceException.html new file mode 100644 index 0000000..a1e5b2e --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttPersistenceException.html @@ -0,0 +1,332 @@ + + + + + + +MqttPersistenceException (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttPersistenceException

+
+java.lang.Object
+  extended byjava.lang.Throwable
+      extended byjava.lang.Exception
+          extended byorg.eclipse.paho.client.mqttv3.MqttException
+              extended byorg.eclipse.paho.client.mqttv3.MqttPersistenceException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class MqttPersistenceException
extends MqttException
+ +

+This exception should be thrown by the implementor of the persistence + interface if there is a problem reading or writing persistent data. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static shortREASON_CODE_PERSISTENCE_IN_USE + +
+          Persistence is already being used by another client.
+  + + + + + + + +
Fields inherited from class org.eclipse.paho.client.mqttv3.MqttException
REASON_CODE_BROKER_UNAVAILABLE, REASON_CODE_CLIENT_ALREADY_CONNECTED, REASON_CODE_CLIENT_ALREADY_DISCONNECTED, REASON_CODE_CLIENT_DISCONNECT_PROHIBITED, REASON_CODE_CLIENT_DISCONNECTING, REASON_CODE_CLIENT_EXCEPTION, REASON_CODE_CLIENT_NOT_CONNECTED, REASON_CODE_CLIENT_TIMEOUT, REASON_CODE_CONNECTION_LOST, REASON_CODE_FAILED_AUTHENTICATION, REASON_CODE_INVALID_CLIENT_ID, REASON_CODE_INVALID_MESSAGE, REASON_CODE_INVALID_PROTOCOL_VERSION, REASON_CODE_NO_MESSAGE_IDS_AVAILABLE, REASON_CODE_NOT_AUTHORIZED, REASON_CODE_SERVER_CONNECT_ERROR, REASON_CODE_SOCKET_FACTORY_MISMATCH, REASON_CODE_SSL_CONFIG_ERROR, REASON_CODE_UNEXPECTED_ERROR
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
MqttPersistenceException() + +
+          Constructs a new MqttPersistenceException
MqttPersistenceException(int reasonCode) + +
+          Constructs a new MqttPersistenceException with the specified code + as the underlying reason.
MqttPersistenceException(java.lang.Throwable cause) + +
+          Constructs a new MqttPersistenceException with the specified + Throwable as the underlying reason.
+  + + + + + + + + + + +
Methods inherited from class org.eclipse.paho.client.mqttv3.MqttException
getCause, getMessage, getReasonCode, toString
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+REASON_CODE_PERSISTENCE_IN_USE

+
+public static final short REASON_CODE_PERSISTENCE_IN_USE
+
+
Persistence is already being used by another client. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+MqttPersistenceException

+
+public MqttPersistenceException()
+
+
Constructs a new MqttPersistenceException +

+

+
+ +

+MqttPersistenceException

+
+public MqttPersistenceException(int reasonCode)
+
+
Constructs a new MqttPersistenceException with the specified code + as the underlying reason. +

+

Parameters:
reasonCode - the reason code for the exception.
+
+ +

+MqttPersistenceException

+
+public MqttPersistenceException(java.lang.Throwable cause)
+
+
Constructs a new MqttPersistenceException with the specified + Throwable as the underlying reason. +

+

Parameters:
cause - the underlying cause of the exception.
+ + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttSecurityException.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttSecurityException.html new file mode 100644 index 0000000..fc4d608 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttSecurityException.html @@ -0,0 +1,290 @@ + + + + + + +MqttSecurityException (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttSecurityException

+
+java.lang.Object
+  extended byjava.lang.Throwable
+      extended byjava.lang.Exception
+          extended byorg.eclipse.paho.client.mqttv3.MqttException
+              extended byorg.eclipse.paho.client.mqttv3.MqttSecurityException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class MqttSecurityException
extends MqttException
+ +

+Thrown when a client is not authorized to perform an operation, or + if there is a problem with the security configuration. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.eclipse.paho.client.mqttv3.MqttException
REASON_CODE_BROKER_UNAVAILABLE, REASON_CODE_CLIENT_ALREADY_CONNECTED, REASON_CODE_CLIENT_ALREADY_DISCONNECTED, REASON_CODE_CLIENT_DISCONNECT_PROHIBITED, REASON_CODE_CLIENT_DISCONNECTING, REASON_CODE_CLIENT_EXCEPTION, REASON_CODE_CLIENT_NOT_CONNECTED, REASON_CODE_CLIENT_TIMEOUT, REASON_CODE_CONNECTION_LOST, REASON_CODE_FAILED_AUTHENTICATION, REASON_CODE_INVALID_CLIENT_ID, REASON_CODE_INVALID_MESSAGE, REASON_CODE_INVALID_PROTOCOL_VERSION, REASON_CODE_NO_MESSAGE_IDS_AVAILABLE, REASON_CODE_NOT_AUTHORIZED, REASON_CODE_SERVER_CONNECT_ERROR, REASON_CODE_SOCKET_FACTORY_MISMATCH, REASON_CODE_SSL_CONFIG_ERROR, REASON_CODE_UNEXPECTED_ERROR
+  + + + + + + + + + + + + + +
+Constructor Summary
MqttSecurityException(int reasonCode) + +
+          Constructs a new MqttSecurityException with the specified code + as the underlying reason.
MqttSecurityException(java.lang.Throwable cause) + +
+          Constructs a new MqttSecurityException with the specified + Throwable as the underlying reason.
+  + + + + + + + + + + +
Methods inherited from class org.eclipse.paho.client.mqttv3.MqttException
getCause, getMessage, getReasonCode, toString
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+MqttSecurityException

+
+public MqttSecurityException(int reasonCode)
+
+
Constructs a new MqttSecurityException with the specified code + as the underlying reason. +

+

Parameters:
reasonCode - the reason code for the exception.
+
+ +

+MqttSecurityException

+
+public MqttSecurityException(java.lang.Throwable cause)
+
+
Constructs a new MqttSecurityException with the specified + Throwable as the underlying reason. +

+

Parameters:
cause - the underlying cause of the exception.
+ + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttTopic.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttTopic.html new file mode 100644 index 0000000..b49d40a --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/MqttTopic.html @@ -0,0 +1,323 @@ + + + + + + +MqttTopic (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +

+ +org.eclipse.paho.client.mqttv3 +
+Class MqttTopic

+
+java.lang.Object
+  extended byorg.eclipse.paho.client.mqttv3.MqttTopic
+
+
+
+
public class MqttTopic
extends java.lang.Object
+ +

+Represents a topic destination, used for publish/subscribe messaging. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetName() + +
+          Returns the name of the queue or topic.
+ MqttDeliveryTokenpublish(byte[] payload, + int qos, + boolean retained) + +
+          Publishes a message on the topic.
+ MqttDeliveryTokenpublish(MqttMessage message) + +
+          Publishes the specified message to this topic, but doesn't wait for + a response.
+ java.lang.StringtoString() + +
+          Returns a string representation of this topic.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + + + + +
+Method Detail
+ +

+publish

+
+public MqttDeliveryToken publish(byte[] payload,
+                                 int qos,
+                                 boolean retained)
+                          throws MqttException,
+                                 MqttPersistenceException
+
+
Publishes a message on the topic. This is a convenience method, which will + create a new MqttMessage object with a byte array payload and the + specified QoS, and then publish it. All other values in the + message will be set to the defaults. +

+

+
Parameters:
payload - the byte array to use as the payload
qos - the Quality of Service. Valid values are 0, 1 or 2.
retained - whether or not this message should be retained by the server. +
Throws: +
java.lang.IllegalArgumentException - if value of QoS is not 0, 1 or 2. +
MqttException +
MqttPersistenceException
See Also:
publish(MqttMessage), +MqttMessage.setQos(int), +MqttMessage.setRetained(boolean)
+
+
+
+ +

+publish

+
+public MqttDeliveryToken publish(MqttMessage message)
+                          throws MqttException,
+                                 MqttPersistenceException
+
+
Publishes the specified message to this topic, but doesn't wait for + a response. The returned token can be used + to track the delivery status of the message. Once this message has + returned cleanly, the message has been accepted for publication by the + client - as long as a connection is available, it will try and deliver it. +

+

+
Parameters:
message - the message to publish +
Returns:
an MqttDeliveryToken for tracking the delivery of the message +
Throws: +
MqttException +
MqttPersistenceException
+
+
+
+ +

+getName

+
+public java.lang.String getName()
+
+
Returns the name of the queue or topic. +

+

+ +
Returns:
the name of this destination.
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
Returns a string representation of this topic. +

+

+ +
Returns:
a string representation of this topic.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package   Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttCallback.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttCallback.html new file mode 100644 index 0000000..7ee8d4e --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttCallback.html @@ -0,0 +1,160 @@ + + + + + + +Uses of Interface org.eclipse.paho.client.mqttv3.MqttCallback (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Interface
org.eclipse.paho.client.mqttv3.MqttCallback

+
+ + + + + +
+Uses of MqttCallback in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 with parameters of type MqttCallback +
+ voidMqttClient.setCallback(MqttCallback callback) + +
+          Sets the callback listener to use for asynchronously received + messages. +
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttClient.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttClient.html new file mode 100644 index 0000000..ca73662 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttClient.html @@ -0,0 +1,135 @@ + + + + + + +Uses of Class org.eclipse.paho.client.mqttv3.MqttClient (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Class
org.eclipse.paho.client.mqttv3.MqttClient

+
+No usage of org.eclipse.paho.client.mqttv3.MqttClient +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttClientPersistence.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttClientPersistence.html new file mode 100644 index 0000000..766f277 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttClientPersistence.html @@ -0,0 +1,178 @@ + + + + + + +Uses of Interface org.eclipse.paho.client.mqttv3.MqttClientPersistence (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Interface
org.eclipse.paho.client.mqttv3.MqttClientPersistence

+
+ + + + + +
+Uses of MqttClientPersistence in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + +
Classes in org.eclipse.paho.client.mqttv3 that implement MqttClientPersistence +
+ classMqttDefaultFilePersistence + +
+          An implementation of the MqttClientPersistence interface that provides + file based persistence. + +
+  +

+ + + + + + + +
Constructors in org.eclipse.paho.client.mqttv3 with parameters of type MqttClientPersistence +
MqttClient(java.lang.String serverURI, + java.lang.String clientId, + MqttClientPersistence persistence) + +
+          Creates an MqttClient to connect to the specified address, using the + specified client identifer and persistence implementation.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttConnectOptions.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttConnectOptions.html new file mode 100644 index 0000000..14849f2 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttConnectOptions.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class org.eclipse.paho.client.mqttv3.MqttConnectOptions (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Class
org.eclipse.paho.client.mqttv3.MqttConnectOptions

+
+ + + + + +
+Uses of MqttConnectOptions in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 with parameters of type MqttConnectOptions +
+ voidMqttClient.connect(MqttConnectOptions options) + +
+          Connects to a server using the specified options. +
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttDefaultFilePersistence.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttDefaultFilePersistence.html new file mode 100644 index 0000000..1209ddf --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttDefaultFilePersistence.html @@ -0,0 +1,135 @@ + + + + + + +Uses of Class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Class
org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence

+
+No usage of org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttDeliveryToken.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttDeliveryToken.html new file mode 100644 index 0000000..e0598f4 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttDeliveryToken.html @@ -0,0 +1,194 @@ + + + + + + +Uses of Interface org.eclipse.paho.client.mqttv3.MqttDeliveryToken (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Interface
org.eclipse.paho.client.mqttv3.MqttDeliveryToken

+
+ + + + + +
+Uses of MqttDeliveryToken in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 that return MqttDeliveryToken +
+ MqttDeliveryTokenMqttTopic.publish(byte[] payload, + int qos, + boolean retained) + +
+          Publishes a message on the topic.
+ MqttDeliveryTokenMqttTopic.publish(MqttMessage message) + +
+          Publishes the specified message to this topic, but doesn't wait for + a response.
+ MqttDeliveryToken[]MqttClient.getPendingDeliveryTokens() + +
+          Returns the delivery tokens for any outstanding publish operations.
+  +

+ + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 with parameters of type MqttDeliveryToken +
+ voidMqttCallback.deliveryComplete(MqttDeliveryToken token) + +
+          Called when delivery for a message has been completed, and all + acknowledgements have been received.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttException.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttException.html new file mode 100644 index 0000000..025222d --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttException.html @@ -0,0 +1,357 @@ + + + + + + +Uses of Class org.eclipse.paho.client.mqttv3.MqttException (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Class
org.eclipse.paho.client.mqttv3.MqttException

+
+ + + + + +
+Uses of MqttException in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + + + + + +
Subclasses of MqttException in org.eclipse.paho.client.mqttv3 +
+ classMqttPersistenceException + +
+          This exception should be thrown by the implementor of the persistence + interface if there is a problem reading or writing persistent data.
+ classMqttSecurityException + +
+          Thrown when a client is not authorized to perform an operation, or + if there is a problem with the security configuration.
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 that throw MqttException +
+ MqttDeliveryTokenMqttTopic.publish(byte[] payload, + int qos, + boolean retained) + +
+          Publishes a message on the topic.
+ MqttDeliveryTokenMqttTopic.publish(MqttMessage message) + +
+          Publishes the specified message to this topic, but doesn't wait for + a response.
+ byte[]MqttMessage.getPayload() + +
+          Returns the payload as a byte array.
+ voidMqttDeliveryToken.waitForCompletion() + +
+          Blocks the current thread until the message this is the token + for completes delivery.
+ voidMqttDeliveryToken.waitForCompletion(long timeout) + +
+          Blocks the current thread until the message this is the token + for completes delivery. +
+ MqttMessageMqttDeliveryToken.getMessage() + +
+          Returns the message associated with this token, or null if the message has + already been successfully sent.
+ voidMqttClient.connect() + +
+          Connects to a server using the default options. +
+ voidMqttClient.connect(MqttConnectOptions options) + +
+          Connects to a server using the specified options. +
+ voidMqttClient.disconnect() + +
+          Disconnects from the server, which quiesces for up to a + maximum of thirty seconds, to allow the client to finish any work it + currently has.
+ voidMqttClient.disconnect(long quiesceTimeout) + +
+          Disconnects from the server. +
+ voidMqttClient.subscribe(java.lang.String topicFilter) + +
+          Subscribes to a topic, which may include wildcards, using the default + options.
+ voidMqttClient.subscribe(java.lang.String[] topicFilters) + +
+          Subscribes to multiple topics, each of which may include wildcards, + using the default options.
+ voidMqttClient.subscribe(java.lang.String topicFilter, + int qos) + +
+          Subscribes to a topic, which may include wildcards, using the specified + options.
+ voidMqttClient.subscribe(java.lang.String[] topicFilters, + int[] qos) + +
+          Subscribes to multiple topics, each of which may include wildcards, + using the specified options.
+ voidMqttClient.unsubscribe(java.lang.String topicFilter) + +
+          Unsubscribes from a topic.
+ voidMqttClient.unsubscribe(java.lang.String[] topicFilters) + +
+          Unsubscribes from multiple topics.
+ voidMqttClient.setCallback(MqttCallback callback) + +
+          Sets the callback listener to use for asynchronously received + messages. +
+  +

+ + + + + + + + + + +
Constructors in org.eclipse.paho.client.mqttv3 that throw MqttException +
MqttClient(java.lang.String serverURI, + java.lang.String clientId) + +
+          Creates an MqttClient to connect to the specified address, using the + specified client identifier.
MqttClient(java.lang.String serverURI, + java.lang.String clientId, + MqttClientPersistence persistence) + +
+          Creates an MqttClient to connect to the specified address, using the + specified client identifer and persistence implementation.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttMessage.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttMessage.html new file mode 100644 index 0000000..e312ca1 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttMessage.html @@ -0,0 +1,196 @@ + + + + + + +Uses of Class org.eclipse.paho.client.mqttv3.MqttMessage (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Class
org.eclipse.paho.client.mqttv3.MqttMessage

+
+ + + + + +
+Uses of MqttMessage in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 that return MqttMessage +
+ MqttMessageMqttDeliveryToken.getMessage() + +
+          Returns the message associated with this token, or null if the message has + already been successfully sent.
+ MqttMessageMqttConnectOptions.getWillMessage() + +
+          Returns the message to be sent as last will and testament (LWT). +
+  +

+ + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 with parameters of type MqttMessage +
+ MqttDeliveryTokenMqttTopic.publish(MqttMessage message) + +
+          Publishes the specified message to this topic, but doesn't wait for + a response.
+ voidMqttCallback.messageArrived(MqttTopic topic, + MqttMessage message) + +
+          This method is called when a message arrives from the server. + +
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttPersistable.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttPersistable.html new file mode 100644 index 0000000..ab71c74 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttPersistable.html @@ -0,0 +1,193 @@ + + + + + + +Uses of Interface org.eclipse.paho.client.mqttv3.MqttPersistable (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Interface
org.eclipse.paho.client.mqttv3.MqttPersistable

+
+ + + + + +
+Uses of MqttPersistable in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 that return MqttPersistable +
+ MqttPersistableMqttDefaultFilePersistence.get(java.lang.String key) + +
+           
+ MqttPersistableMqttClientPersistence.get(java.lang.String key) + +
+          Gets the specified data out of the persistent store.
+  +

+ + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 with parameters of type MqttPersistable +
+ voidMqttDefaultFilePersistence.put(java.lang.String key, + MqttPersistable message) + +
+          Writes the specified persistent data to the previously specified persistence directory. +
+ voidMqttClientPersistence.put(java.lang.String key, + MqttPersistable persistable) + +
+          Puts the specified data into the persistent store.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttPersistenceException.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttPersistenceException.html new file mode 100644 index 0000000..a409d45 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttPersistenceException.html @@ -0,0 +1,374 @@ + + + + + + +Uses of Class org.eclipse.paho.client.mqttv3.MqttPersistenceException (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Class
org.eclipse.paho.client.mqttv3.MqttPersistenceException

+
+ + + + + +
+Uses of MqttPersistenceException in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 that throw MqttPersistenceException +
+ MqttDeliveryTokenMqttTopic.publish(byte[] payload, + int qos, + boolean retained) + +
+          Publishes a message on the topic.
+ MqttDeliveryTokenMqttTopic.publish(MqttMessage message) + +
+          Publishes the specified message to this topic, but doesn't wait for + a response.
+ byte[]MqttPersistable.getHeaderBytes() + +
+          Returns the header bytes in an array. +
+ intMqttPersistable.getHeaderLength() + +
+          Returns the length of the header.
+ intMqttPersistable.getHeaderOffset() + +
+          Returns the offset of the header within the byte array returned by MqttPersistable.getHeaderBytes().
+ byte[]MqttPersistable.getPayloadBytes() + +
+          Returns the payload bytes in an array. +
+ intMqttPersistable.getPayloadLength() + +
+          Returns the length of the payload.
+ intMqttPersistable.getPayloadOffset() + +
+          Returns the offset of the payload within the byte array returned by MqttPersistable.getPayloadBytes().
+ voidMqttDefaultFilePersistence.open(java.lang.String clientId, + java.lang.String theConnection) + +
+           
+ voidMqttDefaultFilePersistence.close() + +
+           
+ voidMqttDefaultFilePersistence.put(java.lang.String key, + MqttPersistable message) + +
+          Writes the specified persistent data to the previously specified persistence directory. +
+ MqttPersistableMqttDefaultFilePersistence.get(java.lang.String key) + +
+           
+ voidMqttDefaultFilePersistence.remove(java.lang.String key) + +
+          Deletes the data with the specified key from the previously specified persistence directory.
+ java.util.EnumerationMqttDefaultFilePersistence.keys() + +
+          Returns all of the persistent data from the previously specified persistence directory.
+ booleanMqttDefaultFilePersistence.containsKey(java.lang.String key) + +
+           
+ voidMqttDefaultFilePersistence.clear() + +
+           
+ voidMqttClientPersistence.open(java.lang.String clientId, + java.lang.String serverURI) + +
+          Initialise the persistent store. +
+ voidMqttClientPersistence.close() + +
+          Close the persistent store that was previously opened. +
+ voidMqttClientPersistence.put(java.lang.String key, + MqttPersistable persistable) + +
+          Puts the specified data into the persistent store.
+ MqttPersistableMqttClientPersistence.get(java.lang.String key) + +
+          Gets the specified data out of the persistent store.
+ voidMqttClientPersistence.remove(java.lang.String key) + +
+          Remove the data for the specified key.
+ java.util.EnumerationMqttClientPersistence.keys() + +
+          Returns an Enumeration over the keys in this persistent data store.
+ voidMqttClientPersistence.clear() + +
+          Clears persistence, so that it no longer contains any persisted data.
+ booleanMqttClientPersistence.containsKey(java.lang.String key) + +
+          Returns whether or not data is persisted using the specified key.
+  +

+ + + + + + + + + + +
Constructors in org.eclipse.paho.client.mqttv3 that throw MqttPersistenceException +
MqttDefaultFilePersistence() + +
+           
MqttDefaultFilePersistence(java.lang.String directory) + +
+          Create an file-based persistent data store within the specified directory.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttSecurityException.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttSecurityException.html new file mode 100644 index 0000000..fa4a319 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttSecurityException.html @@ -0,0 +1,225 @@ + + + + + + +Uses of Class org.eclipse.paho.client.mqttv3.MqttSecurityException (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Class
org.eclipse.paho.client.mqttv3.MqttSecurityException

+
+ + + + + +
+Uses of MqttSecurityException in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 that throw MqttSecurityException +
+ voidMqttDeliveryToken.waitForCompletion() + +
+          Blocks the current thread until the message this is the token + for completes delivery.
+ voidMqttDeliveryToken.waitForCompletion(long timeout) + +
+          Blocks the current thread until the message this is the token + for completes delivery. +
+ voidMqttClient.connect() + +
+          Connects to a server using the default options. +
+ voidMqttClient.connect(MqttConnectOptions options) + +
+          Connects to a server using the specified options. +
+ voidMqttClient.subscribe(java.lang.String topicFilter) + +
+          Subscribes to a topic, which may include wildcards, using the default + options.
+ voidMqttClient.subscribe(java.lang.String[] topicFilters) + +
+          Subscribes to multiple topics, each of which may include wildcards, + using the default options.
+ voidMqttClient.subscribe(java.lang.String topicFilter, + int qos) + +
+          Subscribes to a topic, which may include wildcards, using the specified + options.
+ voidMqttClient.subscribe(java.lang.String[] topicFilters, + int[] qos) + +
+          Subscribes to multiple topics, each of which may include wildcards, + using the specified options.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttTopic.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttTopic.html new file mode 100644 index 0000000..5c45f0e --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/class-use/MqttTopic.html @@ -0,0 +1,198 @@ + + + + + + +Uses of Class org.eclipse.paho.client.mqttv3.MqttTopic (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Class
org.eclipse.paho.client.mqttv3.MqttTopic

+
+ + + + + +
+Uses of MqttTopic in org.eclipse.paho.client.mqttv3
+  +

+ + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 that return MqttTopic +
+ MqttTopicMqttConnectOptions.getWillDestination() + +
+          Returns the topic to be used for last will and testament (LWT).
+ MqttTopicMqttClient.getTopic(java.lang.String topic) + +
+          Gets a topic object which can be used to publish messages. +
+  +

+ + + + + + + + + + + + +
Methods in org.eclipse.paho.client.mqttv3 with parameters of type MqttTopic +
+ voidMqttConnectOptions.setWill(MqttTopic topic, + byte[] payload, + int qos, + boolean retained) + +
+          Sets the "Last Will and Testament" (LWT) for the connection. +
+ voidMqttCallback.messageArrived(MqttTopic topic, + MqttMessage message) + +
+          This method is called when a message arrives from the server. + +
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-frame.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-frame.html new file mode 100644 index 0000000..9cb0f45 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-frame.html @@ -0,0 +1,72 @@ + + + + + + +org.eclipse.paho.client.mqttv3 (MQTT v3 Client API) + + + + + + + + + + + +org.eclipse.paho.client.mqttv3 + + + + +
+Interfaces  + +
+MqttCallback +
+MqttClientPersistence +
+MqttDeliveryToken +
+MqttPersistable
+ + + + + + +
+Classes  + +
+MqttClient +
+MqttConnectOptions +
+MqttDefaultFilePersistence +
+MqttMessage +
+MqttTopic
+ + + + + + +
+Exceptions  + +
+MqttException +
+MqttPersistenceException +
+MqttSecurityException
+ + + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-summary.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-summary.html new file mode 100644 index 0000000..abd1447 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-summary.html @@ -0,0 +1,422 @@ + + + + + + +org.eclipse.paho.client.mqttv3 (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
 Package  Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +

+Package org.eclipse.paho.client.mqttv3 +

+Contains an API for connecting to a server which implements the MQTT V3 +protocol. + + +

+See: +
+          Description +

+ + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
MqttCallbackAsynchronous message listener.
MqttClientPersistenceRepresents a persistent data store, used to store outbound and inbound messages while they + are in flight, enabling delivery to the QOS specified.
MqttDeliveryTokenProvides a mechanism for tracking the delivery of messages. + +
MqttPersistableRepresents an object used to pass data to be persisted across the + MqttClientPersistence + interface. +
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
MqttClientLightweight client for talking to a server via the MQTT version 3 + protocol.
MqttConnectOptionsStores options used when connecting to a server.
MqttDefaultFilePersistenceAn implementation of the MqttClientPersistence interface that provides + file based persistence. + +
MqttMessageAn MQTT message.
MqttTopicRepresents a topic destination, used for publish/subscribe messaging.
+  + +

+ + + + + + + + + + + + + + + + + +
+Exception Summary
MqttExceptionThrown if an error occurs communicating with the server.
MqttPersistenceExceptionThis exception should be thrown by the implementor of the persistence + interface if there is a problem reading or writing persistent data.
MqttSecurityExceptionThrown when a client is not authorized to perform an operation, or + if there is a problem with the security configuration.
+  + +

+

+Package org.eclipse.paho.client.mqttv3 Description +

+ +

+Contains an API for connecting to a server which implements the MQTT V3 +protocol. + +

+The MQ Telemetry Transport (MQTT) is a lightweight publish/subscribe protocol +flowing over TCP/IP for remote sensors and control devices through low +bandwidth communications. MQTT is used by specialized applications on +small footprint devices that require a low bandwidth communication, +typically for remote data acquisition and process control. +

+

+A typical system might comprise several hundred client devices communicating +with a single server or "broker", where each client is identified +by a unique ID. +

+

The basic means of operating the client is as follows:

+
    +
  1. Create an instance of MqttClient, providing + the address of the server and a unique client identifier.
    2. +
  2. Connect to the server
    3. +
  3. Exchange messages with the server. + +
    4. +
  4. Disconnect from the server.
    5. +
+

+

Examples

+

Publish a message, at most once

+

In the following code snippet, a simple message is published to the server, +using defaults wherever possible.

+
	MqttClient client = new MqttClient("tcp://localhost:1883", "SampleClient");
+	client.connect();
+	MqttMessage message = new MqttMessage("Hello world");
+	message.setQos(0);
+	client.getTopic("foo/bar").publish(message);
+	client.disconnect();
 + +

This is the fastest way of publishing messages, +but is also the least reliable. There is no assurance that the message will actually be +delivered, and no exception will be thrown if the server refuses the message, or if the +network connection fails.

+ +

Publish a message, once and only once (single threaded)

+

In the following code snippet, a message is published to the server +at QoS 2, which is the most reliable delivery mechanism. +In order to achieve this, the message needs to be persisted by the client. +A default implementation of persistence is provided by MqttDefaultFilePersistence. +This will be used by the client unless an alternative is supplied.

+

Publishing reliably is more complex, and most of the code is used to handle +error conditions. The key thing to notice is the two-stage delivery: the first +stage gives the message to the client. After this, the client is responsible for +delivering the message to the server. The second stage is about determining +success or failure.

+ +
+	MqttClient client = null;
+	try {
+		// Create a client to communicate with a broker at the specified address
+		client = new MqttClient("tcp://localhost:1883", "SampleClient");
+		// Connect to the broker
+		client.connect();
+	} catch (MqttException ex) {
+		System.err.println("Could not connect");
+	}
+	
+	if ((client != null) && client.isConnected()) {
+		MqttTopic topic = client.getTopic("foo/bar");
+		MqttDeliveryToken token = null;
+		// Create message and set quality of service to deliver the message once
+		MqttMessage message = new MqttMessage("Hello world");
+		message.setQos(2);
+		
+		try {
+			// Give the message to the client for publishing.  For QoS 2,
+			// this will involve multiple network calls, which will happen 
+			// asynchronously after this method has returned.
+			token = topic.publish(message);
+		}
+		catch (MqttException ex) {
+			// Client has not accepted the message due to a failure
+			// Depending on the exception's reason code, we could always retry
+			System.err.println("Failed to send message");
+		}
+		
+		if (token != null) {
+			boolean keepTrying = true;
+			do {
+				try {
+					// Wait for the message delivery to complete
+					token.waitForCompletion();
+					System.out.println("Message delivery complete");
+				}
+				catch (MqttException deliveryException) {
+					int reasonCode = deliveryException.getReasonCode();
+					// TODO: Retry the message, or decide to stop trying
+					System.err.println("Message delivery failed");
+					if (client.isConnected() == false) {
+						try {
+							// Re-connect to the server
+							client.connect();
+						}
+						catch (MqttException connectException) {
+							// Can't reconnect, so give up.  If and when the 
+							// client does reconnect, the message delivery
+							// will automatically continue
+							keepTrying = false;
+						}
+					}
+				}
+			} while (!token.isComplete() && keepTrying);
+		}
+	}
 + +

Publish a message, once and only once (multi-threaded)

+

In the following code snippet, a message is published to the server +at QoS 2, which is the most reliable delivery mechanism. +The application uses a callback to asynchronously be notified +when delivery of a message has been completed.

+ +

+A default implementation of persistence is provided by MqttDefaultFilePersistence. +This will be used by the client unless an alternative is supplied.

+ +
+public class SampleClient implements MqttCallback {
+	public void run() {
+		MqttClient client = null;
+		try {
+			// Create a client to communicate with a broker at the specified address
+			client = new MqttClient("tcp://localhost:1883", "SampleClient");
+
+			// Connect to the broker
+			client.connect();
+
+			// Setup a callback
+			client.setCallback(this);
+
+		} catch (MqttException ex) {
+			System.err.println("Could not connect");
+		}
+		
+		if ((client != null) && client.isConnected()) {
+			MqttTopic topic = client.getTopic("foo/bar");
+			// Create message and set quality of service to deliver the message once
+			MqttMessage message = new MqttMessage("Hello world");
+			message.setQos(2);
+	
+			try {
+				// Give the message to the client for publishing. For QoS 2, this
+				// will involve multiple network calls, which will happen
+				// asynchronously after this method has returned.
+				topic.publish(message);
+			} catch (MqttException ex) {
+				// Client has not accepted the message due to a failure
+				// Depending on the exception's reason code, we could always retry
+				System.err.println("Failed to send message");
+			}
+		}
+	}
+
+	public void connectionLost(Throwable cause) {
+		// TODO: Implement reconnection logic
+		System.err.println("Connection lost");
+	}
+
+	public void deliveryComplete(MqttDeliveryToken token) {
+		System.out.println("Delivery complete");
+	}
+
+	public void messageArrived(MqttTopic topic, MqttMessage message) throws Exception {
+	}
+}
 +

+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
 Package  Class  Use  Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-tree.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-tree.html new file mode 100644 index 0000000..2d33494 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +org.eclipse.paho.client.mqttv3 Class Hierarchy (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package  Class  Use   Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Hierarchy For Package org.eclipse.paho.client.mqttv3 +

+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Package  Class  Use   Tree  Serialized  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-use.html b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-use.html new file mode 100644 index 0000000..9eee323 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/org/eclipse/paho/client/mqttv3/package-use.html @@ -0,0 +1,210 @@ + + + + + + +Uses of Package org.eclipse.paho.client.mqttv3 (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ +
+

+Uses of Package
org.eclipse.paho.client.mqttv3

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in org.eclipse.paho.client.mqttv3 used by org.eclipse.paho.client.mqttv3
MqttCallback + +
+          Asynchronous message listener.
MqttClientPersistence + +
+          Represents a persistent data store, used to store outbound and inbound messages while they + are in flight, enabling delivery to the QOS specified.
MqttConnectOptions + +
+          Stores options used when connecting to a server.
MqttDeliveryToken + +
+          Provides a mechanism for tracking the delivery of messages. + +
MqttException + +
+          Thrown if an error occurs communicating with the server.
MqttMessage + +
+          An MQTT message.
MqttPersistable + +
+          Represents an object used to pass data to be persisted across the + MqttClientPersistence + interface. +
MqttPersistenceException + +
+          This exception should be thrown by the implementor of the persistence + interface if there is a problem reading or writing persistent data.
MqttSecurityException + +
+          Thrown when a client is not authorized to perform an operation, or + if there is a problem with the security configuration.
MqttTopic + +
+          Represents a topic destination, used for publish/subscribe messaging.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + -- cgit v1.2.1