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 ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private ChannelHandlerContext	ctx
private static final long	DEFAULT_HANDSHAKE_TIMEOUT_MS
private ChannelPromise	handshakePromise
private final WebSocketClientHandshaker	handshaker
private final long	handshakeTimeoutMillis

Constructor Summary

Constructors

Constructor	Description
WebSocketClientProtocolHandshakeHandler(WebSocketClientHandshaker handshaker)
WebSocketClientProtocolHandshakeHandler(WebSocketClientHandshaker handshaker, long handshakeTimeoutMillis)

Method Summary

Modifier and Type	Method	Description
private void	applyHandshakeTimeout()
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
(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 ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ChannelHandler

handlerRemoved

Field Details

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 Details

WebSocketClientProtocolHandshakeHandler

WebSocketClientProtocolHandshakeHandler(WebSocketClientHandshaker handshaker)

WebSocketClientProtocolHandshakeHandler

WebSocketClientProtocolHandshakeHandler(WebSocketClientHandshaker handshaker,
 long handshakeTimeoutMillis)

Method Details

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelActive in interface ChannelInboundHandler

Overrides:

channelActive in class ChannelInboundHandlerAdapter

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ChannelInboundHandlerAdapter

Throws:

Exception

channelRead

public void channelRead(ChannelHandlerContext ctx,
 Object msg)
                 throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelRead in interface ChannelInboundHandler

Overrides:

channelRead in class ChannelInboundHandlerAdapter

Throws:

Exception

applyHandshakeTimeout

private void applyHandshakeTimeout()

getHandshakeFuture

ChannelFuture getHandshakeFuture()

This method is visible for testing.

Returns:

current handshake future