+Index (MQTT v3 Client API) +

From cc8ace92f17c8e5aef7d68ff316e5cd038cd36b5 Mon Sep 17 00:00:00 2001 From: Nathan Lasseter Date: Wed, 22 May 2013 15:34:00 +0100 Subject: Initial Commit --- libs/org.eclipse.paho.client.mqttv3/index-all.html | 615 +++++++++++++++++++++ 1 file changed, 615 insertions(+) create mode 100644 libs/org.eclipse.paho.client.mqttv3/index-all.html (limited to 'libs/org.eclipse.paho.client.mqttv3/index-all.html') diff --git a/libs/org.eclipse.paho.client.mqttv3/index-all.html b/libs/org.eclipse.paho.client.mqttv3/index-all.html new file mode 100644 index 0000000..ac66d33 --- /dev/null +++ b/libs/org.eclipse.paho.client.mqttv3/index-all.html @@ -0,0 +1,615 @@ + + + + + + +Index (MQTT v3 Client API) + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

+ +

+ PREV + NEXT

+ FRAMES + NO FRAMES + + + +

+ + + + +C D G I K M O P R S T U W

+C

clear() - +Method in interface org.eclipse.paho.client.mqttv3.MqttClientPersistence +: Clears persistence, so that it no longer contains any persisted data. +
clear() - +Method in class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: +
clearPayload() - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Clears the payload, resetting it to be empty. +
close() - +Method in interface org.eclipse.paho.client.mqttv3.MqttClientPersistence +: Close the persistent store that was previously opened. + +
close() - +Method in class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: +
connect() - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Connects to a server using the default options. + +
connect(MqttConnectOptions) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Connects to a server using the specified options. + +
connectionLost(Throwable) - +Method in interface org.eclipse.paho.client.mqttv3.MqttCallback +: This method is called when the connection to the server is lost. +
containsKey(String) - +Method in interface org.eclipse.paho.client.mqttv3.MqttClientPersistence +: Returns whether or not data is persisted using the specified key. +
containsKey(String) - +Method in class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: +

+D

deliveryComplete(MqttDeliveryToken) - +Method in interface org.eclipse.paho.client.mqttv3.MqttCallback +: Called when delivery for a message has been completed, and all + acknowledgements have been received. +
disconnect() - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: 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. +
disconnect(long) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Disconnects from the server. + +

+G

generateClientId() - +Static method in class org.eclipse.paho.client.mqttv3.MqttClient +: Returns a randomly generated client identifier based on the current user's login + name and the system time. + +
get(String) - +Method in interface org.eclipse.paho.client.mqttv3.MqttClientPersistence +: Gets the specified data out of the persistent store. +
get(String) - +Method in class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: +
getCause() - +Method in class org.eclipse.paho.client.mqttv3.MqttException +: Returns the underlying cause of this exception, if available. +
getClientId() - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Returns the client ID used by this client. +
getConnectionTimeout() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns the connection timeout value. +
getHeaderBytes() - +Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable +: Returns the header bytes in an array. + +
getHeaderLength() - +Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable +: Returns the length of the header. +
getHeaderOffset() - +Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable +: Returns the offset of the header within the byte array returned by MqttPersistable.getHeaderBytes(). +
getKeepAliveInterval() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns the "keep alive" interval. +
getMessage() - +Method in interface org.eclipse.paho.client.mqttv3.MqttDeliveryToken +: Returns the message associated with this token, or null if the message has + already been successfully sent. +
getMessage() - +Method in class org.eclipse.paho.client.mqttv3.MqttException +: Returns the detail message for this exception. +
getName() - +Method in class org.eclipse.paho.client.mqttv3.MqttTopic +: Returns the name of the queue or topic. +
getPassword() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns the password to use for the connection. +
getPayload() - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Returns the payload as a byte array. +
getPayloadBytes() - +Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable +: Returns the payload bytes in an array. + +
getPayloadLength() - +Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable +: Returns the length of the payload. +
getPayloadOffset() - +Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable +: Returns the offset of the payload within the byte array returned by MqttPersistable.getPayloadBytes(). +
getPendingDeliveryTokens() - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Returns the delivery tokens for any outstanding publish operations. +
getQos() - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Returns the quality of service for this message. +
getReasonCode() - +Method in class org.eclipse.paho.client.mqttv3.MqttException +: Returns the reason code for this exception. +
getSSLProperties() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns the SSL properties for the connection. +
getServerURI() - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Returns the address of the server used by this client, as a URI. + +
getSocketFactory() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns the socket factory that will be used when connecting, or + null if one has not been set. +
getTopic(String) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Gets a topic object which can be used to publish messages. + +
getUserName() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns the user name to use for the connection. +
getWillDestination() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns the topic to be used for last will and testament (LWT). +
getWillMessage() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns the message to be sent as last will and testament (LWT). + +

+I

isCleanSession() - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Returns whether the server should remember state for the client across reconnects. +
isComplete() - +Method in interface org.eclipse.paho.client.mqttv3.MqttDeliveryToken +: Returns whether or not the delivery has finished. +
isConnected() - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Determines if this client is currently connected to the + server. +
isDuplicate() - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Returns whether or not this message might be a duplicate of one which has + already been received. +
isRetained() - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Returns whether or not this message should be/was retained by the server. + +

