Moved close routine behind niceClose config option; default is older close style

Author: mondain

pom.xml

@@ -9,7 +9,7 @@
     <artifactId>websocket</artifactId>
     <packaging>jar</packaging>
     <name>websocket</name>
-    <version>1.16.14</version>
+    <version>1.16.15</version>
     <description>Red5 WebSocket plugin</description>
     <url>https://github.com/Red5/red5-websocket</url>
     <organization>

src/main/java/org/red5/net/websocket/WebSocketConnection.java

@@ -298,8 +298,93 @@ public void close() {
             session.removeAttribute(Constants.HANDSHAKE_COMPLETE);
             // clear the delay queue
             queue.clear();
-            // send a proper ws close
-            Packet packet = Packet.build(Constants.CLOSE_MESSAGE_BYTES, MessageType.CLOSE);
+            // whether to attempt a nice close or a forceful one
+            if (WebSocketTransport.isNiceClose()) {
+                // send a proper ws close
+                Packet packet = Packet.build(Constants.CLOSE_MESSAGE_BYTES, MessageType.CLOSE);
+                WriteFuture writeFuture = session.write(packet);
+                writeFuture.addListener(new IoFutureListener<WriteFuture>() {
+
+                    @Override
+                    public void operationComplete(WriteFuture future) {
+                        if (future.isWritten()) {
+                            log.debug("Close message written");
+                            // only set on success for now to skip boolean check later
+                            session.setAttribute(Constants.STATUS_CLOSE_WRITTEN, Boolean.TRUE);
+                        }
+                        future.removeListener(this);
+                    }
+
+                });
+                // adjust close routine to allow for flushing
+                CloseFuture closeFuture = session.closeOnFlush();
+                closeFuture.addListener(new IoFutureListener<CloseFuture>() {
+
+                    public void operationComplete(CloseFuture future) {
+                        if (future.isClosed()) {
+                            log.debug("Connection is closed");
+                        } else {
+                            log.debug("Connection is not yet closed");
+                        }
+                        future.removeListener(this);
+                    }
+
+                });
+            } else {
+                // force close
+                CloseFuture closeFuture = session.closeNow();
+                closeFuture.addListener(new IoFutureListener<CloseFuture>() {
+
+                    public void operationComplete(CloseFuture future) {
+                        if (future.isClosed()) {
+                            log.debug("Connection is closed");
+                        } else {
+                            log.debug("Connection is not yet closed");
+                        }
+                        future.removeListener(this);
+                    }
+
+                });
+            }
+        }
+    }
+
+    /**
+     * Close with an associated error status.
+     * 
+     * @param statusCode
+     * @param errResponse
+     */
+    public void close(int statusCode, HandshakeResponse errResponse) {
+        log.warn("Closing connection with status: {}", statusCode);
+        // remove handshake flag
+        session.removeAttribute(Constants.HANDSHAKE_COMPLETE);
+        // clear the delay queue
+        queue.clear();
+        // send http error response
+        session.write(errResponse);
+        // whether to attempt a nice close or a forceful one
+        if (WebSocketTransport.isNiceClose()) {
+            // now send close packet with error code
+            IoBuffer buf = IoBuffer.allocate(16);
+            buf.setAutoExpand(true);
+            // all errors except 403 will use 1002
+            buf.putUnsigned((short) statusCode);
+            try {
+                if (statusCode == 1008) {
+                    // if its a 403 forbidden
+                    buf.put("Policy Violation".getBytes("UTF8"));
+                } else {
+                    buf.put("Protocol error".getBytes("UTF8"));
+                }
+            } catch (Exception e) {
+                // shouldnt be any text encoding issues...
+            }
+            buf.flip();
+            byte[] errBytes = new byte[buf.remaining()];
+            buf.get(errBytes);
+            // construct the packet
+            Packet packet = Packet.build(errBytes, MessageType.CLOSE);
             WriteFuture writeFuture = session.write(packet);
             writeFuture.addListener(new IoFutureListener<WriteFuture>() {
 
@@ -328,71 +413,22 @@ public void operationComplete(CloseFuture future) {
                 }
 
             });
-        }
-    }
-
-    /**
-     * Close with an associated error status.
-     * 
-     * @param statusCode
-     * @param errResponse
-     */
-    public void close(int statusCode, HandshakeResponse errResponse) {
-        log.warn("Closing connection with status: {}", statusCode);
-        // remove handshake flag
-        session.removeAttribute(Constants.HANDSHAKE_COMPLETE);
-        // clear the delay queue
-        queue.clear();
-        // send http error response
-        session.write(errResponse);
-        // now send close packet with error code
-        IoBuffer buf = IoBuffer.allocate(16);
-        buf.setAutoExpand(true);
-        // all errors except 403 will use 1002
-        buf.putUnsigned((short) statusCode);
-        try {
-            if (statusCode == 1008) {
-                // if its a 403 forbidden
-                buf.put("Policy Violation".getBytes("UTF8"));
-            } else {
-                buf.put("Protocol error".getBytes("UTF8"));
-            }
-        } catch (Exception e) {
-            // shouldnt be any text encoding issues...
-        }
-        buf.flip();
-        byte[] errBytes = new byte[buf.remaining()];
-        buf.get(errBytes);
-        // construct the packet
-        Packet packet = Packet.build(errBytes, MessageType.CLOSE);
-        WriteFuture writeFuture = session.write(packet);
-        writeFuture.addListener(new IoFutureListener<WriteFuture>() {
-
-            @Override
-            public void operationComplete(WriteFuture future) {
-                if (future.isWritten()) {
-                    log.debug("Close message written");
-                    // only set on success for now to skip boolean check later
-                    session.setAttribute(Constants.STATUS_CLOSE_WRITTEN, Boolean.TRUE);
-                }
-                future.removeListener(this);
-            }
-
-        });
-        // adjust close routine to allow for flushing
-        CloseFuture closeFuture = session.closeOnFlush();
-        closeFuture.addListener(new IoFutureListener<CloseFuture>() {
+        } else {
+            // force close
+            CloseFuture closeFuture = session.closeNow();
+            closeFuture.addListener(new IoFutureListener<CloseFuture>() {
 
-            public void operationComplete(CloseFuture future) {
-                if (future.isClosed()) {
-                    log.debug("Connection is closed");
-                } else {
-                    log.debug("Connection is not yet closed");
+                public void operationComplete(CloseFuture future) {
+                    if (future.isClosed()) {
+                        log.debug("Connection is closed");
+                    } else {
+                        log.debug("Connection is not yet closed");
+                    }
+                    future.removeListener(this);
                 }
-                future.removeListener(this);
-            }
 
-        });
+            });
+        }
         log.debug("Close complete");
     }
 

src/main/java/org/red5/net/websocket/WebSocketTransport.java

@@ -67,6 +67,9 @@ public class WebSocketTransport implements InitializingBean, DisposableBean {
     // use -1 to disable idle timeout handling
     private int idleTimeout = 60;
 
+    // whether to attempt using close messages or just force closing
+    private static boolean niceClose;
+    
     /**
      * Timeout to wait for the handshake response to be written.
      */
@@ -313,6 +316,14 @@ public void setSecureConfig(SecureWebSocketConfiguration secureConfig) {
         this.secureConfig = secureConfig;
     }
 
+    public static boolean isNiceClose() {
+        return niceClose;
+    }
+
+    public static void setNiceClose(boolean niceClose) {
+        WebSocketTransport.niceClose = niceClose;
+    }
+
     public static boolean isSameOriginPolicy() {
         return sameOriginPolicy;
     }