Issue #8991 - rename websocket isDemanding() method to isAutoDemanding()

Signed-off-by: Lachlan Roberts <[email protected]>
jetty · Feb 8, 2023 · d2dcbeb · d2dcbeb
1 parent b87f938
commit d2dcbeb
Show file tree

Hide file tree

Showing 16 changed files with 49 additions and 49 deletions.
diff --git a/...tty-websocket-core-common/src/main/java/org/eclipse/jetty/websocket/core/CoreSession.java b/...tty-websocket-core-common/src/main/java/org/eclipse/jetty/websocket/core/CoreSession.java
@@ -163,7 +163,7 @@ public interface CoreSession extends OutgoingFrames, Configuration
      * Manage flow control by indicating demand for handling Frames.  A call to
      * {@link FrameHandler#onFrame(Frame, Callback)} will only be made if a
      * corresponding demand has been signaled.   It is an error to call this method
-     * if {@link FrameHandler#isDemanding()} returns false.
+     * if {@link FrameHandler#isAutoDemanding()} returns true.
      *
      * @param n The number of frames that can be handled (in sequential calls to
      * {@link FrameHandler#onFrame(Frame, Callback)}).  May not be negative.

diff --git a/...ty-websocket-core-common/src/main/java/org/eclipse/jetty/websocket/core/FrameHandler.java b/...ty-websocket-core-common/src/main/java/org/eclipse/jetty/websocket/core/FrameHandler.java
@@ -54,8 +54,8 @@ public interface FrameHandler extends IncomingFrames
      * FrameHandler can write during this call, but can not receive frames until the callback is succeeded.
      * </p>
      * <p>
-     * If the FrameHandler succeeds the callback we transition to OPEN state and can now receive frames if
-     * not demanding, or can now call {@link CoreSession#demand(long)} to receive frames if demanding.
+     * If the FrameHandler succeeds the callback we transition to OPEN state and can now receive frames if auto-demanding,
+     * or can now call {@link CoreSession#demand(long)} to receive frames if it is not auto-demanding.
      * If the FrameHandler fails the callback a close frame will be sent with {@link CloseStatus#SERVER_ERROR} and
      * the connection will be closed. <br>
      * </p>
@@ -106,12 +106,12 @@ public interface FrameHandler extends IncomingFrames
     /**
      * Does the FrameHandler manage it's own demand?
      *
-     * @return true iff the FrameHandler will manage its own flow control by calling {@link CoreSession#demand(long)} when it
-     * is willing to receive new Frames.  Otherwise the demand will be managed by an automatic call to demand(1) after every
-     * succeeded callback passed to {@link #onFrame(Frame, Callback)}.
+     * @return true if demand will be managed by an automatic call to demand(1) after every * succeeded callback passed to
+     * {@link #onFrame(Frame, Callback)}. If false the FrameHandler will need to manage its own flow control by calling
+     * {@link CoreSession#demand(long)} when it is willing to receive new Frames.
      */
-    default boolean isDemanding()
+    default boolean isAutoDemanding()
     {
-        return false;
+        return true;
     }
 }
diff --git a/...t-core-common/src/main/java/org/eclipse/jetty/websocket/core/internal/MessageHandler.java b/...t-core-common/src/main/java/org/eclipse/jetty/websocket/core/internal/MessageHandler.java
@@ -36,8 +36,8 @@
  * A utility implementation of FrameHandler that defragments
  * text frames into a String message before calling {@link #onText(String, Callback)}.
  * Flow control is by default automatic, but an implementation
- * may extend {@link #isDemanding()} to return true and then explicityly control
- * demand with calls to {@link CoreSession#demand(long)}
+ * may extend {@link #isAutoDemanding()} to return false and then explicitly control
+ * demand with calls to {@link CoreSession#demand(long)}.
  */
 public class MessageHandler implements FrameHandler
 {

diff --git a/...-common/src/main/java/org/eclipse/jetty/websocket/core/internal/WebSocketCoreSession.java b/...-common/src/main/java/org/eclipse/jetty/websocket/core/internal/WebSocketCoreSession.java
@@ -65,7 +65,7 @@ public class WebSocketCoreSession implements IncomingFrames, CoreSession, Dumpab
     private final WebSocketSessionState sessionState = new WebSocketSessionState();
     private final FrameHandler handler;
     private final Negotiated negotiated;
-    private final boolean demanding;
+    private final boolean autoDemanding;
     private final Flusher flusher = new Flusher(this);
     private final ExtensionStack extensionStack;
 
@@ -90,7 +90,7 @@ public WebSocketCoreSession(FrameHandler handler, Behavior behavior, Negotiated
         this.handler = handler;
         this.behavior = behavior;
         this.negotiated = negotiated;
-        this.demanding = handler.isDemanding();
+        this.autoDemanding = handler.isAutoDemanding();
         extensionStack = negotiated.getExtensions();
         extensionStack.initialize(new IncomingAdaptor(), new OutgoingAdaptor(), this);
     }
@@ -126,9 +126,9 @@ protected void handle(Runnable runnable)
     /**
      * @return True if the sessions handling is demanding.
      */
-    public boolean isDemanding()
+    public boolean isAutoDemanding()
     {
-        return demanding;
+        return autoDemanding;
     }
 
     public ExtensionStack getExtensionStack()
@@ -395,7 +395,7 @@ public void onOpen()
                 sessionState.onOpen();
                 if (LOG.isDebugEnabled())
                     LOG.debug("ConnectionState: Transition to OPEN");
-                if (!demanding)
+                if (autoDemanding)
                     autoDemand();
             },
             x ->
@@ -424,7 +424,7 @@ public void onOpen()
     @Override
     public void demand(long n)
     {
-        if (!demanding)
+        if (autoDemanding)
             throw new IllegalStateException("FrameHandler is not demanding: " + this);
         getExtensionStack().demand(n);
     }
@@ -662,7 +662,7 @@ public void onFrame(Frame frame, Callback callback)
                 // Handle inbound frame
                 if (frame.getOpCode() != OpCode.CLOSE)
                 {
-                    Callback handlerCallback = isDemanding() ? callback : Callback.from(() ->
+                    Callback handlerCallback = !isAutoDemanding() ? callback : Callback.from(() ->
                     {
                         callback.succeeded();
                         autoDemand();

diff --git a/...jetty-websocket-core-tests/src/test/java/org/eclipse/jetty/websocket/core/DemandTest.java b/...jetty-websocket-core-tests/src/test/java/org/eclipse/jetty/websocket/core/DemandTest.java
@@ -93,9 +93,9 @@ public void onClosed(CloseStatus closeStatus, Callback callback)
         }
 
         @Override
-        public boolean isDemanding()
+        public boolean isAutoDemanding()
         {
-            return true;
+            return false;
         }
     }
 

diff --git a/...-tests/src/test/java/org/eclipse/jetty/websocket/core/DemandingIncomingFramesCapture.java b/...-tests/src/test/java/org/eclipse/jetty/websocket/core/DemandingIncomingFramesCapture.java
@@ -34,7 +34,7 @@ public void onFrame(Frame frame, Callback callback)
         }
         finally
         {
-            if (!_coreSession.isDemanding())
+            if (_coreSession.isAutoDemanding())
                 _coreSession.autoDemand();
         }
     }

diff --git a/...bsocket-core-tests/src/test/java/org/eclipse/jetty/websocket/core/MessageHandlerTest.java b/...bsocket-core-tests/src/test/java/org/eclipse/jetty/websocket/core/MessageHandlerTest.java
@@ -46,7 +46,7 @@ public class MessageHandlerTest
     static byte[] fourByteUtf8Bytes = fourByteUtf8String.getBytes(StandardCharsets.UTF_8);
     static byte[] nonUtf8Bytes = {0x7F, (byte)0xFF, (byte)0xFF};
 
-    boolean demanding;
+    boolean autoDemanding;
     CoreSession coreSession;
     List<String> textMessages = new ArrayList<>();
     List<ByteBuffer> binaryMessages = new ArrayList<>();
@@ -57,7 +57,7 @@ public class MessageHandlerTest
     @BeforeEach
     public void beforeEach() throws Exception
     {
-        demanding = false;
+        autoDemanding = true;
 
         coreSession = new CoreSession.Empty()
         {
@@ -94,9 +94,9 @@ protected void onBinary(ByteBuffer message, Callback callback)
             }
 
             @Override
-            public boolean isDemanding()
+            public boolean isAutoDemanding()
             {
-                return demanding;
+                return autoDemanding;
             }
         };
 

diff --git a/...bsocket-core-tests/src/test/java/org/eclipse/jetty/websocket/core/WebSocketCloseTest.java b/...bsocket-core-tests/src/test/java/org/eclipse/jetty/websocket/core/WebSocketCloseTest.java
@@ -585,9 +585,9 @@ public void onError(Throwable cause, Callback callback)
         }
 
         @Override
-        public boolean isDemanding()
+        public boolean isAutoDemanding()
         {
-            return true;
+            return false;
         }
     }
 }
diff --git a/...ebsocket-core-tests/src/test/java/org/eclipse/jetty/websocket/core/WebSocketOpenTest.java b/...ebsocket-core-tests/src/test/java/org/eclipse/jetty/websocket/core/WebSocketOpenTest.java
@@ -204,9 +204,9 @@ public void onOpen(CoreSession coreSession, Callback callback)
         }
 
         @Override
-        public boolean isDemanding()
+        public boolean isAutoDemanding()
         {
-            return true;
+            return false;
         }
     }
 }
diff --git a/...t-core-tests/src/test/java/org/eclipse/jetty/websocket/core/extensions/ExtensionTool.java b/...t-core-tests/src/test/java/org/eclipse/jetty/websocket/core/extensions/ExtensionTool.java
@@ -102,7 +102,7 @@ public void parseIncomingHex(String... rawhex)
                         public void succeeded()
                         {
                             super.succeeded();
-                            if (!coreSession.isDemanding())
+                            if (coreSession.isAutoDemanding())
                                 coreSession.autoDemand();
                         }
                     };

diff --git a/...rc/test/java/org/eclipse/jetty/websocket/core/extensions/PermessageDeflateDemandTest.java b/...rc/test/java/org/eclipse/jetty/websocket/core/extensions/PermessageDeflateDemandTest.java
@@ -187,9 +187,9 @@ public void onClosed(CloseStatus closeStatus, Callback callback)
         }
 
         @Override
-        public boolean isDemanding()
+        public boolean isAutoDemanding()
         {
-            return true;
+            return false;
         }
     }
 }
diff --git a/...core-tests/src/test/java/org/eclipse/jetty/websocket/core/server/WebSocketServerTest.java b/...core-tests/src/test/java/org/eclipse/jetty/websocket/core/server/WebSocketServerTest.java
@@ -94,9 +94,9 @@ public void testSimpleDemand() throws Exception
         TestFrameHandler serverHandler = new TestFrameHandler()
         {
             @Override
-            public boolean isDemanding()
+            public boolean isAutoDemanding()
             {
-                return true;
+                return false;
             }
         };
 
@@ -153,9 +153,9 @@ public void onOpen(CoreSession coreSession, Callback callback)
             }
 
             @Override
-            public boolean isDemanding()
+            public boolean isAutoDemanding()
             {
-                return true;
+                return false;
             }
 
             @Override
@@ -260,9 +260,9 @@ public void onOpen(CoreSession coreSession, Callback callback)
             }
 
             @Override
