Updated Configuration Names

amitjoy · Dec 12, 2023 · 61e2f03 · 61e2f03
1 parent 2c03858
commit 61e2f03
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ The `in.bytehue.messaging.client` PID can be used to configure the client. The c
 | `port`                            | Server Port                                                                                                                                   | Long     | `1883`                       |
 | `topicPrefix`                          | MQTT Topic Prefix                                                                                                                           | String   |      |
 | `automaticReconnect`              | Custom Automatic Reconnection                                                                                                                        | Boolean  | `true`                      |
-| `cleanStart`                      | Resume Previously Established Session                                                                                                         | Boolean  | `false`                      |
+| `cleanStart`                      | Always create new session after the client is connected                                                                                                         | Boolean  | `false`                      |
 | `initialDelay`                    | Initial Delay if Custom Automatic Reconnection is enabled (In seconds)                                                                               | Long     | `10`                          |
 | `maxDelay`                        | Max Delay if Custom Automatic Reconnection is enabled (In seconds)                                                                                   | Long     | `30`                         |
 | `useSessionExpiry`           | Flag to enable/disable session expiry                                                                                                                | Boolean     | `false`                         |

diff --git a/...tt5.provider/src/main/java/in/bytehue/messaging/mqtt5/provider/MessageClientProvider.java b/...tt5.provider/src/main/java/in/bytehue/messaging/mqtt5/provider/MessageClientProvider.java
@@ -86,7 +86,8 @@ public final class MessageClientProvider {
 	//@formatter:off
     @ObjectClassDefinition(
             name = "MQTT 5.0 Messaging Client Configuration",
-            description = "This configuration is used to configure the MQTT 5.0 messaging connection")
+            description = "This configuration is used to configure the MQTT 5.0 messaging connection. "
+            		    + "Note that, all time-based configurations are in seconds.")
 
     public @interface Config {
         @AttributeDefinition(name = "Client Identifier")
@@ -102,7 +103,7 @@ public final class MessageClientProvider {
         @AttributeDefinition(name = "Custom Automatic Reconnection")
         boolean automaticReconnectWithDefaultConfig() default true;
 
-        @AttributeDefinition(name = "Resume Previously Established Session")
+        @AttributeDefinition(name = "Always create new session after the client is connected")
         boolean cleanStart() default false;
 
         @AttributeDefinition(name = "Initial Delay if Custom Automatic Reconnection is enabled")
@@ -117,13 +118,13 @@ public final class MessageClientProvider {
         @AttributeDefinition(name = "Flag to enable/disable session expiry")
         boolean useSessionExpiry() default false;
 
-        @AttributeDefinition(name = "Keep Session State (In seconds)")
+        @AttributeDefinition(name = "Keep Session State")
         int sessionExpiryInterval() default 30;
 
         @AttributeDefinition(name = "Flag to enable/disable session expiry for disconnection")
         boolean useSessionExpiryForDisconnect() default true;
 
-        @AttributeDefinition(name = "Keep Session State after disconnection (In seconds)")
+        @AttributeDefinition(name = "Keep Session State after disconnection")
         int sessionExpiryIntervalForDisconnect() default 0;
 
         @AttributeDefinition(name = "Server Port", min = "1", max = "65535")