Fix #382 - clarify session idle timeout

jakartaee · Nov 11, 2021 · 2a3c8fc · 2a3c8fc
1 parent 201d636
commit 2a3c8fc
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/api/client/src/main/java/jakarta/websocket/Session.java b/api/client/src/main/java/jakarta/websocket/Session.java
@@ -170,17 +170,18 @@ public interface Session extends Closeable {
     boolean isOpen();
 
     /**
-     * Return the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e.
-     * no messages are either sent or received in that time.
+     * Return the number of milliseconds before this session will be closed by the container if it is inactive, i.e. no
+     * messages are either sent or received in that time. A value that is zero or negative indicates that this timeout
+     * will not be used.
      *
      * @return the timeout in milliseconds.
      */
     long getMaxIdleTimeout();
 
     /**
-     * Set the non-zero number of milliseconds before this session will be closed by the container if it is inactive, ie
-     * no messages are either sent or received. A value that is 0 or negative indicates the session will never timeout
-     * due to inactivity.
+     * Set the number of milliseconds before this session will be closed by the container if it is inactive, i.e. no
+     * messages are either sent or received in that time. A value that is zero or negative indicates that this timeout
+     * will not be used.
      *
      * @param milliseconds the number of milliseconds.
      */