+K

keys() - +Method in interface org.eclipse.paho.client.mqttv3.MqttClientPersistence +: Returns an Enumeration over the keys in this persistent data store. +
keys() - +Method in class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: Returns all of the persistent data from the previously specified persistence directory. +

+M

MqttCallback - interface org.eclipse.paho.client.mqttv3.MqttCallback.: Asynchronous message listener.
MqttClient - class org.eclipse.paho.client.mqttv3.MqttClient.: Lightweight client for talking to a server via the MQTT version 3 + protocol.
MqttClient(String, String) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttClient +: Creates an MqttClient to connect to the specified address, using the + specified client identifier. +
MqttClient(String, String, MqttClientPersistence) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttClient +: Creates an MqttClient to connect to the specified address, using the + specified client identifer and persistence implementation. +
MqttClientPersistence - interface org.eclipse.paho.client.mqttv3.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 - class org.eclipse.paho.client.mqttv3.MqttConnectOptions.: Stores options used when connecting to a server.
MqttConnectOptions() - +Constructor for class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Constructs a new MqttConnectOptions object using the + default values. + + +
MqttDefaultFilePersistence - class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence.: An implementation of the MqttClientPersistence interface that provides + file based persistence. + +
MqttDefaultFilePersistence() - +Constructor for class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: +
MqttDefaultFilePersistence(String) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: Create an file-based persistent data store within the specified directory. +
MqttDeliveryToken - interface org.eclipse.paho.client.mqttv3.MqttDeliveryToken.: Provides a mechanism for tracking the delivery of messages. + +
MqttException - exception org.eclipse.paho.client.mqttv3.MqttException.: Thrown if an error occurs communicating with the server.
MqttException(int) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttException +: Constructs a new MqttException with the specified code + as the underlying reason. +
MqttException(Throwable) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttException +: Constructs a new MqttException with the specified + Throwable as the underlying reason. +
MqttException(int, Throwable) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttException +: Constructs a new MqttException with the specified + Throwable as the underlying reason. +
MqttMessage - class org.eclipse.paho.client.mqttv3.MqttMessage.: An MQTT message.
MqttMessage() - +Constructor for class org.eclipse.paho.client.mqttv3.MqttMessage +: Constructs a message with an empty payload, and all other values + set to defaults. + + +
MqttMessage(byte[]) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttMessage +: Constructs a message with the specified byte array as a payload, + and all other values set to defaults. +
MqttPersistable - interface org.eclipse.paho.client.mqttv3.MqttPersistable.: Represents an object used to pass data to be persisted across the + MqttClientPersistence + interface. +
MqttPersistenceException - exception org.eclipse.paho.client.mqttv3.MqttPersistenceException.: This exception should be thrown by the implementor of the persistence + interface if there is a problem reading or writing persistent data.
MqttPersistenceException() - +Constructor for class org.eclipse.paho.client.mqttv3.MqttPersistenceException +: Constructs a new MqttPersistenceException +
MqttPersistenceException(int) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttPersistenceException +: Constructs a new MqttPersistenceException with the specified code + as the underlying reason. +
MqttPersistenceException(Throwable) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttPersistenceException +: Constructs a new MqttPersistenceException with the specified + Throwable as the underlying reason. +
MqttSecurityException - exception org.eclipse.paho.client.mqttv3.MqttSecurityException.: Thrown when a client is not authorized to perform an operation, or + if there is a problem with the security configuration.
MqttSecurityException(int) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttSecurityException +: Constructs a new MqttSecurityException with the specified code + as the underlying reason. +
MqttSecurityException(Throwable) - +Constructor for class org.eclipse.paho.client.mqttv3.MqttSecurityException +: Constructs a new MqttSecurityException with the specified + Throwable as the underlying reason. +
MqttTopic - class org.eclipse.paho.client.mqttv3.MqttTopic.: Represents a topic destination, used for publish/subscribe messaging.
messageArrived(MqttTopic, MqttMessage) - +Method in interface org.eclipse.paho.client.mqttv3.MqttCallback +: This method is called when a message arrives from the server. + + +

+O

open(String, String) - +Method in interface org.eclipse.paho.client.mqttv3.MqttClientPersistence +: Initialise the persistent store. + +
open(String, String) - +Method in class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: +
org.eclipse.paho.client.mqttv3 - package org.eclipse.paho.client.mqttv3: Contains an API for connecting to a server which implements the MQTT V3 +protocol. + +

+P

publish(byte[], int, boolean) - +Method in class org.eclipse.paho.client.mqttv3.MqttTopic +: Publishes a message on the topic. +
publish(MqttMessage) - +Method in class org.eclipse.paho.client.mqttv3.MqttTopic +: Publishes the specified message to this topic, but doesn't wait for + a response. +
put(String, MqttPersistable) - +Method in interface org.eclipse.paho.client.mqttv3.MqttClientPersistence +: Puts the specified data into the persistent store. +
put(String, MqttPersistable) - +Method in class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: Writes the specified persistent data to the previously specified persistence directory. + +

