Client improvements

src/main/asciidoc/dataobjects.adoc

@@ -60,6 +60,11 @@ Do the same thing as link. Use it instead.
 |[[keepAliveTimeSeconds]]`@keepAliveTimeSeconds`|`Number (int)`|+++
 Set the keep alive timeout in seconds
 +++
+|[[keepAliveTimeout]]`@keepAliveTimeout`|`Number (int)`|+++
+Set the time period in seconds after which unacknowledged pings will close the connection.
+ <p/>
+ Setting <code>0</code> will simply expire pings but won't close the connection.
++++
 |[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
 |[[localAddress]]`@localAddress`|`String`|-
 |[[logActivity]]`@logActivity`|`Boolean`|-

src/main/generated/io/vertx/mqtt/MqttClientOptionsConverter.java

@@ -39,6 +39,11 @@ public static void fromJson(Iterable<java.util.Map.Entry<String, Object>> json,
             obj.setKeepAliveTimeSeconds(((Number)member.getValue()).intValue());
           }
           break;
+        case "keepAliveTimeout":
+          if (member.getValue() instanceof Number) {
+            obj.setKeepAliveTimeout(((Number)member.getValue()).intValue());
+          }
+          break;
         case "maxInflightQueue":
           if (member.getValue() instanceof Number) {
             obj.setMaxInflightQueue(((Number)member.getValue()).intValue());
@@ -100,6 +105,7 @@ public static void toJson(MqttClientOptions obj, java.util.Map<String, Object> j
       json.put("clientId", obj.getClientId());
     }
     json.put("keepAliveTimeSeconds", obj.getKeepAliveTimeSeconds());
+    json.put("keepAliveTimeout", obj.getKeepAliveTimeout());
     json.put("maxInflightQueue", obj.getMaxInflightQueue());
     json.put("maxMessageSize", obj.getMaxMessageSize());
     if (obj.getPassword() != null) {

src/main/java/io/vertx/mqtt/MqttClientOptions.java

@@ -45,6 +45,11 @@ public class MqttClientOptions extends NetClientOptions {
   public static final boolean DEFAULT_WILL_RETAIN = false;
   public static final int DEFAULT_MAX_MESSAGE_SIZE = -1;
 
+  /**
+   * The default timeout value for an unacknowledge ping in seconds = 10
+   */
+  public static final int PING_TIMEOUT_SECONDS = 10;
+
   private String clientId;
   private String username;
   private String password;
@@ -55,6 +60,7 @@ public class MqttClientOptions extends NetClientOptions {
   private int willQoS = DEFAULT_WILL_QOS;
   private boolean willRetain = DEFAULT_WILL_RETAIN;
   private int keepAliveTimeSeconds = DEFAULT_KEEP_ALIVE_TIME_SECONDS;
+  private int keepAliveTimeout = PING_TIMEOUT_SECONDS;
   private boolean isAutoKeepAlive = true;
   private boolean isAutoGeneratedClientId = true;
   private int maxInflightQueue = DEFAULT_MAX_INFLIGHT_QUEUE;
@@ -93,6 +99,7 @@ public MqttClientOptions(MqttClientOptions other) {
     this.willFlag = other.willFlag;
     this.willQoS = other.willQoS;
     this.willRetain = other.willRetain;
+    this.keepAliveTimeout = other.keepAliveTimeout;
     this.keepAliveTimeSeconds = other.keepAliveTimeSeconds;
     this.isAutoKeepAlive = other.isAutoKeepAlive;
     this.isAutoGeneratedClientId = other.isAutoGeneratedClientId;
@@ -149,6 +156,13 @@ public int getKeepAliveTimeSeconds() {
     return keepAliveTimeSeconds;
   }
 
+  /**
+   * @return the ping timeout (in seconds)
+   */
+  public int getKeepAliveTimeout() {
+    return keepAliveTimeout;
+  }
+
   /**
    * @return provided username
    */
@@ -294,6 +308,22 @@ public MqttClientOptions setKeepAliveTimeSeconds(int keepAliveTimeSeconds) {
     return this;
   }
 
+  /**
+   * Set the time period in seconds after which unacknowledged pings will close the connection.
+   * <p/>
+   * Setting {@code 0} will simply expire pings but won't close the connection.
+   *
+   * @param keepAliveTimeout the ping timeout
+   * @return current options instance
+   */
+  public MqttClientOptions setKeepAliveTimeout(int keepAliveTimeout) {
+    if (keepAliveTimeout <= 0) {
+      throw new IllegalArgumentException("The ping timeout value must be greater than 0");
+    }
+    this.keepAliveTimeout = keepAliveTimeout;
+    return this;
+  }
+
   /**
    * @return max count of unacknowledged messages
    */