diff --git a/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshaker.java b/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshaker.java index 1d7b2d24c5..5844c24ced 100644 --- a/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshaker.java +++ b/codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerHandshaker.java @@ -123,12 +123,15 @@ public abstract class WebSocketServerHandshaker { } /** - * Performs the opening handshake + * Performs the opening handshake. When call this method you MUST NOT retain the + * {@link FullHttpRequest} which is passed in. * * @param channel - * Channel + * Channel * @param req - * HTTP Request + * HTTP Request + * @return future + * The {@link ChannelFuture} which is notified once the opening handshake completes */ public ChannelFuture handshake(Channel channel, FullHttpRequest req) { return handshake(channel, req, null, channel.newPromise()); @@ -137,6 +140,8 @@ public abstract class WebSocketServerHandshaker { /** * Performs the opening handshake * + * When call this method you MUST NOT retain the {@link FullHttpRequest} which is passed in. + * * @param channel * Channel * @param req @@ -145,6 +150,8 @@ public abstract class WebSocketServerHandshaker { * Extra headers to add to the handshake response or {@code null} if no extra headers should be added * @param promise * the {@link ChannelPromise} to be notified when the opening handshake is done + * @return future + * the {@link ChannelFuture} which is notified when the opening handshake is done */ public final ChannelFuture handshake(Channel channel, FullHttpRequest req, HttpHeaders responseHeaders, final ChannelPromise promise) {