Class WebSocketClientProtocolHandshakeHandler
- java.lang.Object
-
- io.netty.channel.ChannelHandlerAdapter
-
- io.netty.channel.ChannelInboundHandlerAdapter
-
- io.netty.handler.codec.http.websocketx.WebSocketClientProtocolHandshakeHandler
-
- All Implemented Interfaces:
ChannelHandler
,ChannelInboundHandler
class WebSocketClientProtocolHandshakeHandler extends ChannelInboundHandlerAdapter
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
-
Field Summary
Fields Modifier and Type Field Description private ChannelHandlerContext
ctx
private static long
DEFAULT_HANDSHAKE_TIMEOUT_MS
private ChannelPromise
handshakePromise
private WebSocketClientHandshaker
handshaker
private long
handshakeTimeoutMillis
-
Constructor Summary
Constructors Constructor Description WebSocketClientProtocolHandshakeHandler(WebSocketClientHandshaker handshaker)
WebSocketClientProtocolHandshakeHandler(WebSocketClientHandshaker handshaker, long handshakeTimeoutMillis)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
applyHandshakeTimeout()
void
channelActive(ChannelHandlerContext ctx)
CallsChannelHandlerContext.fireChannelActive()
to forward to the nextChannelInboundHandler
in theChannelPipeline
.void
channelInactive(ChannelHandlerContext ctx)
CallsChannelHandlerContext.fireChannelInactive()
to forward to the nextChannelInboundHandler
in theChannelPipeline
.void
channelRead(ChannelHandlerContext ctx, java.lang.Object msg)
CallsChannelHandlerContext.fireChannelRead(Object)
to forward to the nextChannelInboundHandler
in theChannelPipeline
.(package private) ChannelFuture
getHandshakeFuture()
This method is visible for testing.void
handlerAdded(ChannelHandlerContext ctx)
Do nothing by default, sub-classes may override this method.-
Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered
-
Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerRemoved, isSharable
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.netty.channel.ChannelHandler
handlerRemoved
-
-
-
-
Field Detail
-
DEFAULT_HANDSHAKE_TIMEOUT_MS
private static final long DEFAULT_HANDSHAKE_TIMEOUT_MS
- See Also:
- Constant Field Values
-
handshaker
private final WebSocketClientHandshaker handshaker
-
handshakeTimeoutMillis
private final long handshakeTimeoutMillis
-
ctx
private ChannelHandlerContext ctx
-
handshakePromise
private ChannelPromise handshakePromise
-
-
Constructor Detail
-
WebSocketClientProtocolHandshakeHandler
WebSocketClientProtocolHandshakeHandler(WebSocketClientHandshaker handshaker)
-
WebSocketClientProtocolHandshakeHandler
WebSocketClientProtocolHandshakeHandler(WebSocketClientHandshaker handshaker, long handshakeTimeoutMillis)
-
-
Method Detail
-
handlerAdded
public void handlerAdded(ChannelHandlerContext ctx) throws java.lang.Exception
Description copied from class:ChannelHandlerAdapter
Do nothing by default, sub-classes may override this method.- Specified by:
handlerAdded
in interfaceChannelHandler
- Overrides:
handlerAdded
in classChannelHandlerAdapter
- Throws:
java.lang.Exception
-
channelActive
public void channelActive(ChannelHandlerContext ctx) throws java.lang.Exception
Description copied from class:ChannelInboundHandlerAdapter
CallsChannelHandlerContext.fireChannelActive()
to forward to the nextChannelInboundHandler
in theChannelPipeline
. Sub-classes may override this method to change behavior.- Specified by:
channelActive
in interfaceChannelInboundHandler
- Overrides:
channelActive
in classChannelInboundHandlerAdapter
- Throws:
java.lang.Exception
-
channelInactive
public void channelInactive(ChannelHandlerContext ctx) throws java.lang.Exception
Description copied from class:ChannelInboundHandlerAdapter
CallsChannelHandlerContext.fireChannelInactive()
to forward to the nextChannelInboundHandler
in theChannelPipeline
. Sub-classes may override this method to change behavior.- Specified by:
channelInactive
in interfaceChannelInboundHandler
- Overrides:
channelInactive
in classChannelInboundHandlerAdapter
- Throws:
java.lang.Exception
-
channelRead
public void channelRead(ChannelHandlerContext ctx, java.lang.Object msg) throws java.lang.Exception
Description copied from class:ChannelInboundHandlerAdapter
CallsChannelHandlerContext.fireChannelRead(Object)
to forward to the nextChannelInboundHandler
in theChannelPipeline
. Sub-classes may override this method to change behavior.- Specified by:
channelRead
in interfaceChannelInboundHandler
- Overrides:
channelRead
in classChannelInboundHandlerAdapter
- Throws:
java.lang.Exception
-
applyHandshakeTimeout
private void applyHandshakeTimeout()
-
getHandshakeFuture
ChannelFuture getHandshakeFuture()
This method is visible for testing.- Returns:
- current handshake future
-
-