-            public boolean isDemanding()
+            public boolean isAutoDemanding()
             {
-                return true;
+                return false;
             }
 
             @Override
@@ -326,9 +326,9 @@ public void onClosed(CloseStatus closeStatus)
             }
 
             @Override
-            public boolean isDemanding()
+            public boolean isAutoDemanding()
             {
-                return true;
+                return false;
             }
 
             @Override
@@ -393,9 +393,9 @@ public void onOpen(CoreSession coreSession, Callback callback)
             }
 
             @Override
-            public boolean isDemanding()
+            public boolean isAutoDemanding()
             {
-                return true;
+                return false;
             }
 
             @Override

diff --git a/...in/java/org/eclipse/jetty/ee10/websocket/jakarta/common/JakartaWebSocketFrameHandler.java b/...in/java/org/eclipse/jetty/ee10/websocket/jakarta/common/JakartaWebSocketFrameHandler.java
@@ -323,9 +323,9 @@ public void onError(Throwable cause, Callback callback)
     }
 
     @Override
-    public boolean isDemanding()
+    public boolean isAutoDemanding()
     {
-        return true;
+        return false;
     }
 
     public Set<MessageHandler> getMessageHandlers()

diff --git a/...mon/src/main/java/org/eclipse/jetty/ee10/websocket/common/JettyWebSocketFrameHandler.java b/...mon/src/main/java/org/eclipse/jetty/ee10/websocket/common/JettyWebSocketFrameHandler.java
@@ -423,9 +423,9 @@ private void onTextFrame(Frame frame, Callback callback)
     }
 
     @Override
