- 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(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.
- 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
-
- 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
-
- 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.
- 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
-
- 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
-
- 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.
- 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.
- 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 interface org.eclipse.paho.client.mqttv3.internal.DestinationProvider
-
- 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.
- 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
-