AWSIotMqttManager (AWS SDK for Android

java.lang.Object
- com.amazonaws.mobileconnectors.iot.AWSIotMqttManager

```
public class AWSIotMqttManager
extends Object
```
The broker for applications allows receive and publish messages AWS IoT MqttClient Amazon Internet of Things AWSIotMqttManager implements a broker for applications and internet-connected things to publish and receive messages.

Field Summary

Fields
Modifier and Type	Field and Description
`static Integer`	`DEFAULT_AUTO_RECONNECT_ATTEMPTS` Default value for number of auto reconnect attempts before giving up.
`static Boolean`	`DEFAULT_AUTO_RECONNECT_ENABLED` Default value for reconnect enabled.
`static Integer`	`DEFAULT_KEEP_ALIVE_SECONDS` Default value for MQTT keep alive.
`static Integer`	`DEFAULT_MAX_RECONNECT_RETRY_TIME_SECONDS` Default value for maximum delay in exponential backoff reconnect algorithm.
`static Integer`	`DEFAULT_MIN_RECONNECT_RETRY_TIME_SECONDS` Default value for starting delay in exponential backoff reconnect algorithm.
`static Integer`	`DEFAULT_OFFLINE_PUBLISH_QUEUE_BOUND` Default value for offline publish queue bound.
`static Boolean`	`DEFAULT_OFFLINE_PUBLISH_QUEUE_ENABLED` Default value for offline publish queue enabled.

Constructor Summary

Constructors
Constructor and Description
`AWSIotMqttManager(String mqttClientId, Region region, String accountEndpointPrefix)` Constructs a new AWSIotMqttManager.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`connect(KeyStore keyStore, AWSIotMqttClientStatusCallback statusCallback)` Initializes the MQTT session and connects to the specified MQTT server using certificate and private key in keystore.
`boolean`	`disconnect()` Disconnect from a mqtt client (close current MQTT session).
`boolean`	`fullPublishQueueKeepsOldestMessages()` Keep the oldest messages when publish queue is full?
`String`	`getAccountEndpointPrefix()` Return the customer specific endpoint prefix.
`int`	`getConnectionStabilityTime()` Gets the connection established time.
`Long`	`getDrainingInterval()` Get the "draining interval" (the time between publish messages are sent from the offline queue when reconnected).
`int`	`getKeepAlive()` Get the MQTT keep alive time.
`int`	`getMaxAutoReconnectAttempts()` Get the current setting of maximum reconnects attempted automatically before quitting.
`int`	`getMaxReconnectRetryTime()` Gets the current maximum value for time to wait between autoreconnect attempts.
`int`	`getMinReconnectRetryTime()` Gets the current starting value for time to wait between autoreconnect attempts.
`AWSIotMqttLastWillAndTestament`	`getMqttLastWillAndTestament()` Get the currently configured Last Will and Testament.
`Integer`	`getOfflinePublishQueueBound()` Get the current value of the offline message queue bound.
`int`	`getReconnectTimeout()` Deprecated.
`boolean`	`isAutoReconnect()` Is auto-reconnect enabled?
`boolean`	`isOfflinePublishQueueEnabled()` Is the publish queue while offline feature enabled?
`void`	`publishData(byte[] data, String topic, AWSIotMqttQos qos)` Publish data to an MQTT topic.
`void`	`publishString(String str, String topic, AWSIotMqttQos qos)` Send a message to an MQTT topic.
`void`	`resetReconnect()` Reset the backoff logic to the inital values.
`void`	`setAutoReconnect(boolean enabled)` Enable / disable the auto-reconnect feature.
`void`	`setConnectionStabilityTime(int time)` Sets the connection stability time.
`void`	`setDrainingInterval(Long interval)` Set the "draining interval" (the time between publish messages are sent from the offline queue when reconnected).
`void`	`setFullQueueToKeepNewestMessages()` Set the queue behavior on a full queue to keep newest messages.
`void`	`setFullQueueToKeepOldestMessages()` Set the queue behavior on a full queue to keep oldest messages.
`void`	`setKeepAlive(int keepAlive)` Sets the MQTT keep alive time used by the underlying MQTT client to determine connection status.
`void`	`setMaxAutoReconnectAttepts(int attempts)` Set the maxium reconnects attempted automatically before quitting.
`void`	`setMqttLastWillAndTestament(AWSIotMqttLastWillAndTestament lwt)` Set the client last will and testament.
`void`	`setOfflinePublishQueueBound(Integer bound)` Set the bound for the number of messages queued while offline.
`void`	`setOfflinePublishQueueEnabled(boolean enabled)` Enable or disable offline publish queueing.
`void`	`setReconnectRetryLimits(int minTimeout, int maxTimeout)` Sets the times to wait between autoreconnect attempts.
`void`	`setReconnectTimeout(int timeout)` Deprecated.
`void`	`subscribeToTopic(String topic, AWSIotMqttQos qos, AWSIotMqttNewMessageCallback callback)` Subscribes to an MQTT topic.
`void`	`unsubscribeTopic(String topic)` Unsubscribe from an MQTT topic.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MIN_RECONNECT_RETRY_TIME_SECONDS
```
public static final Integer DEFAULT_MIN_RECONNECT_RETRY_TIME_SECONDS
```
    Default value for starting delay in exponential backoff reconnect algorithm.
  - DEFAULT_MAX_RECONNECT_RETRY_TIME_SECONDS
```
public static final Integer DEFAULT_MAX_RECONNECT_RETRY_TIME_SECONDS
```
    Default value for maximum delay in exponential backoff reconnect algorithm.
  - DEFAULT_AUTO_RECONNECT_ENABLED
```
public static final Boolean DEFAULT_AUTO_RECONNECT_ENABLED
```
    Default value for reconnect enabled.
  - DEFAULT_AUTO_RECONNECT_ATTEMPTS
```
public static final Integer DEFAULT_AUTO_RECONNECT_ATTEMPTS
```
    Default value for number of auto reconnect attempts before giving up.
  - DEFAULT_KEEP_ALIVE_SECONDS
```
public static final Integer DEFAULT_KEEP_ALIVE_SECONDS
```
    Default value for MQTT keep alive.
  - DEFAULT_OFFLINE_PUBLISH_QUEUE_ENABLED
```
public static final Boolean DEFAULT_OFFLINE_PUBLISH_QUEUE_ENABLED
```
    Default value for offline publish queue enabled.
  - DEFAULT_OFFLINE_PUBLISH_QUEUE_BOUND
```
public static final Integer DEFAULT_OFFLINE_PUBLISH_QUEUE_BOUND
```
    Default value for offline publish queue bound.
- Constructor Detail
  - AWSIotMqttManager
```
public AWSIotMqttManager(String mqttClientId,
                         Region region,
                         String accountEndpointPrefix)
```
    Constructs a new AWSIotMqttManager.
    
    Parameters:
    
    mqttClientId - MQTT client ID to use with this client.
    
    region - The AWS region to use when creating endpoint.
    
    accountEndpointPrefix - Customer specific endpont prefix XXXXXXX in XXXXXX.iot.[region].amazonaws.com.
- Method Detail
  - getAccountEndpointPrefix
```
public String getAccountEndpointPrefix()
```
    Return the customer specific endpoint prefix.
    
    Returns:
    
    customer specific endpoint prefix.
  - isAutoReconnect
```
public boolean isAutoReconnect()
```
    Is auto-reconnect enabled?
    
    Returns:
    
    true if enabled, false if disabled.
  - setAutoReconnect
```
public void setAutoReconnect(boolean enabled)
```
    Enable / disable the auto-reconnect feature.
    
    Parameters:
    
    enabled - true if enabled, false if disabled.
  - getReconnectTimeout
```
@Deprecated
public int getReconnectTimeout()
```
    Deprecated.
    
    Return the timeout value between reconnect attempts.
    
    Returns:
    
    the auto reconnect timeout value in seconds.
  - setReconnectTimeout
```
@Deprecated
public void setReconnectTimeout(int timeout)
```
    Deprecated.
    
    Sets the timeout value for reconnect attempts.
    
    Parameters:
    
    timeout - timeout value in seconds.
  - setReconnectRetryLimits
```
public void setReconnectRetryLimits(int minTimeout,
                                    int maxTimeout)
```
    Sets the times to wait between autoreconnect attempts. The autoreconnect backoff algorithm starts at the minimum value. For each reconnect attempt that is unsuccessful the reconnect logic will increase the time it waits to attempt the next reconnect. The maximum value limits the largest retry time.
    
    Parameters:
    
    minTimeout - minimum timeout value in seconds.
    
    maxTimeout - maximum timeout value in seconds.
  - getMinReconnectRetryTime
```
public int getMinReconnectRetryTime()
```
    Gets the current starting value for time to wait between autoreconnect attempts.
    
    Returns:
    
    the auto reconnect timeout value in seconds.
  - getMaxReconnectRetryTime
```
public int getMaxReconnectRetryTime()
```
    Gets the current maximum value for time to wait between autoreconnect attempts.
    
    Returns:
    
    the auto reconnect wait time value in seconds.
  - getMaxAutoReconnectAttempts
```
public int getMaxAutoReconnectAttempts()
```
    Get the current setting of maximum reconnects attempted automatically before quitting.
    
    Returns:
    
    number of reconnects to automatically attempt. Retry forever = -1.
  - setMaxAutoReconnectAttepts
```
public void setMaxAutoReconnectAttepts(int attempts)
```
    Set the maxium reconnects attempted automatically before quitting.
    
    Parameters:
    
    attempts - number of reconnects attempted automatically. Retry forever = -1.
  - setConnectionStabilityTime
```
public void setConnectionStabilityTime(int time)
```
    Sets the connection stability time. This is the time required to wait after receiving the CONNACK to declare the connection to be stable and established. When attempting to reconnect after a disconnect the client uses backoff logic to wait longer on each successive unsuccessful attempt. We reset this logic after a connection has been maintained for the length of connectionStabilityTime without disconnecting.
    
    Parameters:
    
    time - time to wait to declare a connection to be stable (in seconds).
  - getConnectionStabilityTime
```
public int getConnectionStabilityTime()
```
    Gets the connection established time.
    
    Returns:
    
    time the client will wait to declare a connection to be stable (in seconds).
  - isOfflinePublishQueueEnabled
```
public boolean isOfflinePublishQueueEnabled()
```
    Is the publish queue while offline feature enabled?
    
    Returns:
    
    boolean if offline queueing is enabled.
  - setOfflinePublishQueueEnabled
```
public void setOfflinePublishQueueEnabled(boolean enabled)
```
    Enable or disable offline publish queueing.
    
    Parameters:
    
    enabled - boolean queueing feature is enabled.
  - getOfflinePublishQueueBound
```
public Integer getOfflinePublishQueueBound()
```
    Get the current value of the offline message queue bound.
    
    Returns:
    
    max number of messages stored in the message queue.
  - setOfflinePublishQueueBound
```
public void setOfflinePublishQueueBound(Integer bound)
```
    Set the bound for the number of messages queued while offline. Note: When full queue will act as FIFO and shed oldest messages.
    
    Parameters:
    
    bound - max number of messages to queue while offline. Negative or 0 values ignored.
  - getDrainingInterval
```
public Long getDrainingInterval()
```
    Get the "draining interval" (the time between publish messages are sent from the offline queue when reconnected).
    
    Returns:
    
    long containing the number of milliseconds between publishes.
  - setDrainingInterval
```
public void setDrainingInterval(Long interval)
```
    Set the "draining interval" (the time between publish messages are sent from the offline queue when reconnected).
    
    Parameters:
    
    interval - milliseconds between offline queue publishes.
  - fullPublishQueueKeepsOldestMessages
```
public boolean fullPublishQueueKeepsOldestMessages()
```
    Keep the oldest messages when publish queue is full?
    
    Returns:
    
    boolean true if set to keep oldest messages, false if set to keep newest.
  - setFullQueueToKeepOldestMessages
```
public void setFullQueueToKeepOldestMessages()
```
    Set the queue behavior on a full queue to keep oldest messages. Default is keep newest.
  - setFullQueueToKeepNewestMessages
```
public void setFullQueueToKeepNewestMessages()
```
    Set the queue behavior on a full queue to keep newest messages. Default is keep newest.
  - getKeepAlive
```
public int getKeepAlive()
```
    Get the MQTT keep alive time.
    
    Returns:
    
    The MQTT keep alive time set by the user (in seconds).
  - setKeepAlive
```
public void setKeepAlive(int keepAlive)
```
    Sets the MQTT keep alive time used by the underlying MQTT client to determine connection status.
    
    Parameters:
    
    keepAlive - the MQTT keep alive time set by the user (in seconds). A value of 0 disables keep alive.
  - getMqttLastWillAndTestament
```
public AWSIotMqttLastWillAndTestament getMqttLastWillAndTestament()
```
    Get the currently configured Last Will and Testament.
    
    Returns:
    
    the current configure LWT.
  - setMqttLastWillAndTestament
```
public void setMqttLastWillAndTestament(AWSIotMqttLastWillAndTestament lwt)
```
    Set the client last will and testament.
    
    Parameters:
    
    lwt - the desired last will and testament.
  - connect
```
public void connect(KeyStore keyStore,
                    AWSIotMqttClientStatusCallback statusCallback)
```
    Initializes the MQTT session and connects to the specified MQTT server using certificate and private key in keystore. Keystore should be created using IotKeystoreHelper to setup the certificate and key aliases as expected by the underlying socket helper library.
    
    Parameters:
    
    keyStore - A keystore containing an keystore with a certificate and private key. Use IotKeystoreHelper to get keystore.
    
    statusCallback - When new MQTT session status is received the function of callback will be called with new connection status.
  - disconnect
```
public boolean disconnect()
```
    Disconnect from a mqtt client (close current MQTT session).
    
    Returns:
    
    true if disconnect finished with success.
  - resetReconnect
```
public void resetReconnect()
```
    Reset the backoff logic to the inital values.
  - subscribeToTopic
```
public void subscribeToTopic(String topic,
                             AWSIotMqttQos qos,
                             AWSIotMqttNewMessageCallback callback)
```
    Subscribes to an MQTT topic.
    
    Parameters:
    
    topic - The topic to which to subscribe.
    
    qos - Quality of Service Level of the subscription.
    
    callback - Callback to be called when new message is received on this topic for this subscription.
  - unsubscribeTopic
```
public void unsubscribeTopic(String topic)
```
    Unsubscribe from an MQTT topic.
    
    Parameters:
    
    topic - topic from which to unsubscribe.
  - publishString
```
public void publishString(String str,
                          String topic,
                          AWSIotMqttQos qos)
```
    Send a message to an MQTT topic.
    
    Parameters:
    
    str - The message payload to be sent (as a String).
    
    topic - The topic on which to publish.
    
    qos - The quality of service requested for this message.
  - publishData
```
public void publishData(byte[] data,
                        String topic,
                        AWSIotMqttQos qos)
```
    Publish data to an MQTT topic.
    
    Parameters:
    
    data - The message payload to be sent as a byte array.
    
    topic - The topic on which to publish.
    
    qos - The quality of service requested for this message.

Class AWSIotMqttManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MIN_RECONNECT_RETRY_TIME_SECONDS

DEFAULT_MAX_RECONNECT_RETRY_TIME_SECONDS

DEFAULT_AUTO_RECONNECT_ENABLED

DEFAULT_AUTO_RECONNECT_ATTEMPTS

DEFAULT_KEEP_ALIVE_SECONDS

DEFAULT_OFFLINE_PUBLISH_QUEUE_ENABLED

DEFAULT_OFFLINE_PUBLISH_QUEUE_BOUND

Constructor Detail

AWSIotMqttManager

Method Detail

getAccountEndpointPrefix

isAutoReconnect

setAutoReconnect

getReconnectTimeout

setReconnectTimeout

setReconnectRetryLimits

getMinReconnectRetryTime

getMaxReconnectRetryTime

getMaxAutoReconnectAttempts

setMaxAutoReconnectAttepts

setConnectionStabilityTime

getConnectionStabilityTime

isOfflinePublishQueueEnabled

setOfflinePublishQueueEnabled

getOfflinePublishQueueBound

setOfflinePublishQueueBound

getDrainingInterval

setDrainingInterval

fullPublishQueueKeepsOldestMessages

setFullQueueToKeepOldestMessages

setFullQueueToKeepNewestMessages

getKeepAlive

setKeepAlive

getMqttLastWillAndTestament

setMqttLastWillAndTestament

connect

disconnect

resetReconnect

subscribeToTopic

unsubscribeTopic

publishString

publishData