Package io.netty.handler.codec.http.websocketx

Class WebSocketProtocolHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<WebSocketFrame>

io.netty.handler.codec.http.websocketx.WebSocketProtocolHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

Direct Known Subclasses:

WebSocketClientProtocolHandler, WebSocketServerProtocolHandler

abstract class WebSocketProtocolHandler
extends MessageToMessageDecoder<WebSocketFrame>
implements ChannelOutboundHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private ChannelPromise	closeSent
private WebSocketCloseStatus	closeStatus
private boolean	dropPongFrames
private long	forceCloseTimeoutMillis
private Future<?>	forceCloseTimeoutTask

Constructor Summary

Constructors

Constructor	Description
WebSocketProtocolHandler()	Creates a new WebSocketProtocolHandler that will drop PongWebSocketFrames.
WebSocketProtocolHandler(boolean dropPongFrames)	Creates a new WebSocketProtocolHandler, given a parameter that determines whether or not to drop PongWebSocketFrames.
WebSocketProtocolHandler(boolean dropPongFrames, WebSocketCloseStatus closeStatus, long forceCloseTimeoutMillis)

Method Summary

Modifier and Type	Method	Description
(package private) void	applyCloseSentTimeout(ChannelHandlerContext ctx)
void	bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise)	Called once a bind operation is made.
protected WebSocketHandshakeException	buildHandshakeException(java.lang.String message)	Returns a WebSocketHandshakeException that depends on which client or server pipeline this handler belongs.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a close operation is made.
(package private) void	closeSent(ChannelPromise promise)	Records the ChannelPromise used to write the outgoing close frame.
void	connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)	Called once a connect operation is made.
protected void	decode(ChannelHandlerContext ctx, WebSocketFrame frame, java.util.List<java.lang.Object> out)	Decode from one message to an other.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a deregister operation is made from the current registered EventLoop.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a disconnect operation is made.
void	exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx)	Called once a flush operation is made.
void	read(ChannelHandlerContext ctx)	Intercepts ChannelHandlerContext.read().
private static void	readIfNeeded(ChannelHandlerContext ctx)
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)	Called once a write operation is made.

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

acceptInboundMessage, channelRead, channelReadComplete

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, 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

handlerAdded, handlerRemoved

Field Detail

dropPongFrames

private final boolean dropPongFrames

closeStatus

private final WebSocketCloseStatus closeStatus

forceCloseTimeoutMillis

private final long forceCloseTimeoutMillis

closeSent

private ChannelPromise closeSent

forceCloseTimeoutTask

private Future<?> forceCloseTimeoutTask

Constructor Detail

WebSocketProtocolHandler

WebSocketProtocolHandler()

Creates a new WebSocketProtocolHandler that will drop PongWebSocketFrames.

WebSocketProtocolHandler

WebSocketProtocolHandler(boolean dropPongFrames)

Creates a new WebSocketProtocolHandler, given a parameter that determines whether or not to drop PongWebSocketFrames.

Parameters:

dropPongFrames - true if PongWebSocketFrames should be dropped

WebSocketProtocolHandler

WebSocketProtocolHandler(boolean dropPongFrames,
                         WebSocketCloseStatus closeStatus,
                         long forceCloseTimeoutMillis)

Method Detail

decode

protected void decode(ChannelHandlerContext ctx,
                      WebSocketFrame frame,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception

Description copied from class: MessageToMessageDecoder

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

Specified by:

decode in class MessageToMessageDecoder<WebSocketFrame>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

frame - the message to decode to an other one

out - the List to which decoded messages should be added

Throws:

java.lang.Exception - is thrown if an error occurs

readIfNeeded

private static void readIfNeeded(ChannelHandlerContext ctx)

close

public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception

Description copied from interface: ChannelOutboundHandler

Called once a close operation is made.

Specified by:

close in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

write

public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception

Description copied from interface: ChannelOutboundHandler

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel.flush() is called

Specified by:

write in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

flush

public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception

Description copied from interface: ChannelOutboundHandler

Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.

Specified by:

flush in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made

Throws:

java.lang.Exception - thrown if an error occurs

closeSent

void closeSent(ChannelPromise promise)

Records the ChannelPromise used to write the outgoing close frame. Every code path that initiates the close handshake must call this, and must subsequently give applyCloseSentTimeout(ChannelHandlerContext) a chance to run (directly, or indirectly via flush(ChannelHandlerContext)) so the channel is guaranteed to close even if the outbound write never completes (e.g. the peer stops reading and the socket send buffer fills up).

applyCloseSentTimeout

void applyCloseSentTimeout(ChannelHandlerContext ctx)

buildHandshakeException

protected WebSocketHandshakeException buildHandshakeException(java.lang.String message)

Returns a WebSocketHandshakeException that depends on which client or server pipeline this handler belongs. Should be overridden in implementation otherwise a default exception is used.

bind

public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception

Description copied from interface: ChannelOutboundHandler

Called once a bind operation is made.

Specified by:

bind in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the bind operation is made

localAddress - the SocketAddress to which it should bound

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

connect

public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception

Description copied from interface: ChannelOutboundHandler

Called once a connect operation is made.

Specified by:

connect in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the connect operation is made

remoteAddress - the SocketAddress to which it should connect

localAddress - the SocketAddress which is used as source on connect

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

disconnect

public void disconnect(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception

Description copied from interface: ChannelOutboundHandler

Called once a disconnect operation is made.

Specified by:

disconnect in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the disconnect operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

deregister

public void deregister(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception

Description copied from interface: ChannelOutboundHandler

Called once a deregister operation is made from the current registered EventLoop.

Specified by:

deregister in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

java.lang.Exception - thrown if an error occurs

read

public void read(ChannelHandlerContext ctx)
          throws java.lang.Exception

Description copied from interface: ChannelOutboundHandler

Intercepts ChannelHandlerContext.read().

Specified by:

read in interface ChannelOutboundHandler

Throws:

java.lang.Exception

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

exceptionCaught in interface ChannelHandler

Specified by:

exceptionCaught in interface ChannelInboundHandler

Overrides:

exceptionCaught in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception