Add missing 'operation(args, future)' for 'operation(args)'

- Fixes #818
- Fix inspector warnings

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketClientHandshaker.java

@@ -122,7 +122,22 @@ public abstract class WebSocketClientHandshaker {
      * @param channel
      *            Channel
      */
-    public abstract ChannelFuture handshake(Channel channel);
+    public ChannelFuture handshake(Channel channel) {
+        if (channel == null) {
+            throw new NullPointerException("channel");
+        }
+        return handshake(channel, channel.newFuture());
+    }
+
+    /**
+     * Begins the opening handshake
+     *
+     * @param channel
+     *            Channel
+     * @param future
+     *            the {@link ChannelFuture} to be notified when the opening handshake is sent
+     */
+    public abstract ChannelFuture handshake(Channel channel, ChannelFuture future);
 
     /**
      * Validates and finishes the opening handshake initiated by {@link #handshake}}.

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketClientHandshaker00.java

@@ -91,7 +91,7 @@ public class WebSocketClientHandshaker00 extends WebSocketClientHandshaker {
      *            Channel into which we can write our request
      */
     @Override
-    public ChannelFuture handshake(Channel channel) {
+    public ChannelFuture handshake(Channel channel, final ChannelFuture handshakeFuture) {
         // Make keys
         int spaces1 = WebSocketUtil.randomNumber(1, 12);
         int spaces2 = WebSocketUtil.randomNumber(1, 12);
@@ -173,9 +173,7 @@ public class WebSocketClientHandshaker00 extends WebSocketClientHandshaker {
         request.setHeader(Names.CONTENT_LENGTH, key3.length);
         request.setContent(Unpooled.copiedBuffer(key3));
 
-        final ChannelFuture handshakeFuture = channel.newFuture();
         ChannelFuture future = channel.write(request);
-
         future.addListener(new ChannelFutureListener() {
             @Override
             public void operationComplete(ChannelFuture future) {

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketClientHandshaker08.java

@@ -97,7 +97,7 @@ public class WebSocketClientHandshaker08 extends WebSocketClientHandshaker {
      *            Channel into which we can write our request
      */
     @Override
-    public ChannelFuture handshake(Channel channel) {
+    public ChannelFuture handshake(Channel channel, final ChannelFuture handshakeFuture) {
         // Get path
         URI wsURL = getWebSocketUrl();
         String path = wsURL.getPath();
@@ -151,9 +151,7 @@ public class WebSocketClientHandshaker08 extends WebSocketClientHandshaker {
             }
         }
 
-        final ChannelFuture handshakeFuture = channel.newFuture();
         ChannelFuture future = channel.write(request);
-
         future.addListener(new ChannelFutureListener() {
             @Override
             public void operationComplete(ChannelFuture future) {

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketClientHandshaker13.java

@@ -97,7 +97,7 @@ public class WebSocketClientHandshaker13 extends WebSocketClientHandshaker {
      *            Channel into which we can write our request
      */
     @Override
-    public ChannelFuture handshake(Channel channel) {
+    public ChannelFuture handshake(Channel channel, final ChannelFuture handshakeFuture) {
         // Get path
         URI wsURL = getWebSocketUrl();
         String path = wsURL.getPath();
@@ -151,9 +151,7 @@ public class WebSocketClientHandshaker13 extends WebSocketClientHandshaker {
             }
         }
 
-        final ChannelFuture handshakeFuture = channel.newFuture();
         ChannelFuture future = channel.write(request);
-
         future.addListener(new ChannelFutureListener() {
             @Override
             public void operationComplete(ChannelFuture future) {

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshaker.java

@@ -29,6 +29,8 @@ import java.util.Set;
  */
 public abstract class WebSocketServerHandshaker {
 
+    private static final String[] EMPTY_ARRAY = new String[0];
+
     private final String webSocketUrl;
 
     private final String[] subprotocols;
@@ -64,7 +66,7 @@ public abstract class WebSocketServerHandshaker {
             }
             this.subprotocols = subprotocolArray;
         } else {
-            this.subprotocols = new String[0];
+            this.subprotocols = EMPTY_ARRAY;
         }
         this.maxFramePayloadLength = maxFramePayloadLength;
     }
@@ -109,7 +111,24 @@ public abstract class WebSocketServerHandshaker {
      * @param req
      *            HTTP Request
      */
-    public abstract ChannelFuture handshake(Channel channel, HttpRequest req);
+    public ChannelFuture handshake(Channel channel, HttpRequest req) {
+        if (channel == null) {
+            throw new NullPointerException("channel");
+        }
+        return handshake(channel, req, channel.newFuture());
+    }
+
+    /**
+     * Performs the opening handshake
+     *
+     * @param channel
+     *            Channel
+     * @param req
+     *            HTTP Request
+     * @param future
+     *            the {@link ChannelFuture} to be notified when the opening handshake is done
+     */
+    public abstract ChannelFuture handshake(Channel channel, HttpRequest req, ChannelFuture future);
 
     /**
      * Performs the closing handshake
@@ -119,7 +138,24 @@ public abstract class WebSocketServerHandshaker {
      * @param frame
      *            Closing Frame that was received
      */
-    public abstract ChannelFuture close(Channel channel, CloseWebSocketFrame frame);
+    public ChannelFuture close(Channel channel, CloseWebSocketFrame frame) {
+        if (channel == null) {
+            throw new NullPointerException("channel");
+        }
+        return close(channel, frame, channel.newFuture());
+    }
+
+    /**
+     * Performs the closing handshake
+     *
+     * @param channel
+     *            Channel
+     * @param frame
+     *            Closing Frame that was received
+     * @param future
+     *            the {@link ChannelFuture} to be notified when the closing handshake is done
+     */
+    public abstract ChannelFuture close(Channel channel, CloseWebSocketFrame frame, ChannelFuture future);
 
     /**
      * Selects the first matching supported sub protocol

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshaker00.java

@@ -15,9 +15,6 @@
  */
 package io.netty.handler.codec.http.websocketx;
 
-import static io.netty.handler.codec.http.HttpHeaders.Names.*;
-import static io.netty.handler.codec.http.HttpHeaders.Values.*;
-import static io.netty.handler.codec.http.HttpVersion.*;
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import io.netty.channel.Channel;
@@ -36,6 +33,12 @@ import io.netty.handler.codec.http.HttpResponseStatus;
 import io.netty.logging.InternalLogger;
 import io.netty.logging.InternalLoggerFactory;
 
+import java.util.regex.Pattern;
+
+import static io.netty.handler.codec.http.HttpHeaders.Names.*;
+import static io.netty.handler.codec.http.HttpHeaders.Values.*;
+import static io.netty.handler.codec.http.HttpVersion.*;
+
 /**
  * <p>
  * Performs server side opening and closing handshakes for web socket specification version <a
@@ -50,6 +53,9 @@ public class WebSocketServerHandshaker00 extends WebSocketServerHandshaker {
 
     private static final InternalLogger logger = InternalLoggerFactory.getInstance(WebSocketServerHandshaker00.class);
 
+    private static final Pattern BEGINNING_DIGIT = Pattern.compile("[^0-9]");
+    private static final Pattern BEGINNING_SPACE = Pattern.compile("[^ ]");
+
     /**
      * Constructor specifying the destination web socket location
      *
@@ -112,7 +118,7 @@ public class WebSocketServerHandshaker00 extends WebSocketServerHandshaker {
      *            HTTP request
      */
     @Override
-    public ChannelFuture handshake(Channel channel, HttpRequest req) {
+    public ChannelFuture handshake(Channel channel, HttpRequest req, ChannelFuture future) {
 
         if (logger.isDebugEnabled()) {
             logger.debug(String.format("Channel %s WS Version 00 server handshake", channel.id()));
@@ -152,8 +158,10 @@ public class WebSocketServerHandshaker00 extends WebSocketServerHandshaker {
             // Calculate the answer of the challenge.
             String key1 = req.getHeader(SEC_WEBSOCKET_KEY1);
             String key2 = req.getHeader(SEC_WEBSOCKET_KEY2);
-            int a = (int) (Long.parseLong(key1.replaceAll("[^0-9]", "")) / key1.replaceAll("[^ ]", "").length());
+            int a = (int) (Long.parseLong(BEGINNING_DIGIT.matcher(key1).replaceAll("")) /
-            int b = (int) (Long.parseLong(key2.replaceAll("[^0-9]", "")) / key2.replaceAll("[^ ]", "").length());
+                           BEGINNING_SPACE.matcher(key1).replaceAll("").length());
+            int b = (int) (Long.parseLong(BEGINNING_DIGIT.matcher(key2).replaceAll("")) /
+                           BEGINNING_SPACE.matcher(key2).replaceAll("").length());
             long c = req.getContent().readLong();
             ByteBuf input = Unpooled.buffer(16);
             input.writeInt(a);
@@ -172,8 +180,7 @@ public class WebSocketServerHandshaker00 extends WebSocketServerHandshaker {
         }
 
         // Upgrade the connection and send the handshake response.
-        ChannelFuture future = channel.write(res);
+        channel.write(res, future);
-
         future.addListener(new ChannelFutureListener() {
             @Override
             public void operationComplete(ChannelFuture future) {
@@ -200,7 +207,7 @@ public class WebSocketServerHandshaker00 extends WebSocketServerHandshaker {
      *            Web Socket frame that was received
      */
     @Override
-    public ChannelFuture close(Channel channel, CloseWebSocketFrame frame) {
+    public ChannelFuture close(Channel channel, CloseWebSocketFrame frame, ChannelFuture future) {
-        return channel.write(frame);
+        return channel.write(frame, future);
     }
 }

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshaker08.java

@@ -109,7 +109,7 @@ public class WebSocketServerHandshaker08 extends WebSocketServerHandshaker {
      *            HTTP request
      */
     @Override
-    public ChannelFuture handshake(Channel channel, HttpRequest req) {
+    public ChannelFuture handshake(Channel channel, HttpRequest req, ChannelFuture future) {
 
         if (logger.isDebugEnabled()) {
             logger.debug(String.format("Channel %s WS Version 8 server handshake", channel.id()));
@@ -144,7 +144,7 @@ public class WebSocketServerHandshaker08 extends WebSocketServerHandshaker {
             }
         }
 
-        ChannelFuture future = channel.write(res);
+        channel.write(res, future);
 
         // Upgrade the connection and send the handshake response.
         future.addListener(new ChannelFutureListener() {
@@ -173,10 +173,8 @@ public class WebSocketServerHandshaker08 extends WebSocketServerHandshaker {
      *            Web Socket frame that was received
      */
     @Override
-    public ChannelFuture close(Channel channel, CloseWebSocketFrame frame) {
+    public ChannelFuture close(Channel channel, CloseWebSocketFrame frame, ChannelFuture future) {
-        ChannelFuture f = channel.write(frame);
+        future.addListener(ChannelFutureListener.CLOSE);
-        f.addListener(ChannelFutureListener.CLOSE);
+        return channel.write(frame, future);
-        return f;
     }
-
 }

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshaker13.java

@@ -108,7 +108,7 @@ public class WebSocketServerHandshaker13 extends WebSocketServerHandshaker {
      *            HTTP request
      */
     @Override
-    public ChannelFuture handshake(Channel channel, HttpRequest req) {
+    public ChannelFuture handshake(Channel channel, HttpRequest req, ChannelFuture future) {
 
         if (logger.isDebugEnabled()) {
             logger.debug(String.format("Channel %s WS Version 13 server handshake", channel.id()));
@@ -144,7 +144,7 @@ public class WebSocketServerHandshaker13 extends WebSocketServerHandshaker {
             }
         }
 
-        ChannelFuture future = channel.write(res);
+        channel.write(res, future);
 
         // Upgrade the connection and send the handshake response.
         future.addListener(new ChannelFutureListener() {
@@ -173,10 +173,8 @@ public class WebSocketServerHandshaker13 extends WebSocketServerHandshaker {
      *            Web Socket frame that was received
      */
     @Override
-    public ChannelFuture close(Channel channel, CloseWebSocketFrame frame) {
+    public ChannelFuture close(Channel channel, CloseWebSocketFrame frame, ChannelFuture future) {
-        ChannelFuture f = channel.write(frame);
+        future.addListener(ChannelFutureListener.CLOSE);
-        f.addListener(ChannelFutureListener.CLOSE);
+        return channel.write(frame, future);
-        return f;
     }
-
 }

transport/src/main/java/io/netty/channel/socket/SctpChannel.java

@@ -82,9 +82,21 @@ public interface SctpChannel extends Channel {
      */
     ChannelFuture bindAddress(InetAddress localAddress);
 
+    /**
+     * Bind a address to the already bound channel to enable multi-homing.
+     * The Channel bust be bound and yet to be connected.
+     */
+    ChannelFuture bindAddress(InetAddress localAddress, ChannelFuture future);
+
     /**
      *  Unbind the address from channel's multi-homing address list.
      *  The address should be added already in multi-homing address list.
      */
     ChannelFuture unbindAddress(InetAddress localAddress);
+
+    /**
+     *  Unbind the address from channel's multi-homing address list.
+     *  The address should be added already in multi-homing address list.
+     */
+    ChannelFuture unbindAddress(InetAddress localAddress, ChannelFuture future);
 }

transport/src/main/java/io/netty/channel/socket/SocketChannel.java

@@ -22,8 +22,8 @@ import java.net.InetSocketAddress;
 import java.net.Socket;
 
 /**
- * A TCP/IP socket {@link Channel} which was either accepted by
+ * A TCP/IP socket {@link Channel}.
- * {@link ServerSocketChannel} or created by {@link ClientSocketChannelFactory}.
+ *
  * @apiviz.landmark
  * @apiviz.composedOf io.netty.channel.socket.SocketChannelConfig
  */
@@ -51,4 +51,9 @@ public interface SocketChannel extends Channel {
      * @see Socket#shutdownOutput()
      */
     ChannelFuture shutdownOutput();
+
+    /**
+     * @see Socket#shutdownOutput()
+     */
+    ChannelFuture shutdownOutput(ChannelFuture future);
 }

transport/src/main/java/io/netty/channel/socket/aio/AioSocketChannel.java

@@ -115,10 +115,20 @@ public class AioSocketChannel extends AbstractAioChannel implements SocketChanne
 
     @Override
     public ChannelFuture shutdownOutput() {
-        final ChannelFuture future = newFuture();
+        return shutdownOutput(newFuture());
+    }
+
+    @Override
+    public ChannelFuture shutdownOutput(final ChannelFuture future) {
         EventLoop loop = eventLoop();
         if (loop.inEventLoop()) {
-            shutdownOutput(future);
+            try {
+                javaChannel().shutdownOutput();
+                outputShutdown = true;
+                future.setSuccess();
+            } catch (Throwable t) {
+                future.setFailure(t);
+            }
         } else {
             loop.execute(new Runnable() {
                 @Override
@@ -130,16 +140,6 @@ public class AioSocketChannel extends AbstractAioChannel implements SocketChanne
         return future;
     }
 
-    private void shutdownOutput(ChannelFuture future) {
-        try {
-            javaChannel().shutdownOutput();
-            outputShutdown = true;
-            future.setSuccess();
-        } catch (Throwable t) {
-            future.setFailure(t);
-        }
-    }
-
     @Override
     protected void doConnect(SocketAddress remoteAddress, SocketAddress localAddress, final ChannelFuture future) {
         if (localAddress != null) {

transport/src/main/java/io/netty/channel/socket/nio/NioSctpChannel.java

@@ -284,12 +284,11 @@ public class NioSctpChannel extends AbstractNioMessageChannel implements io.nett
 
     @Override
     public ChannelFuture bindAddress(InetAddress localAddress) {
-        ChannelFuture future = newFuture();
+        return bindAddress(localAddress, newFuture());
-        doBindAddress(localAddress, future);
-        return future;
     }
 
-    void doBindAddress(final InetAddress localAddress, final ChannelFuture future) {
+    @Override
+    public ChannelFuture bindAddress(final InetAddress localAddress, final ChannelFuture future) {
         if (eventLoop().inEventLoop()) {
             try {
                 javaChannel().bindAddress(localAddress);
@@ -301,20 +300,20 @@ public class NioSctpChannel extends AbstractNioMessageChannel implements io.nett
             eventLoop().execute(new Runnable() {
                 @Override
                 public void run() {
-                    doBindAddress(localAddress, future);
+                    bindAddress(localAddress, future);
                 }
             });
         }
+        return future;
     }
 
     @Override
     public ChannelFuture unbindAddress(InetAddress localAddress) {
-        ChannelFuture future = newFuture();
+        return unbindAddress(localAddress, newFuture());
-        doUnbindAddress(localAddress, future);
-        return future;
     }
 
-    void doUnbindAddress(final InetAddress localAddress, final ChannelFuture future) {
+    @Override
+    public ChannelFuture unbindAddress(final InetAddress localAddress, final ChannelFuture future) {
         if (eventLoop().inEventLoop()) {
             try {
                 javaChannel().unbindAddress(localAddress);
@@ -326,10 +325,10 @@ public class NioSctpChannel extends AbstractNioMessageChannel implements io.nett
             eventLoop().execute(new Runnable() {
                 @Override
                 public void run() {
-                    doUnbindAddress(localAddress, future);
+                    unbindAddress(localAddress, future);
                 }
             });
         }
+        return future;
     }
-
 }

transport/src/main/java/io/netty/channel/socket/nio/NioSocketChannel.java

@@ -109,10 +109,19 @@ public class NioSocketChannel extends AbstractNioByteChannel implements io.netty
 
     @Override
     public ChannelFuture shutdownOutput() {
-        final ChannelFuture future = newFuture();
+        return shutdownOutput(newFuture());
+    }
+
+    @Override
+    public ChannelFuture shutdownOutput(final ChannelFuture future) {
         EventLoop loop = eventLoop();
         if (loop.inEventLoop()) {
-            shutdownOutput(future);
+            try {
+                javaChannel().socket().shutdownOutput();
+                future.setSuccess();
+            } catch (Throwable t) {
+                future.setFailure(t);
+            }
         } else {
             loop.execute(new Runnable() {
                 @Override
@@ -124,15 +133,6 @@ public class NioSocketChannel extends AbstractNioByteChannel implements io.netty
         return future;
     }
 
-    private void shutdownOutput(ChannelFuture future) {
-        try {
-            javaChannel().socket().shutdownOutput();
-            future.setSuccess();
-        } catch (Throwable t) {
-            future.setFailure(t);
-        }
-    }
-
     @Override
     protected SocketAddress localAddress0() {
         return javaChannel().socket().getLocalSocketAddress();

transport/src/main/java/io/netty/channel/socket/oio/OioSctpChannel.java

@@ -254,12 +254,11 @@ public class OioSctpChannel extends AbstractOioMessageChannel
 
     @Override
     public ChannelFuture bindAddress(InetAddress localAddress) {
-        ChannelFuture future = newFuture();
+        return bindAddress(localAddress, newFuture());
-        doBindAddress(localAddress, future);
-        return future;
     }
 
-    void doBindAddress(final InetAddress localAddress, final ChannelFuture future) {
+    @Override
+    public ChannelFuture bindAddress(final InetAddress localAddress, final ChannelFuture future) {
         if (eventLoop().inEventLoop()) {
             try {
                 ch.bindAddress(localAddress);
@@ -271,20 +270,20 @@ public class OioSctpChannel extends AbstractOioMessageChannel
             eventLoop().execute(new Runnable() {
                 @Override
                 public void run() {
-                    doBindAddress(localAddress, future);
+                    bindAddress(localAddress, future);
                 }
             });
         }
+        return future;
     }
 
     @Override
     public ChannelFuture unbindAddress(InetAddress localAddress) {
-        ChannelFuture future = newFuture();
+        return unbindAddress(localAddress, newFuture());
-        doUnbindAddress(localAddress, future);
-        return future;
     }
 
-    void doUnbindAddress(final InetAddress localAddress, final ChannelFuture future) {
+    @Override
+    public ChannelFuture unbindAddress(final InetAddress localAddress, final ChannelFuture future) {
         if (eventLoop().inEventLoop()) {
             try {
                 ch.unbindAddress(localAddress);
@@ -296,9 +295,10 @@ public class OioSctpChannel extends AbstractOioMessageChannel
             eventLoop().execute(new Runnable() {
                 @Override
                 public void run() {
-                    doUnbindAddress(localAddress, future);
+                    unbindAddress(localAddress, future);
                 }
             });
         }
+        return future;
     }
 }

transport/src/main/java/io/netty/channel/socket/oio/OioSocketChannel.java

@@ -119,10 +119,19 @@ public class OioSocketChannel extends AbstractOioByteChannel
 
     @Override
     public ChannelFuture shutdownOutput() {
-        final ChannelFuture future = newFuture();
+        return shutdownOutput(newFuture());
+    }
+
+    @Override
+    public ChannelFuture shutdownOutput(final ChannelFuture future) {
         EventLoop loop = eventLoop();
         if (loop.inEventLoop()) {
-            shutdownOutput(future);
+            try {
+                socket.shutdownOutput();
+                future.setSuccess();
+            } catch (Throwable t) {
+                future.setFailure(t);
+            }
         } else {
             loop.execute(new Runnable() {
                 @Override
@@ -134,15 +143,6 @@ public class OioSocketChannel extends AbstractOioByteChannel
         return future;
     }
 
-    private void shutdownOutput(ChannelFuture future) {
-        try {
-            socket.shutdownOutput();
-            future.setSuccess();
-        } catch (Throwable t) {
-            future.setFailure(t);
-        }
-    }
-
     @Override
     protected SocketAddress localAddress0() {
         return socket.getLocalSocketAddress();