Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W 

A

aClient - Variable in class org.eclipse.paho.client.mqttv3.MqttClient
 
appendFinAndOpCode(ByteBuffer, byte, boolean) - Static method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
Appends the Fin flag and the OpCode
appendLengthAndMask(ByteBuffer, int, byte[]) - Static method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
Appends the Length and Mask to the buffer
asyncOperationComplete(MqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
available() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttInputStream
 

B

Base64 - Class in org.eclipse.paho.client.mqttv3.internal.websocket
 
Base64() - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.Base64
 
Base64.Base64Encoder - Class in org.eclipse.paho.client.mqttv3.internal.websocket
 
Base64Encoder() - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
BufferedMessage - Class in org.eclipse.paho.client.mqttv3
A BufferedMessage contains an MqttWire Message and token it allows both message and token to be buffered when the client is in resting state
BufferedMessage(MqttWireMessage, MqttToken) - Constructor for class org.eclipse.paho.client.mqttv3.BufferedMessage
 
BUILD_LEVEL - Static variable in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 

C

Character_isHighSurrogate(char) - Static method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
checkForActivity() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
checkForActivity(IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
checkForActivity(IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Check and send a ping if needed and check for ping timeout.
checkMutable() - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
 
checkPing(Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
checkQuiesceLock() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
checkResult() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
childrenNamesSpi() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
childSpi(String) - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
CIPHERSUITES - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
CLEAN_SESSION_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
The default clean session setting if one is not specified
clear() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
Empties the token store without notifying any of the tokens.
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.persist.MemoryPersistence
 
clear() - Method in class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
 
clearPayload() - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
Clears the payload, resetting it to be empty.
clearState() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
CLIENTAUTH - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
ClientComms - Class in org.eclipse.paho.client.mqttv3.internal
Handles client communications with the server.
ClientComms(IMqttAsyncClient, MqttClientPersistence, MqttPingSender, ExecutorService) - Constructor for class org.eclipse.paho.client.mqttv3.internal.ClientComms
Creates a new ClientComms object, using the specified module to handle the network calls.
ClientDefaults - Class in org.eclipse.paho.client.mqttv3.internal
 
ClientDefaults() - Constructor for class org.eclipse.paho.client.mqttv3.internal.ClientDefaults
 
ClientState - Class in org.eclipse.paho.client.mqttv3.internal
The core of the client, which holds the state information for pending and in-flight messages.
ClientState(MqttClientPersistence, CommsTokenStore, CommsCallback, ClientComms, MqttPingSender) - Constructor for class org.eclipse.paho.client.mqttv3.internal.ClientState
 
close() - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Close the client Releases all resource associated with the client.
close() - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Close the client Releases all resource associated with the client.
close() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
Close and tidy up.
close() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Tidy up - ensure that tokens are released as they are maintained over a disconnect / connect cycle.
close() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttInputStream
 
close() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttOutputStream
 
close() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
close() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
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.persist.MemoryPersistence
 
close() - Method in class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
 
comms - Variable in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
CommsCallback - Class in org.eclipse.paho.client.mqttv3.internal
Bridge between Receiver and the external API.
CommsReceiver - Class in org.eclipse.paho.client.mqttv3.internal
Receives MQTT packets from the server.
CommsReceiver(ClientComms, ClientState, CommsTokenStore, InputStream) - Constructor for class org.eclipse.paho.client.mqttv3.internal.CommsReceiver
 
CommsSender - Class in org.eclipse.paho.client.mqttv3.internal
 
CommsSender(ClientComms, ClientState, CommsTokenStore, OutputStream) - Constructor for class org.eclipse.paho.client.mqttv3.internal.CommsSender
 
CommsTokenStore - Class in org.eclipse.paho.client.mqttv3.internal
Provides a "token" based system for storing and tracking actions across multiple threads.
CommsTokenStore(String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
config(String, String, String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
config(String, String, String, Object[]) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
config(String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
CONFIG - Static variable in interface org.eclipse.paho.client.mqttv3.logging.Logger
CONFIG is a message level for static configuration messages.
config(String, String, String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, if the logger is currently enabled for the given message level.
config(String, String, String, Object[]) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments, if the logger is currently enabled for the given message level.
config(String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments and a throwable, if the logger is currently enabled for the given message level.
connect() - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Connects to an MQTT server using the default options.
connect(MqttConnectOptions) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Connects to an MQTT server using the provided connect options.
connect(Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Connects to an MQTT server using the default options.
connect(MqttConnectOptions, Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Connects to an MQTT server using the specified options.
connect() - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Connects to an MQTT server using the default options.
connect(MqttConnectOptions) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Connects to an MQTT server using the specified options.
connect(MqttConnectOptions, MqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
Sends a connect message and waits for an ACK or NACK.
connect() - Method in class org.eclipse.paho.client.mqttv3.internal.ConnectActionListener
Start the connect processing
connect(Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
connect() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
connect(MqttConnectOptions) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
connect(MqttConnectOptions, Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
connect() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
connect(MqttConnectOptions) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
ConnectActionListener - Class in org.eclipse.paho.client.mqttv3.internal
This class handles the connection of the AsyncClient to one of the available URLs.
ConnectActionListener(MqttAsyncClient, MqttClientPersistence, ClientComms, MqttConnectOptions, MqttToken, Object, IMqttActionListener, boolean) - Constructor for class org.eclipse.paho.client.mqttv3.internal.ConnectActionListener
 
connectComplete(MqttConnack, MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
connectComplete(boolean, String) - Method in interface org.eclipse.paho.client.mqttv3.MqttCallbackExtended
Called when the connection to the server is completed successfully.
connected() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Called when the client has successfully connected to the broker
CONNECTION_TIMEOUT_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
The default connection timeout in seconds if one is not specified
connectionLost(MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
This method is called when the connection to the server is lost.
connectionLost(Throwable) - Method in interface org.eclipse.paho.client.mqttv3.MqttCallback
This method is called when the connection to the server is lost.
connectWithResult(MqttConnectOptions) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Connects to an MQTT server using the specified options.
connectWithResult(MqttConnectOptions) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
containsAny(CharSequence, CharSequence) - Static method in class org.eclipse.paho.client.mqttv3.util.Strings
Checks if the CharSequence contains any character in the given set of characters.
containsAny(CharSequence, char[]) - Static method in class org.eclipse.paho.client.mqttv3.util.Strings
Checks if the CharSequence contains any character in the given set of characters.
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.persist.MemoryPersistence
 
containsKey(String) - Method in class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
 
count() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
CountingInputStream - Class in org.eclipse.paho.client.mqttv3.internal.wire
An input stream that counts the bytes read from it.
CountingInputStream(InputStream) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.CountingInputStream
Constructs a new CountingInputStream wrapping the supplied input stream.
countMatches(CharSequence, CharSequence) - Static method in class org.eclipse.paho.client.mqttv3.util.Strings
Counts how many times the substring appears in the larger string.
createMqttException(int) - Static method in class org.eclipse.paho.client.mqttv3.internal.ExceptionHelper
 
createMqttException(Throwable) - Static method in class org.eclipse.paho.client.mqttv3.internal.ExceptionHelper
 
createNetworkModules(String, MqttConnectOptions) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
Factory method to create an array of network modules, one for each of the supplied URIs
createSocketFactory(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Returns an SSL socket factory for the given configuration.
createWireMessage(MqttPersistable) - Static method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
createWireMessage(byte[]) - Static method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 

D

Debug - Class in org.eclipse.paho.client.mqttv3.util
Utility to help debug problems with the Paho MQTT client Once initialised a call to dumpClientDebug will force any memory trace together with pertinent client and system state to the main log facility.
Debug(String, ClientComms) - Constructor for class org.eclipse.paho.client.mqttv3.util.Debug
Set the debug facility up for a specific client
decode(String) - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SimpleBase64Encoder
 
decodeUTF8(DataInputStream) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Decodes a UTF-8 string from the DataInputStream provided.
DEFAULT_PROTOCOL - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
DELETE_OLDEST_MESSAGES_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
deleteBufferedMessage(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
deleteBufferedMessage(int) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
deleteMessage(int) - Method in class org.eclipse.paho.client.mqttv3.internal.DisconnectedMessageBuffer
Removes a message from the buffer
deliverMessage(String, int, MqttMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
deliveryComplete(MqttPublish) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
deliveryComplete(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
deliveryComplete(MqttPublish) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
deliveryComplete(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
deliveryComplete(IMqttDeliveryToken) - Method in interface org.eclipse.paho.client.mqttv3.MqttCallback
Called when delivery for a message has been completed, and all acknowledgments have been received.
deObfuscate(String) - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
The inverse operation of obfuscate: returns a cleartext password that was previously obfuscated using the XOR scrambler.
DestinationProvider - Interface in org.eclipse.paho.client.mqttv3.internal
This interface exists to act as a common type for MqttClient and MqttMIDPClient so they can be passed to ClientComms without either client class need to know about the other.
disconnect() - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Disconnects from the server.
disconnect(long) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Disconnects from the server.
disconnect(Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Disconnects from the server.
disconnect(long, Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Disconnects from the server.
disconnect() - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Disconnects from the server.
disconnect(long) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Disconnects from the server.
disconnect(MqttDisconnect, long, MqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
disconnect(Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
disconnect() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
disconnect(long) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
disconnect(long, Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
disconnect() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
disconnect(long) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
disconnected(MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Called when the client has been disconnected from the broker.
DISCONNECTED_BUFFER_ENABLED_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
DISCONNECTED_BUFFER_SIZE_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
The default size of the disconnected buffer
DisconnectedBufferOptions - Class in org.eclipse.paho.client.mqttv3
Holds the set of options that govern the behaviour of Offline (or Disconnected) buffering of messages
DisconnectedBufferOptions() - Constructor for class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
Constructs a new DisconnectedBufferOptions object using the default values.
DisconnectedMessageBuffer - Class in org.eclipse.paho.client.mqttv3.internal
 
DisconnectedMessageBuffer(DisconnectedBufferOptions) - Constructor for class org.eclipse.paho.client.mqttv3.internal.DisconnectedMessageBuffer
 
disconnectForcibly() - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Disconnects from the server forcibly to reset all the states.
disconnectForcibly(long) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Disconnects from the server forcibly to reset all the states.
disconnectForcibly(long, long) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Disconnects from the server forcibly to reset all the states.
disconnectForcibly() - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Disconnects from the server forcibly to reset all the states.
disconnectForcibly(long) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Disconnects from the server forcibly to reset all the states.
disconnectForcibly(long, long) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Disconnects from the server forcibly to reset all the states.
disconnectForcibly(long, long) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
Disconnect the connection and reset all the states.
disconnectForcibly() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
disconnectForcibly(long) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
disconnectForcibly(long, long) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
disconnectForcibly() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
disconnectForcibly(long) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
disconnectForcibly(long, long) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
dumpBaseDebug() - Method in class org.eclipse.paho.client.mqttv3.util.Debug
Dump of JVM wide debug info.
dumpClientComms() - Method in class org.eclipse.paho.client.mqttv3.util.Debug
Dump interesting variables from ClientComms
dumpClientDebug() - Method in class org.eclipse.paho.client.mqttv3.util.Debug
Dump maximum debug info.
dumpClientState() - Method in class org.eclipse.paho.client.mqttv3.util.Debug
Dump interesting variables from ClientState
dumpConOptions() - Method in class org.eclipse.paho.client.mqttv3.util.Debug
Dump Connection options
dumpMemoryTrace() - Method in class org.eclipse.paho.client.mqttv3.util.Debug
If memory trace is being used a request is made to push it to the target handler.
dumpMemoryTrace47(Logger) - Static method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
dumpProperties(Properties, String) - Static method in class org.eclipse.paho.client.mqttv3.util.Debug
Return a set of properties as a formatted string
dumpSystemProperties() - Method in class org.eclipse.paho.client.mqttv3.util.Debug
Dump the current set of system.properties to a log record
dumpTrace() - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
dumpTrace() - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
 
dumpVersion() - Method in class org.eclipse.paho.client.mqttv3.util.Debug
Dump information that show the version of the MQTT client being used.
duplicate - Variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 

E

encode(byte[]) - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SimpleBase64Encoder
Encodes an array of byte into a string of printable ASCII characters using a base-64 encoding.
encode(String) - Static method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64
 
encodeBytes(byte[]) - Static method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64
 
encodeFrame() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
Encodes the this WebSocketFrame into a byte array.
encodeMBI(long) - Static method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
encodeMessageId() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
encodePayload(MqttMessage) - Static method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
encodeUTF8(DataOutputStream, String) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Encodes a String given into UTF-8, before writing this to the DataOutputStream the length of the encoded string is encoded into two bytes and then written to the DataOutputStream.
equalsAny(CharSequence, CharSequence[]) - Static method in class org.eclipse.paho.client.mqttv3.util.Strings
Checks if the CharSequence equals any character in the given set of characters.
ExceptionHelper - Class in org.eclipse.paho.client.mqttv3.internal
Utility class to help create exceptions of the correct type.
execute() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketHandshake
Executes a Websocket Handshake.

F

FileLock - Class in org.eclipse.paho.client.mqttv3.internal
 
FileLock(File, String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.FileLock
Creates an NIO FileLock on the specified file if on a suitable Java runtime.
fine(String, String, String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
fine(String, String, String, Object[]) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
fine(String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
FINE - Static variable in interface org.eclipse.paho.client.mqttv3.logging.Logger
FINE is a message level providing tracing information.
fine(String, String, String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Trace a message, specifying source class and method, if the logger is currently enabled for the given message level.
fine(String, String, String, Object[]) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Trace a message, specifying source class and method, with an array of object arguments, if the logger is currently enabled for the given message level.
fine(String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
 
finer(String, String, String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
finer(String, String, String, Object[]) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
finer(String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
FINER - Static variable in interface org.eclipse.paho.client.mqttv3.logging.Logger
FINER indicates a fairly detailed tracing message.
finer(String, String, String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Trace a message, specifying source class and method, if the logger is currently enabled for the given message level.
finer(String, String, String, Object[]) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Trace a message, specifying source class and method, with an array of object arguments, if the logger is currently enabled for the given message level.
finer(String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
 
finest(String, String, String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
finest(String, String, String, Object[]) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
finest(String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
FINEST - Static variable in interface org.eclipse.paho.client.mqttv3.logging.Logger
FINEST indicates a highly detailed tracing message.
finest(String, String, String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Trace a message, specifying source class and method, if the logger is currently enabled for the given message level.
finest(String, String, String, Object[]) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Trace a message, specifying source class and method, with an array of object arguments, if the logger is currently enabled for the given message level.
finest(String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
 
fireActionEvent(MqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
An action has completed - if a completion listener has been set on the token then invoke it with the outcome of the action.
flush() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttOutputStream
 
flushSpi() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
format(LogRecord) - Method in class org.eclipse.paho.client.mqttv3.logging.SimpleLogFormatter
Format the logrecord as a single line with well defined columns.
formatMessage(String, Object[]) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
formatMessage(String, Object[]) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Format a log message without causing it to be written to the log.
frameLengthOverhead - Static variable in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
 

G

generateClientId() - Static method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
Returns a randomly generated client identifier based on the the fixed prefix (paho) and the system time.
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.
generateMaskingKey() - Static method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
Generates a random masking key Nothing super secure, but enough for websockets.
get() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
This returns the next piece of work, ie message, for the CommsSender to send over the network.
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.persist.MemoryPersistence
 
get(String) - Method in class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
 
getActionCallback() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Return the async listener for this token.
getActionCallback() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getActionCallback() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
getActualInFlight() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
getBase64String() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
getBufferedMessage(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getBufferedMessage(int) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
getBufferedMessageCount() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getBufferedMessageCount() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
getBufferSize() - Method in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
getCause() - Method in exception org.eclipse.paho.client.mqttv3.MqttException
Returns the underlying cause of this exception, if available.
getCleanSession() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
getClient() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Returns the MQTT client that is responsible for processing the asynchronous action
getClient() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getClient() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getClient() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
getClientAuthentication(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Returns whether client authentication is required.
getClientId() - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Returns the client ID used by this client.
getClientId() - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Returns the client ID used by this client.
getClientId() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
getClientId() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
getClientState() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getConfiguration(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Returns the configuration of the SSLSocketFactoryFactory for a given configuration.
getConnectionTimeout() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Returns the connection timeout value.
getConOptions() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getCounter() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.CountingInputStream
Returns the number of bytes read since the last reset.
getCurrentServerURI() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
Returns the currently connected Server URI Implemented due to: https://bugs.eclipse.org/bugs/show_bug.cgi?id=481097 Where getServerURI only returns the URI that was provided in MqttAsyncClient's constructor, getCurrentServerURI returns the URI of the Server that the client is currently connected to.
getCurrentServerURI() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
Returns the currently connected Server URI Implemented due to: https://bugs.eclipse.org/bugs/show_bug.cgi?id=481097 Where getServerURI only returns the URI that was provided in MqttAsyncClient's constructor, getCurrentServerURI returns the URI of the Server that the client is currently connected to.
getDebug() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getDebug() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
getDebug() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
Return a debug object that can be used to help solve problems.
getDebug() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
Return a debug object that can be used to help solve problems.
getDebug() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 
getEnabledCiphers() - Method in class org.eclipse.paho.client.mqttv3.internal.SSLNetworkModule
Returns the enabled cipher suites.
getEnabledCipherSuites(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Returns an array with the enabled ciphers.
getEncodedLength() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MultiByteInteger
Returns the number of bytes read when decoding this MBI.
getException() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Returns an exception providing more detail if an operation failed.
getException() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getException() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
getGrantedQos() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Returns the granted QoS list from a suback
getGrantedQos() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getGrantedQos() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttSuback
 
getGrantedQos() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
getHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
getHeaderBytes() - Method in class org.eclipse.paho.client.mqttv3.internal.MqttPersistentData
 
getHeaderBytes() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPersistableWireMessage
 
getHeaderBytes() - Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable
Returns the header bytes in an array.
getHeaderLength() - Method in class org.eclipse.paho.client.mqttv3.internal.MqttPersistentData
 
getHeaderLength() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPersistableWireMessage
 
getHeaderLength() - Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable
Returns the length of the header.
getHeaderOffset() - Method in class org.eclipse.paho.client.mqttv3.internal.MqttPersistentData
 
getHeaderOffset() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPersistableWireMessage
 
getHeaderOffset() - Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable
Returns the offset of the header within the byte array returned by MqttPersistable.getHeaderBytes().
getId() - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
Returns the MQTT id of the message.
getInputStream() - Method in class org.eclipse.paho.client.mqttv3.internal.LocalNetworkModule
 
getInputStream() - Method in interface org.eclipse.paho.client.mqttv3.internal.NetworkModule
 
getInputStream() - Method in class org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule
 
getInputStream() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketNetworkModule
 
getInputStream() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketSecureNetworkModule
 
getJSSEProvider(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the JSSE provider of the indicated configuration
getKeepAlive() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getKeepAlive() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
getKeepAliveInterval() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Returns the "keep alive" interval.
getKey() - Method in class org.eclipse.paho.client.mqttv3.internal.MqttPersistentData
 
getKey() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getKey() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnack
 
getKey() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
 
getKey() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttDisconnect
 
getKey() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingReq
 
getKey() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingResp
 
getKey() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Returns a key associated with the message.
getKeyManager(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the key manager algorithm that is used.
getKeyStore(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the name of the keystore file that is used.
getKeyStorePassword(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the plain-text password that is used for the keystore.
getKeyStoreProvider(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the keystore provider.
getKeyStoreType(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the type of keystore.
getLocalizedMessage(int) - Method in class org.eclipse.paho.client.mqttv3.internal.MessageCatalog
 
getLocalizedMessage(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ResourceBundleCatalog
 
getLogger(String, String) - Static method in class org.eclipse.paho.client.mqttv3.logging.LoggerFactory
Find or create a logger for a named package/class.
getLoggingProperty(String) - Static method in class org.eclipse.paho.client.mqttv3.logging.LoggerFactory
When run in JSR47, this allows access to the properties in the logging.properties file.
getMaxInFlight() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
getMaxInflight() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Returns the "max inflight".
getMessage() - Method in class org.eclipse.paho.client.mqttv3.BufferedMessage
 
getMessage() - Method in interface org.eclipse.paho.client.mqttv3.IMqttDeliveryToken
Returns the message associated with this token.
getMessage(int) - Method in class org.eclipse.paho.client.mqttv3.internal.DisconnectedMessageBuffer
Retrieves a message from the buffer at the given index.
getMessage(int) - Static method in class org.eclipse.paho.client.mqttv3.internal.MessageCatalog
 
getMessage() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getMessage() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
getMessage() - Method in class org.eclipse.paho.client.mqttv3.MqttDeliveryToken
Returns the message associated with this token.
getMessage() - Method in exception org.eclipse.paho.client.mqttv3.MqttException
Returns the detail message for this exception.
getMessageCount() - Method in class org.eclipse.paho.client.mqttv3.internal.DisconnectedMessageBuffer
Returns the number of messages currently in the buffer
getMessageId() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Returns the message ID of the message that is associated with the token.
getMessageID() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getMessageId() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttReceivedMessage
 
getMessageId() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Returns the MQTT message ID.
getMessageId() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttAck
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttDisconnect
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingReq
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubRel
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttSubscribe
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubscribe
 
getMessageInfo() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Sub-classes should override this to encode the message info.
getMqttVersion() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Returns the MQTT version.
getName() - Method in class org.eclipse.paho.client.mqttv3.MqttTopic
Returns the name of the queue or topic.
getNetworkModuleIndex() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getNetworkModules() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getOpcode() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
 
getOutputStream() - Method in class org.eclipse.paho.client.mqttv3.internal.LocalNetworkModule
 
getOutputStream() - Method in interface org.eclipse.paho.client.mqttv3.internal.NetworkModule
 
getOutputStream() - Method in class org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule
 
getOutputStream() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketNetworkModule
 
getOutputStream() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketSecureNetworkModule
 
getOutstandingDelTokens() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
getOutstandingTokens() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
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.internal.websocket.WebSocketFrame
 
getPayload() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
 
getPayload() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
getPayload() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttSubscribe
 
getPayload() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubscribe
 
getPayload() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Sub-classes should override this method to supply the payload bytes.
getPayload() - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
Returns the payload as a byte array.
getPayloadBytes() - Method in class org.eclipse.paho.client.mqttv3.internal.MqttPersistentData
 
getPayloadBytes() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPersistableWireMessage
 
getPayloadBytes() - Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable
Returns the payload bytes in an array.
getPayloadLength() - Method in class org.eclipse.paho.client.mqttv3.internal.MqttPersistentData
 
getPayloadLength() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPersistableWireMessage
 
getPayloadLength() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
getPayloadLength() - Method in interface org.eclipse.paho.client.mqttv3.MqttPersistable
Returns the length of the payload.
getPayloadOffset() - Method in class org.eclipse.paho.client.mqttv3.internal.MqttPersistentData
 
getPayloadOffset() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPersistableWireMessage
 
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 interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Returns the delivery tokens for any outstanding publish operations.
getPendingDeliveryTokens() - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Returns the delivery tokens for any outstanding publish operations.
getPendingDeliveryTokens() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getPendingDeliveryTokens() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
getPendingDeliveryTokens() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
getQos() - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
Returns the quality of service for this message.
getReasonCode() - Method in exception org.eclipse.paho.client.mqttv3.MqttException
Returns the reason code for this exception.
getResponse() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Returns the response wire message
getResponse() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getResponse() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
getReturnCode() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnack
 
getServerURI() - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Returns the address of the server used by this client.
getServerURI() - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Returns the address of the server used by this client, as a URI.
getServerURI() - Method in class org.eclipse.paho.client.mqttv3.internal.LocalNetworkModule
 
getServerURI() - Method in interface org.eclipse.paho.client.mqttv3.internal.NetworkModule
 
getServerURI() - Method in class org.eclipse.paho.client.mqttv3.internal.SSLNetworkModule
 
getServerURI() - Method in class org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule
 
getServerURI() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketNetworkModule
 
getServerURI() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketSecureNetworkModule
 
getServerURI() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
getServerURI() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
getServerURIs() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Return a list of serverURIs the client may connect to
getSessionPresent() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Returns the session present flag from a connack
getSessionPresent() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getSessionPresent() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnack
 
getSessionPresent() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
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.
getSpi(String) - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
getSSLProperties() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Returns the SSL properties for the connection.
getSSLProtocol(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the SSL protocol variant of the indicated configuration or the default configuration.
getThread() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
Returns the thread used by this callback.
getTimeToWait() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
Return the maximum time to wait for an action to complete.
getToken() - Method in class org.eclipse.paho.client.mqttv3.BufferedMessage
 
getToken(MqttWireMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
Based on the message type that has just been received return the associated token from the token store or null if one does not exist.
getToken(String) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
getTopic(String) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Get a topic object which can be used to publish messages.
getTopic(String) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
getTopic(String) - Method in interface org.eclipse.paho.client.mqttv3.internal.DestinationProvider
 
getTopic(String) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
Get a topic object which can be used to publish messages.
getTopic(String) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
getTopicName() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
getTopics() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Returns the topic string(s) for the action being tracked by this token.
getTopics() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getTopics() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
getTrustManager(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the trust manager algorithm that is used.
getTrustStore(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the name of the truststore file that is used.
getTrustStorePassword(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the plain-text password that is used for the truststore.
getTrustStoreProvider(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the truststore provider.
getTrustStoreType(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Gets the type of truststore.
getType() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Returns the type of the message.
getUserContext() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Retrieve the context associated with an action.
getUserContext() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
getUserContext() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
getUserName() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Returns the user name to use for the connection.
getValue() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MultiByteInteger
Returns the value of this MBI.
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnack
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttDisconnect
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingReq
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingResp
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubAck
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubComp
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubRec
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubRel
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttSuback
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttSubscribe
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubAck
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubscribe
 
getVariableHeader() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
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).
getWireMessage() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 

H

HandshakeFailedException - Exception in org.eclipse.paho.client.mqttv3.internal.websocket
 
HandshakeFailedException() - Constructor for exception org.eclipse.paho.client.mqttv3.internal.websocket.HandshakeFailedException
 

I

IDisconnectedBufferCallback - Interface in org.eclipse.paho.client.mqttv3.internal
 
IMqttActionListener - Interface in org.eclipse.paho.client.mqttv3
Implementors of this interface will be notified when an asynchronous action completes.
IMqttAsyncClient - Interface in org.eclipse.paho.client.mqttv3
Enables an application to communicate with an MQTT server using non-blocking methods.
IMqttClient - Interface in org.eclipse.paho.client.mqttv3
Enables an application to communicate with an MQTT server using using blocking methods.
IMqttDeliveryToken - Interface in org.eclipse.paho.client.mqttv3
Provides a mechanism for tracking the delivery of a message.
IMqttMessageListener - Interface in org.eclipse.paho.client.mqttv3
Implementers of this interface will be notified when a message arrives.
IMqttToken - Interface in org.eclipse.paho.client.mqttv3
Provides a mechanism for tracking the completion of an asynchronous task.
info(String, String, String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
info(String, String, String, Object[]) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
info(String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
INFO - Static variable in interface org.eclipse.paho.client.mqttv3.logging.Logger
INFO is a message level for informational messages.
info(String, String, String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, if the logger is currently enabled for the given message level.
info(String, String, String, Object[]) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments, if the logger is currently enabled for the given message level.
info(String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments and a throwable, if the logger is currently enabled for the given message level.
init(ClientComms) - Method in interface org.eclipse.paho.client.mqttv3.MqttPingSender
Initial method.
init(ClientComms) - Method in class org.eclipse.paho.client.mqttv3.ScheduledExecutorPingSender
 
init(ClientComms) - Method in class org.eclipse.paho.client.mqttv3.TimerPingSender
 
initialise(ResourceBundle, String, String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
initialise(ResourceBundle, String, String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
 
initialize(Properties, String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Initializes the SSLSocketFactoryFactory with the provided properties for the provided configuration.
internalTok - Variable in class org.eclipse.paho.client.mqttv3.MqttToken
A reference to the the class that provides most of the implementation of the MqttToken.
isAutomaticReconnect() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Returns whether the client will automatically attempt to reconnect to the server if the connection is lost
isBufferEnabled() - Method in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
isClassAvailable(String) - Static method in class org.eclipse.paho.client.mqttv3.internal.ExceptionHelper
Returns whether or not the specified class is available to the current class loader.
isCleanSession() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
 
isCleanSession() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Returns whether the client and server should remember state for the client across reconnects.
isClosed() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
isCloseFlag() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
 
isComplete() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Returns whether or not the action has finished.
isComplete() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
isComplete() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
isCompletePending() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
isConnected() - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Determines if this client is currently connected to the server.
isConnected() - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Determines if this client is currently connected to the server.
isConnected() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
isConnected() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
isConnected() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
isConnecting() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
isDeleteOldestMessages() - Method in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
isDisconnected() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
isDisconnecting() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
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.
isEmpty(CharSequence) - Static method in class org.eclipse.paho.client.mqttv3.util.Strings
Checks if a CharSequence is empty ("") or null.
isFin() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
 
isInUse() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
isLoggable(int) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
isLoggable(int) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Check if a message of the given level would actually be logged by this logger.
isMatched(String, String) - Static method in class org.eclipse.paho.client.mqttv3.MqttTopic
Check the supplied topic name and filter match
isMessageIdRequired() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnack
Returns whether or not this message needs to include a message ID.
isMessageIdRequired() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
Returns whether or not this message needs to include a message ID.
isMessageIdRequired() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttDisconnect
Returns whether or not this message needs to include a message ID.
isMessageIdRequired() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingReq
Returns false as message IDs are not required for MQTT PINGREQ messages.
isMessageIdRequired() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingResp
Returns whether or not this message needs to include a message ID.
isMessageIdRequired() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
isMessageIdRequired() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Returns whether or not this message needs to include a message ID.
isNotified() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
isPersistBuffer() - Method in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
isQuiesced() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
isReceiving() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsReceiver
Returns the receiving state.
isReceiving() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketReceiver
Returns the receiving state.
isResting() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
isRetained() - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
Returns whether or not this message should be/was retained by the server.
isRetryable() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttSubscribe
 
isRetryable() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubscribe
 
isRetryable() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
isRunning() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsReceiver
 
isRunning() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketReceiver
 
isSupportedOnJVM() - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Not all of the JVM/Platforms support all of its security features.

J

JSR47Logger - Class in org.eclipse.paho.client.mqttv3.logging
Implementation of the the logger interface that uses java.uti.logging A Logger that utilises Java's built in logging facility - java.util.logging.
JSR47Logger() - Constructor for class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
JSSEPROVIDER - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 

K

KEEP_ALIVE_INTERVAL_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
The default keep alive interval in seconds if one is not specified
KEY - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnack
 
KEY - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
 
KEY - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttDisconnect
 
KEY - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingReq
 
KEY - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingResp
 
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.persist.MemoryPersistence
 
keys() - Method in class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
Returns all of the persistent data from the previously specified persistence directory.
keysSpi() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
KEYSTORE - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
KEYSTOREMGR - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
KEYSTOREPROVIDER - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
KEYSTOREPWD - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
KEYSTORETYPE - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 

L

left(String, int, char) - Static method in class org.eclipse.paho.client.mqttv3.logging.SimpleLogFormatter
Left justify a string.
left(String, int, char) - Static method in class org.eclipse.paho.client.mqttv3.util.Debug
Left justify a string.
LocalNetworkModule - Class in org.eclipse.paho.client.mqttv3.internal
Special comms class that allows an MQTT client to use a non TCP / optimised mechanism to talk to an MQTT server when running in the same JRE instance as the MQTT server.
LocalNetworkModule(String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.LocalNetworkModule
 
log(int, String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
log(int, String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments and a throwable, if the logger is currently enabled for the given message level.
Logger - Interface in org.eclipse.paho.client.mqttv3.logging
A Logger object is used to send log and trace messages to a platform specific logging implementation.
LoggerFactory - Class in org.eclipse.paho.client.mqttv3.logging
A factory that returns a logger for use by the MQTT client.
LoggerFactory() - Constructor for class org.eclipse.paho.client.mqttv3.logging.LoggerFactory
 

M

markComplete(MqttWireMessage, MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
Mark the token as complete and ready for users to be notified.
MAX_INFLIGHT_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
The default max inflight if one is not specified
MAX_MSG_SIZE - Static variable in class org.eclipse.paho.client.mqttv3.internal.ClientDefaults
 
MemoryPersistence - Class in org.eclipse.paho.client.mqttv3.persist
Persistence that uses memory In cases where reliability is not required across client or device restarts memory this memory peristence can be used.
MemoryPersistence() - Constructor for class org.eclipse.paho.client.mqttv3.persist.MemoryPersistence
 
merge(Properties, String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Merges the given IBM SSL properties into the existing configuration, overwriting existing properties.
message - Variable in class org.eclipse.paho.client.mqttv3.internal.Token
 
MESSAGE_TYPE_CONNACK - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_CONNECT - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_DISCONNECT - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_PINGREQ - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_PINGRESP - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_PUBACK - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_PUBCOMP - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_PUBLISH - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_PUBREC - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_PUBREL - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_SUBACK - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_SUBSCRIBE - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_UNSUBACK - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MESSAGE_TYPE_UNSUBSCRIBE - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
messageArrived(String, MqttMessage) - Method in interface org.eclipse.paho.client.mqttv3.IMqttMessageListener
This method is called when a message arrives from the server.
messageArrived(MqttPublish) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
This method is called when a message arrives on a topic.
messageArrived(String, MqttMessage) - Method in interface org.eclipse.paho.client.mqttv3.MqttCallback
This method is called when a message arrives from the server.
messageArrivedComplete(int, int) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Indicate that the application has completed processing the message with id messageId.
messageArrivedComplete(int, int) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Indicate that the application has completed processing the message with id messageId.
messageArrivedComplete(int, int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
messageArrivedComplete(int, int) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
messageArrivedComplete(int, int) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
messageArrivedComplete(int, int) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
MessageCatalog - Class in org.eclipse.paho.client.mqttv3.internal
Catalog of human readable error messages.
MessageCatalog() - Constructor for class org.eclipse.paho.client.mqttv3.internal.MessageCatalog
 
MQTT_CLIENT_MSG_CAT - Static variable in class org.eclipse.paho.client.mqttv3.logging.LoggerFactory
Default message catalog.
MQTT_VERSION_3_1 - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 
MQTT_VERSION_3_1_1 - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 
MQTT_VERSION_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
The default MqttVersion is 3.1.1 first, dropping back to 3.1 if that fails
MqttAck - Class in org.eclipse.paho.client.mqttv3.internal.wire
Abstract super-class of all acknowledgement messages.
MqttAck(byte) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttAck
 
MqttAsyncClient - Class in org.eclipse.paho.client.mqttv3
Lightweight client for talking to an MQTT server using non-blocking methods that allow an operation to run in the background.
MqttAsyncClient(String, String) - Constructor for class org.eclipse.paho.client.mqttv3.MqttAsyncClient
Create an MqttAsyncClient that is used to communicate with an MQTT server.
MqttAsyncClient(String, String, MqttClientPersistence) - Constructor for class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
MqttAsyncClient(String, String, MqttClientPersistence, MqttPingSender) - Constructor for class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
MqttAsyncClient(String, String, MqttClientPersistence, MqttPingSender, ScheduledExecutorService) - Constructor for class org.eclipse.paho.client.mqttv3.MqttAsyncClient
Create an MqttAsyncClient that is used to communicate with an MQTT server.
MqttCallback - Interface in org.eclipse.paho.client.mqttv3
Enables an application to be notified when asynchronous events related to the client occur.
MqttCallbackExtended - Interface in org.eclipse.paho.client.mqttv3
Extension of MqttCallback to allow new callbacks without breaking the API for existing applications.
MqttClient - Class in org.eclipse.paho.client.mqttv3
Lightweight client for talking to an MQTT server using methods that block until an operation completes.
MqttClient(String, String) - Constructor for class org.eclipse.paho.client.mqttv3.MqttClient
Create an MqttClient that can be used to communicate with an MQTT server.
MqttClient(String, String, MqttClientPersistence) - Constructor for class org.eclipse.paho.client.mqttv3.MqttClient
Create an MqttClient that can be used to communicate with an MQTT server.
MqttClient(String, String, MqttClientPersistence, ScheduledExecutorService) - Constructor for class org.eclipse.paho.client.mqttv3.MqttClient
Create an MqttClient that can be used to communicate with an MQTT server.
MqttClientPersistence - Interface in org.eclipse.paho.client.mqttv3
Represents a persistent data store, used to store outbound and inbound messages while they are in flight, enabling delivery to the QoS specified.
MqttConnack - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT CONNACK.
MqttConnack(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnack
 
MqttConnect - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT CONNECT message.
MqttConnect(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
Constructor for an on the wire MQTT connect message
MqttConnect(String, int, boolean, int, String, char[], MqttMessage, String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
 
MqttConnectOptions - Class in org.eclipse.paho.client.mqttv3
Holds the set of options that control how the client connects to a server.
MqttConnectOptions() - Constructor for class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Constructs a new MqttConnectOptions object using the default values.
MqttDefaultFilePersistence - Class in org.eclipse.paho.client.mqttv3.persist
An implementation of the MqttClientPersistence interface that provides file based persistence.
MqttDefaultFilePersistence() - Constructor for class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
 
MqttDefaultFilePersistence(String) - Constructor for class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
Create an file-based persistent data store within the specified directory.
MqttDeliveryToken - Class in org.eclipse.paho.client.mqttv3
Provides a mechanism to track the delivery progress of a message.
MqttDeliveryToken() - Constructor for class org.eclipse.paho.client.mqttv3.MqttDeliveryToken
 
MqttDeliveryToken(String) - Constructor for class org.eclipse.paho.client.mqttv3.MqttDeliveryToken
 
MqttDisconnect - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT DISCONNECT message.
MqttDisconnect() - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttDisconnect
 
MqttDisconnect(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttDisconnect
 
MqttException - Exception in org.eclipse.paho.client.mqttv3
Thrown if an error occurs communicating with the server.
MqttException(int) - Constructor for exception org.eclipse.paho.client.mqttv3.MqttException
Constructs a new MqttException with the specified code as the underlying reason.
MqttException(Throwable) - Constructor for exception org.eclipse.paho.client.mqttv3.MqttException
Constructs a new MqttException with the specified Throwable as the underlying reason.
MqttException(int, Throwable) - Constructor for exception org.eclipse.paho.client.mqttv3.MqttException
Constructs a new MqttException with the specified Throwable as the underlying reason.
MqttInputStream - Class in org.eclipse.paho.client.mqttv3.internal.wire
An MqttInputStream lets applications read instances of MqttWireMessage.
MqttInputStream(ClientState, InputStream) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttInputStream
 
MqttMessage - Class in org.eclipse.paho.client.mqttv3
An MQTT message holds the application payload and options specifying how the message is to be delivered The message includes a "payload" (the body of the message) represented as a byte[].
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.
MqttOutputStream - Class in org.eclipse.paho.client.mqttv3.internal.wire
An MqttOutputStream lets applications write instances of MqttWireMessage.
MqttOutputStream(ClientState, OutputStream) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttOutputStream
 
MqttPersistable - Interface in org.eclipse.paho.client.mqttv3
Represents an object used to pass data to be persisted across the MqttClientPersistence interface.
MqttPersistableWireMessage - Class in org.eclipse.paho.client.mqttv3.internal.wire
 
MqttPersistableWireMessage(byte) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPersistableWireMessage
 
MqttPersistenceException - Exception in org.eclipse.paho.client.mqttv3
This exception is thrown by the implementor of the persistence interface if there is a problem reading or writing persistent data.
MqttPersistenceException() - Constructor for exception org.eclipse.paho.client.mqttv3.MqttPersistenceException
Constructs a new MqttPersistenceException
MqttPersistenceException(int) - Constructor for exception org.eclipse.paho.client.mqttv3.MqttPersistenceException
Constructs a new MqttPersistenceException with the specified code as the underlying reason.
MqttPersistenceException(Throwable) - Constructor for exception org.eclipse.paho.client.mqttv3.MqttPersistenceException
Constructs a new MqttPersistenceException with the specified Throwable as the underlying reason.
MqttPersistenceException(int, Throwable) - Constructor for exception org.eclipse.paho.client.mqttv3.MqttPersistenceException
Constructs a new MqttPersistenceException with the specified Throwable as the underlying reason.
MqttPersistentData - Class in org.eclipse.paho.client.mqttv3.internal
 
MqttPersistentData(String, byte[], int, int, byte[], int, int) - Constructor for class org.eclipse.paho.client.mqttv3.internal.MqttPersistentData
Construct a data object to pass across the MQTT client persistence interface.
MqttPingReq - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT PINGREQ message.
MqttPingReq() - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingReq
 
MqttPingReq(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingReq
 
MqttPingResp - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT PINGRESP.
MqttPingResp(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPingResp
 
MqttPingSender - Interface in org.eclipse.paho.client.mqttv3
Represents an object used to send ping packet to MQTT broker every keep alive interval.
MqttPubAck - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT PUBACK message.
MqttPubAck(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubAck
 
MqttPubAck(MqttPublish) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubAck
 
MqttPubAck(int) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubAck
 
MqttPubComp - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT PUBCOMP message.
MqttPubComp(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubComp
 
MqttPubComp(MqttPublish) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubComp
 
MqttPubComp(int) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubComp
 
MqttPublish - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT SEND message.
MqttPublish(String, MqttMessage) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
MqttPublish(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
Constructs a new MqttPublish object.
MqttPubRec - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT PUBREC message.
MqttPubRec(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubRec
 
MqttPubRec(MqttPublish) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubRec
 
MqttPubRel - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT PUBREL message.
MqttPubRel(MqttPubRec) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubRel
Createa a pubrel message based on a pubrec
MqttPubRel(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubRel
Creates a pubrel based on a pubrel set of bytes read fro the network
MqttReceivedMessage - Class in org.eclipse.paho.client.mqttv3.internal.wire
 
MqttReceivedMessage() - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttReceivedMessage
 
MqttSecurityException - Exception in org.eclipse.paho.client.mqttv3
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 exception org.eclipse.paho.client.mqttv3.MqttSecurityException
Constructs a new MqttSecurityException with the specified code as the underlying reason.
MqttSecurityException(Throwable) - Constructor for exception org.eclipse.paho.client.mqttv3.MqttSecurityException
Constructs a new MqttSecurityException with the specified Throwable as the underlying reason.
MqttSecurityException(int, Throwable) - Constructor for exception org.eclipse.paho.client.mqttv3.MqttSecurityException
Constructs a new MqttSecurityException with the specified code and Throwable as the underlying reason.
MqttSuback - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT SUBACK.
MqttSuback(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttSuback
 
MqttSubscribe - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT SUBSCRIBE message.
MqttSubscribe(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttSubscribe
Constructor for an on the wire MQTT subscribe message
MqttSubscribe(String[], int[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttSubscribe
Constructor for an on the wire MQTT subscribe message
MqttToken - Class in org.eclipse.paho.client.mqttv3
Provides a mechanism for tracking the completion of an asynchronous action.
MqttToken() - Constructor for class org.eclipse.paho.client.mqttv3.MqttToken
 
MqttToken(String) - Constructor for class org.eclipse.paho.client.mqttv3.MqttToken
 
MqttTopic - Class in org.eclipse.paho.client.mqttv3
Represents a topic destination, used for publish/subscribe messaging.
MqttTopic(String, ClientComms) - Constructor for class org.eclipse.paho.client.mqttv3.MqttTopic
 
MqttUnsubAck - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT UNSUBACK.
MqttUnsubAck(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubAck
 
MqttUnsubscribe - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT UNSUBSCRIBE message.
MqttUnsubscribe(String[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubscribe
Constructs an MqttUnsubscribe
MqttUnsubscribe(byte, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubscribe
Constructor for an on the wire MQTT un-subscribe message
MqttWireMessage - Class in org.eclipse.paho.client.mqttv3.internal.wire
An on-the-wire representation of an MQTT message.
MqttWireMessage(byte) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
msgId - Variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
MULTI_LEVEL_WILDCARD - Static variable in class org.eclipse.paho.client.mqttv3.MqttTopic
Multi-level wildcard The number sign (#) is a wildcard character that matches any number of levels within a topic.
MULTI_LEVEL_WILDCARD_PATTERN - Static variable in class org.eclipse.paho.client.mqttv3.MqttTopic
Multi-level wildcard pattern(/#)
MultiByteArrayInputStream - Class in org.eclipse.paho.client.mqttv3.internal.wire
 
MultiByteArrayInputStream(byte[], int, int, byte[], int, int) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MultiByteArrayInputStream
 
MultiByteInteger - Class in org.eclipse.paho.client.mqttv3.internal.wire
Represents a Multi-Byte Integer (MBI), as defined by the MQTT V3 specification.
MultiByteInteger(long) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MultiByteInteger
 
MultiByteInteger(long, int) - Constructor for class org.eclipse.paho.client.mqttv3.internal.wire.MultiByteInteger
 

N

NetworkModule - Interface in org.eclipse.paho.client.mqttv3.internal
 
notifyComplete(MqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Called when waiters and callbacks have processed the message.
notifyComplete() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
Notifies this token that a response message (an ACK or NACK) has been received.
notifyQueueLock() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
notifyReceivedAck(MqttAck) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Called by the CommsReceiver when an ack has arrived.
notifyReceivedBytes(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
notifyReceivedMsg(MqttWireMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Called by the CommsReceiver when a message has been received.
notifyReconnect() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
When the client automatically reconnects, we want to send all messages from the buffer first before allowing the user to send any messages
notifyResult(MqttWireMessage, MqttToken, MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
notifySent(MqttWireMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Called by the CommsSender when a message has been sent
notifySent() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
Notifies this token that the associated message has been sent (i.e.
notifySentBytes(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
COMMENTED OUT AS NO LONGER USED.

O

obfuscate(char[]) - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Obfuscates the password using a simple and not very secure XOR mechanism.
onFailure(IMqttToken, Throwable) - Method in interface org.eclipse.paho.client.mqttv3.IMqttActionListener
This method is invoked when an action fails.
onFailure(IMqttToken, Throwable) - Method in class org.eclipse.paho.client.mqttv3.internal.ConnectActionListener
The connect failed, so try the next URI on the list.
onSuccess(IMqttToken) - Method in interface org.eclipse.paho.client.mqttv3.IMqttActionListener
This method is invoked when an action has completed successfully.
onSuccess(IMqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.ConnectActionListener
If the connect succeeded then call the users onSuccess callback
open() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
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.persist.MemoryPersistence
 
open(String, String) - Method in class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
 
org.eclipse.paho.client.mqttv3 - package org.eclipse.paho.client.mqttv3
Contains a programming interface enabling applications to communicate with an MQTT server.
org.eclipse.paho.client.mqttv3.internal - package org.eclipse.paho.client.mqttv3.internal
 
org.eclipse.paho.client.mqttv3.internal.security - package org.eclipse.paho.client.mqttv3.internal.security
 
org.eclipse.paho.client.mqttv3.internal.websocket - package org.eclipse.paho.client.mqttv3.internal.websocket
 
org.eclipse.paho.client.mqttv3.internal.wire - package org.eclipse.paho.client.mqttv3.internal.wire
 
org.eclipse.paho.client.mqttv3.logging - package org.eclipse.paho.client.mqttv3.logging
Provides facilities to write and format log and trace to help debug problems.
org.eclipse.paho.client.mqttv3.persist - package org.eclipse.paho.client.mqttv3.persist
Contains implementations of the MqttClientPersistence interface.
org.eclipse.paho.client.mqttv3.util - package org.eclipse.paho.client.mqttv3.util
Provides helpers and utilities.

P

packCipherSuites(String[]) - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Converts an array of ciphers into a single String.
PERSIST_DISCONNECTED_BUFFER_DEFAULT - Static variable in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
persistBufferedMessage(MqttWireMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Persists a buffered message to the persistence layer
publish(String, byte[], int, boolean) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Publishes a message to a topic on the server.
publish(String, byte[], int, boolean, Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Publishes a message to a topic on the server.
publish(String, MqttMessage) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Publishes a message to a topic on the server.
publish(String, MqttMessage, Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Publishes a message to a topic on the server.
publish(String, byte[], int, boolean) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Publishes a message to a topic on the server and return once it is delivered.
publish(String, MqttMessage) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Publishes a message to a topic on the server.
publish(String, byte[], int, boolean, Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
publish(String, byte[], int, boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
publish(String, MqttMessage) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
publish(String, MqttMessage, Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
publish(String, byte[], int, boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
publish(String, MqttMessage) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
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 does not wait for delivery of the message to complete.
publishBufferedMessage(BufferedMessage) - Method in interface org.eclipse.paho.client.mqttv3.internal.IDisconnectedBufferCallback
 
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.persist.MemoryPersistence
 
put(String, MqttPersistable) - Method in class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
Writes the specified persistent data to the previously specified persistence directory.
putMessage(MqttWireMessage, MqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.DisconnectedMessageBuffer
This will add a new message to the offline buffer, if the buffer is full and deleteOldestMessages is enabled then the 0th item in the buffer will be deleted and the new message will be added.
putSpi(String, String) - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 

Q

quiesce(long) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Quiesce the client state, preventing any new messages getting sent, and preventing the callback on any newly received messages.
quiesce() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
Let the call back thread quiesce.
quiesce(MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 

R

read() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.CountingInputStream
 
read() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttInputStream
 
read() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MultiByteArrayInputStream
 
readMBI(DataInputStream) - Static method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Decodes an MQTT Multi-Byte Integer from the given stream.
readMqttWireMessage() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttInputStream
Reads an MqttWireMessage from the stream.
REASON_CODE_BROKER_UNAVAILABLE - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
The broker was not available to handle the request.
REASON_CODE_CLIENT_ALREADY_DISCONNECTED - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
The client is already disconnected.
REASON_CODE_CLIENT_CLOSED - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
The client is closed - no operations are permitted on the client in this state.
REASON_CODE_CLIENT_CONNECTED - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
The client is already connected.
REASON_CODE_CLIENT_DISCONNECT_PROHIBITED - Static variable in exception 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_DISCONNECTING - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
The client is currently disconnecting and cannot accept any new work.
REASON_CODE_CLIENT_EXCEPTION - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
Client encountered an exception.
REASON_CODE_CLIENT_NOT_CONNECTED - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
The client is not connected to the server.
REASON_CODE_CLIENT_TIMEOUT - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
Client timed out while waiting for a response from the server.
REASON_CODE_CONNECT_IN_PROGRESS - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
A connect operation in already in progress, only one connect can happen at a time.
REASON_CODE_CONNECTION_LOST - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
The client has been unexpectedly disconnected from the server.
REASON_CODE_DISCONNECTED_BUFFER_FULL - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
The Client has attempted to publish a message whilst in the 'resting' / offline state with Disconnected Publishing enabled, however the buffer is full and deleteOldestMessages is disabled, therefore no more messages can be published until the client reconnects, or the application deletes buffered message manually.
REASON_CODE_FAILED_AUTHENTICATION - Static variable in exception 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 exception org.eclipse.paho.client.mqttv3.MqttException
The server has rejected the supplied client ID
REASON_CODE_INVALID_MESSAGE - Static variable in exception 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 exception org.eclipse.paho.client.mqttv3.MqttException
The protocol version requested is not supported by the server.
REASON_CODE_MAX_INFLIGHT - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
A request has been made to send a message but the maximum number of inflight messages has already been reached.
REASON_CODE_NO_MESSAGE_IDS_AVAILABLE - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
Internal error, caused by no new message IDs being available.
REASON_CODE_NOT_AUTHORIZED - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
Not authorized to perform the requested operation
REASON_CODE_PERSISTENCE_IN_USE - Static variable in exception org.eclipse.paho.client.mqttv3.MqttPersistenceException
Persistence is already being used by another client.
REASON_CODE_SERVER_CONNECT_ERROR - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
Unable to connect to server
REASON_CODE_SOCKET_FACTORY_MISMATCH - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
Server URI and supplied SocketFactory do not match.
REASON_CODE_SSL_CONFIG_ERROR - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
SSL configuration error.
REASON_CODE_SUBSCRIBE_FAILED - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
Error from subscribe - returned from the server.
REASON_CODE_TOKEN_INUSE - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
A request has been made to use a token that is already associated with another action.
REASON_CODE_UNEXPECTED_ERROR - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
An unexpected error has occurred.
REASON_CODE_WRITE_TIMEOUT - Static variable in exception org.eclipse.paho.client.mqttv3.MqttException
Client timed out while waiting to write messages to the server.
reconnect() - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
User triggered attempt to reconnect
reconnect() - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
release() - Method in class org.eclipse.paho.client.mqttv3.internal.FileLock
Releases the lock.
remove(String) - Method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Remove the configuration of a given configuration identifier.
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.persist.MemoryPersistence
 
remove(String) - Method in class org.eclipse.paho.client.mqttv3.persist.MqttDefaultFilePersistence
Deletes the data with the specified key from the previously specified persistence directory.
removeMessageListener(String) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
removeMessageListener(String) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
removeMessageListeners() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
removeNodeSpi() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
removeSpi(String) - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
removeToken(MqttWireMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
removeToken(String) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
reset() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
resetCounter() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.CountingInputStream
Resets the counter to zero.
resolveOldTokens(MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Called during shutdown to work out if there are any tokens still to be notified and waiters to be unblocked.
ResourceBundleCatalog - Class in org.eclipse.paho.client.mqttv3.internal
 
ResourceBundleCatalog() - Constructor for class org.eclipse.paho.client.mqttv3.internal.ResourceBundleCatalog
 
restoreState() - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Restores the state information from persistence.
restoreToken(MqttPublish) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
Restores a token after a client restart.
run() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
run() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsReceiver
Run loop to receive messages from the server.
run() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsSender
 
run() - Method in class org.eclipse.paho.client.mqttv3.internal.DisconnectedMessageBuffer
Flushes the buffer of messages into an open connection
run() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketReceiver
 
running - Variable in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 

S

saveToken(MqttToken, MqttWireMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
saveToken(MqttToken, String) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
schedule(long) - Method in interface org.eclipse.paho.client.mqttv3.MqttPingSender
Schedule next ping in certain delay.
schedule(long) - Method in class org.eclipse.paho.client.mqttv3.ScheduledExecutorPingSender
 
schedule(long) - Method in class org.eclipse.paho.client.mqttv3.TimerPingSender
 
ScheduledExecutorPingSender - Class in org.eclipse.paho.client.mqttv3
Default ping sender implementation
ScheduledExecutorPingSender(ScheduledExecutorService) - Constructor for class org.eclipse.paho.client.mqttv3.ScheduledExecutorPingSender
 
send(MqttWireMessage, MqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
Submits a message for delivery.
sendNoWait(MqttWireMessage, MqttToken) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
Sends a message to the broker if in connected state, but only waits for the message to be stored, before returning.
setActionCallback(IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Register a listener to be notified when an action completes.
setActionCallback(IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
setActionCallback(IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
setAutomaticReconnect(boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets whether the client will automatically attempt to reconnect to the server if the connection is lost.
setBufferEnabled(boolean) - Method in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
setBufferOpts(DisconnectedBufferOptions) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
Sets the DisconnectedBufferOptions for this client
setBufferSize(int) - Method in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
setCallback(MqttCallback) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Sets a callback listener to use for events that happen asynchronously.
setCallback(MqttCallback) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Sets the callback listener to use for events that happen asynchronously.
setCallback(MqttCallback) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
setCallback(MqttCallback) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
setCallback(MqttCallback) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
setCallback(MqttCallback) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
setCleanSession(boolean) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
setCleanSession(boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets whether the client and server should remember state across restarts and reconnects.
setClient(IMqttAsyncClient) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
setClientState(ClientState) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
setConnectionTimeout(int) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets the connection timeout value.
setConnectTimeout(int) - Method in class org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule
Set the maximum time to wait for a socket to be established
setDeleteOldestMessages(boolean) - Method in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
setDisconnectedMessageBuffer(DisconnectedMessageBuffer) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
setDuplicate(boolean) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttReceivedMessage
 
setDuplicate(boolean) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
setDuplicate(boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
 
setEnabledCiphers(String[]) - Method in class org.eclipse.paho.client.mqttv3.internal.SSLNetworkModule
Sets the enabled cipher suites on the underlying network socket.
setException(MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
setId(int) - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
This is only to be used internally to provide the MQTT id of a message received from the server.
setKeepAliveInterval(long) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
setKeepAliveInterval(int) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets the "keep alive" interval.
setKeepAliveSecs(long) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
setKey(String) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
setLogger(String) - Static method in class org.eclipse.paho.client.mqttv3.logging.LoggerFactory
Set the class name of the logger that the LoggerFactory will load If not set getLogger will attempt to create a logger appropriate for the platform.
setManualAcks(boolean) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
If manualAcks is set to true, then on completion of the messageArrived callback the MQTT acknowledgements are not sent.
setManualAcks(boolean) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
If manualAcks is set to true, then on completion of the messageArrived callback the MQTT acknowledgements are not sent.
setManualAcks(boolean) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
setManualAcks(boolean) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
setManualAcks(boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
setManualAcks(boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
setMaxInflight(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
setMaxInflight(int) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets the "max inflight".
setMessage(MqttMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
setMessage(MqttMessage) - Method in class org.eclipse.paho.client.mqttv3.MqttDeliveryToken
 
setMessageID(int) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
setMessageId(int) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
setMessageId(int) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttReceivedMessage
 
setMessageId(int) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
Sets the MQTT message ID.
setMessageListener(String, IMqttMessageListener) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
setMessageListener(String, IMqttMessageListener) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
setMqttCallbackExtended(MqttCallbackExtended) - Method in class org.eclipse.paho.client.mqttv3.internal.ConnectActionListener
Set the MqttCallbackExtened callback to receive connectComplete callbacks
setMqttVersion(int) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets the MQTT version.
setMutable(boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
Sets the mutability of this object (whether or not its values can be changed.
setNetworkModuleIndex(int) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
setNetworkModules(NetworkModule[]) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
setNotified(boolean) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
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.
setPersistBuffer(boolean) - Method in class org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions
 
setPublishCallback(IDisconnectedBufferCallback) - Method in class org.eclipse.paho.client.mqttv3.internal.DisconnectedMessageBuffer
 
setQos(int) - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
Sets the quality of service for this message.
setReconnectCallback(MqttCallbackExtended) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 
setReconnectCallback(MqttCallbackExtended) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
 
setResourceName(String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
setResourceName(String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Set a name that can be used to provide context with each log record.
setRestingState(boolean) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
When Automatic reconnect is enabled, we want ClientComs to enter the 'resting' state if disconnected.
setRetained(boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttMessage
Whether or not the publish message should be retained by the messaging engine.
setServerURIs(String[]) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Set a list of one or more serverURIs the client may connect to.
setSocketFactory(SocketFactory) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets the SocketFactory to use.
setSSLhandshakeTimeout(int) - Method in class org.eclipse.paho.client.mqttv3.internal.SSLNetworkModule
 
setSSLProperties(Properties) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets the SSL properties for the connection.
setTimeToWait(long) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
Set the maximum time to wait for an action to complete.
setTopics(String[]) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
setUserContext(Object) - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Store some context associated with an action.
setUserContext(Object) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
setUserContext(Object) - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
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.
setWill(String, byte[], int, boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets the "Last Will and Testament" (LWT) for the connection.
setWill(String, MqttMessage, int, boolean) - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Sets up the will information, based on the supplied parameters.
severe(String, String, String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
severe(String, String, String, Object[]) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
severe(String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
SEVERE - Static variable in interface org.eclipse.paho.client.mqttv3.logging.Logger
SEVERE is a message level indicating a serious failure.
severe(String, String, String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, if the logger is currently enabled for the given message level.
severe(String, String, String, Object[]) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments, if the logger is currently enabled for the given message level.
severe(String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments and a throwable, if the logger is currently enabled for the given message level.
shutdownConnection(MqttToken, MqttException) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientComms
Shuts down the connection to the server.
SimpleBase64Encoder - Class in org.eclipse.paho.client.mqttv3.internal.security
 
SimpleBase64Encoder() - Constructor for class org.eclipse.paho.client.mqttv3.internal.security.SimpleBase64Encoder
 
SimpleLogFormatter - Class in org.eclipse.paho.client.mqttv3.logging
SimpleLogFormatter prints a single line log record in human readable form.
SimpleLogFormatter() - Constructor for class org.eclipse.paho.client.mqttv3.logging.SimpleLogFormatter
Constructs a SimpleFormatter object.
SINGLE_LEVEL_WILDCARD - Static variable in class org.eclipse.paho.client.mqttv3.MqttTopic
Single-level wildcard The plus sign (+) is a wildcard character that matches only one topic level.
socket - Variable in class org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule
 
SSLNetworkModule - Class in org.eclipse.paho.client.mqttv3.internal
A network module for connecting over SSL.
SSLNetworkModule(SSLSocketFactory, String, int, String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.SSLNetworkModule
Constructs a new SSLNetworkModule using the specified host and port.
SSLPROTOCOL - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Property keys specific to the client).
SSLSocketFactoryFactory - Class in org.eclipse.paho.client.mqttv3.internal.security
An SSLSocketFactoryFactory provides a socket factory and a server socket factory that then can be used to create SSL client sockets or SSL server sockets.
SSLSocketFactoryFactory() - Constructor for class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Create new instance of class.
SSLSocketFactoryFactory(Logger) - Constructor for class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Create new instance of class.
start(String, ExecutorService) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
Starts up the Callback thread.
start(String, ExecutorService) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsReceiver
Starts up the Receiver's thread.
start(String, ExecutorService) - Method in class org.eclipse.paho.client.mqttv3.internal.CommsSender
Starts up the Sender thread.
start() - Method in class org.eclipse.paho.client.mqttv3.internal.LocalNetworkModule
 
start() - Method in interface org.eclipse.paho.client.mqttv3.internal.NetworkModule
 
start() - Method in class org.eclipse.paho.client.mqttv3.internal.SSLNetworkModule
 
start() - Method in class org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule
Starts the module, by creating a TCP socket to the server.
start() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketNetworkModule
 
start(String) - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketReceiver
Starts up the WebSocketReceiver's thread
start() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketSecureNetworkModule
 
start() - Method in interface org.eclipse.paho.client.mqttv3.MqttPingSender
Start ping sender.
start() - Method in class org.eclipse.paho.client.mqttv3.ScheduledExecutorPingSender
 
start() - Method in class org.eclipse.paho.client.mqttv3.TimerPingSender
 
stop() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsCallback
Stops the callback thread.
stop() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsReceiver
Stops the Receiver's thread.
stop() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsSender
Stops the Sender's thread.
stop() - Method in class org.eclipse.paho.client.mqttv3.internal.LocalNetworkModule
 
stop() - Method in interface org.eclipse.paho.client.mqttv3.internal.NetworkModule
 
stop() - Method in class org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule
Stops the module, by closing the TCP socket.
stop() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketNetworkModule
Stops the module, by closing the TCP socket.
stop() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketReceiver
Stops this WebSocketReceiver's thread.
stop() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketSecureNetworkModule
 
stop() - Method in interface org.eclipse.paho.client.mqttv3.MqttPingSender
Stop ping sender.
stop() - Method in class org.eclipse.paho.client.mqttv3.ScheduledExecutorPingSender
 
stop() - Method in class org.eclipse.paho.client.mqttv3.TimerPingSender
 
STRING_ENCODING - Static variable in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
Strings - Class in org.eclipse.paho.client.mqttv3.util
String helper
subscribe(String, int) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Subscribe to a topic, which may include wildcards.
subscribe(String, int, Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Subscribe to a topic, which may include wildcards.
subscribe(String[], int[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Subscribe to multiple topics, each of which may include wildcards.
subscribe(String[], int[], Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Subscribes to multiple topics, each of which may include wildcards.
subscribe(String, int, Object, IMqttActionListener, IMqttMessageListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Subscribe to a topic, which may include wildcards.
subscribe(String, int, IMqttMessageListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Subscribe to a topic, which may include wildcards.
subscribe(String[], int[], IMqttMessageListener[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Subscribe to multiple topics, each of which may include wildcards.
subscribe(String[], int[], Object, IMqttActionListener, IMqttMessageListener[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Subscribe to multiple topics, each of which may include wildcards.
subscribe(String) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Subscribe to a topic, which may include wildcards using a QoS of 1.
subscribe(String[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Subscribes to a one or more topics, which may include wildcards using a QoS of 1.
subscribe(String, int) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Subscribe to a topic, which may include wildcards.
subscribe(String[], int[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Subscribes to multiple topics, each of which may include wildcards.
subscribe(String, IMqttMessageListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Subscribe to a topic, which may include wildcards using a QoS of 1.
subscribe(String[], IMqttMessageListener[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Subscribes to a one or more topics, which may include wildcards using a QoS of 1.
subscribe(String, int, IMqttMessageListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Subscribe to a topic, which may include wildcards.
subscribe(String[], int[], IMqttMessageListener[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Subscribes to multiple topics, each of which may include wildcards.
subscribe(String, int, Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
subscribe(String, int) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
subscribe(String[], int[]) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
subscribe(String[], int[], Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
subscribe(String, int, Object, IMqttActionListener, IMqttMessageListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
subscribe(String, int, IMqttMessageListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
subscribe(String[], int[], IMqttMessageListener[]) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
subscribe(String[], int[], Object, IMqttActionListener, IMqttMessageListener[]) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
subscribe(String) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
subscribe(String[]) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
subscribe(String, int) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
subscribe(String[], int[]) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
subscribe(String, IMqttMessageListener) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
subscribe(String[], IMqttMessageListener[]) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
subscribe(String, int, IMqttMessageListener) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
subscribe(String[], int[], IMqttMessageListener[]) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
syncSpi() - Method in class org.eclipse.paho.client.mqttv3.internal.websocket.Base64.Base64Encoder
 
SYSKEYMGRALGO - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
SYSKEYSTORE - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Property keys used for java system properties
SYSKEYSTOREPWD - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
SYSKEYSTORETYPE - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
SYSTRUSTMGRALGO - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
SYSTRUSTSTORE - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
SYSTRUSTSTOREPWD - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
SYSTRUSTSTORETYPE - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 

T

TCPNetworkModule - Class in org.eclipse.paho.client.mqttv3.internal
A network module for connecting over TCP.
TCPNetworkModule(SocketFactory, String, int, String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.TCPNetworkModule
Constructs a new TCPNetworkModule using the specified host and port.
TimerPingSender - Class in org.eclipse.paho.client.mqttv3
Default ping sender implementation
TimerPingSender() - Constructor for class org.eclipse.paho.client.mqttv3.TimerPingSender
 
timeToWait - Variable in class org.eclipse.paho.client.mqttv3.MqttClient
 
toByte(char[]) - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Convert char array to byte array, where each char is split into two bytes.
toChar(byte[]) - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Convert byte array to char array, where each char is constructed from two bytes.
Token - Class in org.eclipse.paho.client.mqttv3.internal
 
Token(String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.Token
 
TOPIC_LEVEL_SEPARATOR - Static variable in class org.eclipse.paho.client.mqttv3.MqttTopic
The forward slash (/) is used to separate each level within a topic tree and provide a hierarchical structure to the topic space.
TOPIC_WILDCARDS - Static variable in class org.eclipse.paho.client.mqttv3.MqttTopic
Topic wildcards (#+)
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.CommsTokenStore
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttAck
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnack
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttConnect
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPublish
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttPubRel
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttSuback
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttSubscribe
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttUnsubscribe
 
toString() - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttWireMessage
 
toString() - Method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 
toString() - Method in exception 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's payload.
toString() - Method in class org.eclipse.paho.client.mqttv3.MqttTopic
Returns a string representation of this topic.
trace(int, String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
trace(int, String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a trace message, specifying source class and method, with an array of object arguments and a throwable, if the logger is currently enabled for the given message level.
TRUSTSTORE - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
TRUSTSTOREMGR - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
TRUSTSTOREPROVIDER - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
TRUSTSTOREPWD - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 
TRUSTSTORETYPE - Static variable in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
 

U

undo(MqttPublish) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
This removes the MqttSend message from the outbound queue and persistence.
unpackCipherSuites(String) - Static method in class org.eclipse.paho.client.mqttv3.internal.security.SSLSocketFactoryFactory
Inverse operation of packCipherSuites: converts a string of cipher names into an array of cipher names
unPersistBufferedMessage(MqttWireMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.ClientState
 
unsubscribe(String) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Requests the server unsubscribe the client from a topic.
unsubscribe(String[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Requests the server unsubscribe the client from one or more topics.
unsubscribe(String, Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Requests the server unsubscribe the client from a topics.
unsubscribe(String[], Object, IMqttActionListener) - Method in interface org.eclipse.paho.client.mqttv3.IMqttAsyncClient
Requests the server unsubscribe the client from one or more topics.
unsubscribe(String) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Requests the server unsubscribe the client from a topic.
unsubscribe(String[]) - Method in interface org.eclipse.paho.client.mqttv3.IMqttClient
Requests the server unsubscribe the client from one or more topics.
unsubscribe(String, Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
unsubscribe(String) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
unsubscribe(String[]) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
unsubscribe(String[], Object, IMqttActionListener) - Method in class org.eclipse.paho.client.mqttv3.MqttAsyncClient
 
unsubscribe(String) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
unsubscribe(String[]) - Method in class org.eclipse.paho.client.mqttv3.MqttClient
 
URI_TYPE_LOCAL - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 
URI_TYPE_SSL - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 
URI_TYPE_TCP - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 
URI_TYPE_WS - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 
URI_TYPE_WSS - Static variable in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
 

V

validate(String, boolean) - Static method in class org.eclipse.paho.client.mqttv3.MqttTopic
Validate the topic name or topic filter
validateQos(int) - Static method in class org.eclipse.paho.client.mqttv3.MqttMessage
Utility method to validate the supplied QoS value.
validateURI(String) - Static method in class org.eclipse.paho.client.mqttv3.MqttConnectOptions
Validate a URI
VERSION - Static variable in class org.eclipse.paho.client.mqttv3.internal.ClientComms
 

W

waitForCompletion() - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Blocks the current thread until the action this token is associated with has completed.
waitForCompletion(long) - Method in interface org.eclipse.paho.client.mqttv3.IMqttToken
Blocks the current thread until the action this token is associated with has completed.
waitForCompletion() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
waitForCompletion(long) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
waitForCompletion() - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
waitForCompletion(long) - Method in class org.eclipse.paho.client.mqttv3.MqttToken
 
waitForResponse() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
Waits for the message delivery to complete, but doesn't throw an exception in the case of a NACK.
waitForResponse(long) - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
waitUntilSent() - Method in class org.eclipse.paho.client.mqttv3.internal.Token
 
warning(String, String, String) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
warning(String, String, String, Object[]) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
warning(String, String, String, Object[], Throwable) - Method in class org.eclipse.paho.client.mqttv3.logging.JSR47Logger
 
WARNING - Static variable in interface org.eclipse.paho.client.mqttv3.logging.Logger
WARNING is a message level indicating a potential problem.
warning(String, String, String) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, if the logger is currently enabled for the given message level.
warning(String, String, String, Object[]) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments, if the logger is currently enabled for the given message level.
warning(String, String, String, Object[], Throwable) - Method in interface org.eclipse.paho.client.mqttv3.logging.Logger
Log a message, specifying source class and method, with an array of object arguments and a throwable, if the logger is currently enabled for the given message level.
WebSocketFrame - Class in org.eclipse.paho.client.mqttv3.internal.websocket
 
WebSocketFrame(byte, boolean, byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
Initialise a new WebSocketFrame
WebSocketFrame(byte[]) - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
Initialise WebSocketFrame from raw Data
WebSocketFrame(InputStream) - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame
Takes an input stream and parses it into a Websocket frame.
WebSocketHandshake - Class in org.eclipse.paho.client.mqttv3.internal.websocket
Helper class to execute a WebSocket Handshake.
WebSocketHandshake(InputStream, OutputStream, String, String, int) - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketHandshake
 
WebSocketNetworkModule - Class in org.eclipse.paho.client.mqttv3.internal.websocket
 
WebSocketNetworkModule(SocketFactory, String, String, int, String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketNetworkModule
 
WebSocketReceiver - Class in org.eclipse.paho.client.mqttv3.internal.websocket
 
WebSocketReceiver(InputStream, PipedInputStream) - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketReceiver
 
WebSocketSecureNetworkModule - Class in org.eclipse.paho.client.mqttv3.internal.websocket
 
WebSocketSecureNetworkModule(SSLSocketFactory, String, String, int, String) - Constructor for class org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketSecureNetworkModule
 
write(byte[]) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttOutputStream
 
write(byte[], int, int) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttOutputStream
 
write(int) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttOutputStream
 
write(MqttWireMessage) - Method in class org.eclipse.paho.client.mqttv3.internal.wire.MqttOutputStream
Writes an MqttWireMessage to the stream.
A B C D E F G H I J K L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2017 Eclipse Paho. All Rights Reserved.