+R

REASON_CODE_BROKER_UNAVAILABLE - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: The broker was not available to handle the request. +
REASON_CODE_CLIENT_ALREADY_CONNECTED - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: The client is already connected. +
REASON_CODE_CLIENT_ALREADY_DISCONNECTED - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: The client is already disconnected. +
REASON_CODE_CLIENT_DISCONNECTING - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: The client is currently disconnecting and cannot accept any new work. + +
REASON_CODE_CLIENT_DISCONNECT_PROHIBITED - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Thrown when an attempt to call MqttClient.disconnect() has been + made from within a method on MqttCallback. +
REASON_CODE_CLIENT_EXCEPTION - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Client encountered an exception. +
REASON_CODE_CLIENT_NOT_CONNECTED - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: The client is not connected to the server. +
REASON_CODE_CLIENT_TIMEOUT - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Client timed out while waiting for a response from the server. + +
REASON_CODE_CONNECTION_LOST - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: The client has been unexpectedly disconnected from the server. +
REASON_CODE_FAILED_AUTHENTICATION - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Authentication with the server has failed, due to a bad user name or password. +
REASON_CODE_INVALID_CLIENT_ID - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: The server has rejected the supplied client ID +
REASON_CODE_INVALID_MESSAGE - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Protocol error: the message was not recognized as a valid MQTT packet. + +
REASON_CODE_INVALID_PROTOCOL_VERSION - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: The protocol version requested is not supported by the server. +
REASON_CODE_NOT_AUTHORIZED - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Not authorized to perform the requested operation +
REASON_CODE_NO_MESSAGE_IDS_AVAILABLE - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Internal error, caused by no new message IDs being available. +
REASON_CODE_PERSISTENCE_IN_USE - +Static variable in class org.eclipse.paho.client.mqttv3.MqttPersistenceException +: Persistence is already being used by another client. +
REASON_CODE_SERVER_CONNECT_ERROR - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Unable to connect to server +
REASON_CODE_SOCKET_FACTORY_MISMATCH - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: Server URI and supplied SocketFactory do not match. + +
REASON_CODE_SSL_CONFIG_ERROR - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: SSL configuration error. +
REASON_CODE_UNEXPECTED_ERROR - +Static variable in class org.eclipse.paho.client.mqttv3.MqttException +: An unexpected error has occurred. +
remove(String) - +Method in interface org.eclipse.paho.client.mqttv3.MqttClientPersistence +: Remove the data for the specified key. +
remove(String) - +Method in class org.eclipse.paho.client.mqttv3.MqttDefaultFilePersistence +: Deletes the data with the specified key from the previously specified persistence directory. +

+S

setCallback(MqttCallback) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Sets the callback listener to use for asynchronously received + messages. + +
setCleanSession(boolean) - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Sets whether the server should remember state for the client across reconnects. + +
setConnectionTimeout(int) - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Sets the connection timeout value. + +
setKeepAliveInterval(int) - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Sets the "keep alive" interval. + +
setPassword(char[]) - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Sets the password to use for the connection. +
setPayload(byte[]) - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Sets the payload of this message to be the specified byte array. +
setQos(int) - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Sets the quality of service for this message. + +
setRetained(boolean) - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Whether or not the publish message should be retained by the messaging engine. + +
setSSLProperties(Properties) - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Sets the SSL properties for the connection. +
setSocketFactory(SocketFactory) - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Sets the SocketFactory to use. +
setUserName(String) - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Sets the user name to use for the connection. +
setWill(MqttTopic, byte[], int, boolean) - +Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions +: Sets the "Last Will and Testament" (LWT) for the connection. + +
subscribe(String) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Subscribes to a topic, which may include wildcards, using the default + options. +
subscribe(String[]) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Subscribes to multiple topics, each of which may include wildcards, + using the default options. +
subscribe(String, int) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Subscribes to a topic, which may include wildcards, using the specified + options. +
subscribe(String[], int[]) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Subscribes to multiple topics, each of which may include wildcards, + using the specified options. +

+T

toString() - +Method in class org.eclipse.paho.client.mqttv3.MqttException +: Returns a String representation of this exception. +
toString() - +Method in class org.eclipse.paho.client.mqttv3.MqttMessage +: Returns a string representation of this message. +
toString() - +Method in class org.eclipse.paho.client.mqttv3.MqttTopic +: Returns a string representation of this topic. +

+U

unsubscribe(String) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Unsubscribes from a topic. +
unsubscribe(String[]) - +Method in class org.eclipse.paho.client.mqttv3.MqttClient +: Unsubscribes from multiple topics. +

+W

waitForCompletion() - +Method in interface org.eclipse.paho.client.mqttv3.MqttDeliveryToken +: Blocks the current thread until the message this is the token + for completes delivery. +
waitForCompletion(long) - +Method in interface org.eclipse.paho.client.mqttv3.MqttDeliveryToken +: Blocks the current thread until the message this is the token + for completes delivery. + +

+C D G I K M O P R S T U W + + + + + + + + + + + + + + +