Package org.eclipse.paho.client.mqttv3

Contains a programming interface enabling applications to communicate with an MQTT server.

See:
          Description

Interface Summary
IMqttActionListener Implementors of this interface will be notified when an asynchronous action completes.
IMqttAsyncClient Enables an application to communicate with an MQTT server using non-blocking methods.
IMqttClient Enables an application to communicate with an MQTT server using using blocking methods.
IMqttDeliveryToken Provides a mechanism for tracking the delivery of a message.
IMqttToken Provides a mechanism for tracking the completion of an asynchronous task.
MqttCallback Enables an application to be notified when asynchronous events related to the client occur.
MqttClientPersistence Represents a persistent data store, used to store outbound and inbound messages while they are in flight, enabling delivery to the QoS specified.
MqttPersistable Represents an object used to pass data to be persisted across the MqttClientPersistence interface.
 

Class Summary
MqttAsyncClient Lightweight client for talking to an MQTT server using non-blocking methods that allow an operation to run in the background.
MqttClient Lightweight client for talking to an MQTT server using methods that block until an operation completes.
MqttConnectOptions Holds the set of options that control how the client connects to a server.
MqttDeliveryToken Provides a mechanism to track the delivery progress of a message.
MqttMessage 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[].
MqttToken Provides a mechanism for tracking the completion of an asynchronous action.
MqttTopic Represents a topic destination, used for publish/subscribe messaging.
 

Exception Summary
MqttException Thrown if an error occurs communicating with the server.
MqttPersistenceException This exception is thrown by the implementor of the persistence interface if there is a problem reading or writing persistent data.
MqttSecurityException Thrown when a client is not authorized to perform an operation, or if there is a problem with the security configuration.
 

Package org.eclipse.paho.client.mqttv3 Description

Contains a programming interface enabling applications to communicate with an MQTT server.

The MQ Telemetry Transport (MQTT) is a lightweight broker-based publish/subscribe messaging protocol designed to be open, simple, lightweight and easy to implement. These characteristics make it ideal for use in constrained environments, for example, but not limited to:

Features of the protocol include:

The basic means of operating the client is:

  1. Create an instance of MqttClient or MqttAsyncClient, providing the address of an MQTT server and a unique client identifier.
  2. connect to the server
  3. Exchange messages with the server:
  4. disconnect from the server.

The programming model and concepts like the protocol are small and easy to use. Key concepts to use when creating MQTT application include:



Copyright © 2013. All Rights Reserved.