You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2024/01/16 10:15:42 UTC

(tomcat) branch main updated: Fix formatting

This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git


The following commit(s) were added to refs/heads/main by this push:
     new 50c8d32957 Fix formatting
50c8d32957 is described below

commit 50c8d32957eeebf6632b4b5282e9222c85189996
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Jan 16 10:15:21 2024 +0000

    Fix formatting
---
 java/org/apache/tomcat/websocket/WsFrameBase.java | 46 +++++++++++++++--------
 1 file changed, 31 insertions(+), 15 deletions(-)

diff --git a/java/org/apache/tomcat/websocket/WsFrameBase.java b/java/org/apache/tomcat/websocket/WsFrameBase.java
index cce9fd4e48..28eb0c46f8 100644
--- a/java/org/apache/tomcat/websocket/WsFrameBase.java
+++ b/java/org/apache/tomcat/websocket/WsFrameBase.java
@@ -82,8 +82,8 @@ public abstract class WsFrameBase {
     private volatile State state = State.NEW_FRAME;
     private volatile boolean open = true;
 
-    private static final AtomicReferenceFieldUpdater<WsFrameBase, ReadState> READ_STATE_UPDATER = AtomicReferenceFieldUpdater
-            .newUpdater(WsFrameBase.class, ReadState.class, "readState");
+    private static final AtomicReferenceFieldUpdater<WsFrameBase,ReadState> READ_STATE_UPDATER =
+            AtomicReferenceFieldUpdater.newUpdater(WsFrameBase.class, ReadState.class, "readState");
     private volatile ReadState readState = ReadState.WAITING;
 
     public WsFrameBase(WsSession wsSession, Transformation transformation) {
@@ -680,20 +680,36 @@ public abstract class WsFrameBase {
 
 
     /**
-     * WAITING - not suspended Server case: waiting for a notification that data is ready to be read from the socket,
-     * the socket is registered to the poller Client case: data has been read from the socket and is waiting for data to
-     * be processed PROCESSING - not suspended Server case: reading from the socket and processing the data Client case:
-     * processing the data if such has already been read and more data will be read from the socket SUSPENDING_WAIT -
-     * suspended, a call to suspend() was made while in WAITING state. A call to resume() will do nothing and will
-     * transition to WAITING state SUSPENDING_PROCESS - suspended, a call to suspend() was made while in PROCESSING
-     * state. A call to resume() will do nothing and will transition to PROCESSING state SUSPENDED - suspended Server
-     * case: processing data finished (SUSPENDING_PROCESS) / a notification was received that data is ready to be read
-     * from the socket (SUSPENDING_WAIT), socket is not registered to the poller Client case: processing data finished
-     * (SUSPENDING_PROCESS) / data has been read from the socket and is available for processing (SUSPENDING_WAIT) A
-     * call to resume() will: Server case: register the socket to the poller Client case: resume data processing CLOSING
-     * - not suspended, a close will be send
-     *
      * <pre>
+     * WAITING            - not suspended
+     *                      Server case: waiting for a notification that data is ready to be read from the socket, the
+     *                                   socket is registered to the poller
+     *                      Client case: data has been read from the socket and is waiting for data to be processed
+     *
+     * PROCESSING         - not suspended
+     *                      Server case: reading from the socket and processing the data
+     *                      Client case: processing the data if such has already been read and more data will be read
+     *                                   from the socket
+     *
+     * SUSPENDING_WAIT    - suspended, a call to suspend() was made while in WAITING state. A call to resume() will do
+     *                      nothing and will transition to WAITING state
+     *
+     * SUSPENDING_PROCESS - suspended, a call to suspend() was made while in PROCESSING state. A call to resume() will
+     *                      do nothing and will transition to PROCESSING state
+     *
+     * SUSPENDED          - suspended
+     *                      Server case: processing data finished (SUSPENDING_PROCESS) / a notification was received
+     *                                   that data is ready to be read from the socket (SUSPENDING_WAIT), socket is not
+     *                                   registered to the poller
+     *                      Client case: processing data finished (SUSPENDING_PROCESS) / data has been read from the
+     *                                   socket and is available for processing (SUSPENDING_WAIT)
+     *                      A call to resume() will:
+     *                      Server case: register the socket to the poller
+     *                      Client case: resume data processing
+     *
+     * CLOSING            - not suspended, a close will be sent
+     *
+     *
      *     resume           data to be        resume
      *     no action        processed         no action
      *  |---------------| |---------------| |----------|


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org