-    public boolean isDemanding()
+    public boolean isAutoDemanding()
     {
-        return true;
+        return false;
     }
 
     public void suspend()

diff --git a/...ain/java/org/eclipse/jetty/ee9/websocket/jakarta/common/JakartaWebSocketFrameHandler.java b/...ain/java/org/eclipse/jetty/ee9/websocket/jakarta/common/JakartaWebSocketFrameHandler.java
@@ -323,9 +323,9 @@ public void onError(Throwable cause, Callback callback)
     }
 
     @Override
-    public boolean isDemanding()
+    public boolean isAutoDemanding()
     {
-        return true;
+        return false;
     }
 
     public Set<MessageHandler> getMessageHandlers()

diff --git a/...mmon/src/main/java/org/eclipse/jetty/ee9/websocket/common/JettyWebSocketFrameHandler.java b/...mmon/src/main/java/org/eclipse/jetty/ee9/websocket/common/JettyWebSocketFrameHandler.java
@@ -423,9 +423,9 @@ private void onTextFrame(Frame frame, Callback callback)
     }
 
     @Override
-    public boolean isDemanding()
+    public boolean isAutoDemanding()
     {
-        return true;
+        return false;
     }
 
     public void suspend()
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,7 +34,7 @@ public void onFrame(Frame frame, Callback callback) @@
             }
             finally
             {
-                if (!_coreSession.isDemanding())
+                if (_coreSession.isAutoDemanding())
                     _coreSession.autoDemand();
             }
         }
@@ Expand Down @@