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

Class WebSocketServerProtocolHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class WebSocketServerProtocolHandler
extends MessageToMessageDecoder<WebSocketFrame>

This handler does all the heavy lifting for you to run a websocket server. It takes care of websocket handshaking as well as processing of control frames (Close, Ping, Pong). Text and Binary data frames are passed to the next handler in the pipeline (implemented by you) for processing. See io.netty.example.http.websocketx.html5.WebSocketServer for usage. The implementation of this handler assumes that you just want to run a websocket server and not process other types HTTP requests (like GET and POST). If you wish to support both HTTP requests and websockets in the one server, refer to the io.netty.example.http.websocketx.server.WebSocketServer example. To know once a handshake was done you can intercept the ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) and check if the event was instance of WebSocketServerProtocolHandler.HandshakeComplete, the event will contain extra information about the handshake such as the request and selected subprotocol.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSocketServerProtocolHandler.HandshakeComplete	The Handshake was completed successfully and the channel was upgraded to websockets.
static class	WebSocketServerProtocolHandler.ServerHandshakeStateEvent	Events that are fired to notify about handshake status

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
WebSocketServerProtocolHandler(WebSocketServerProtocolConfig serverConfig)	Base constructor
WebSocketServerProtocolHandler(java.lang.String websocketPath)
WebSocketServerProtocolHandler(java.lang.String websocketPath, boolean checkStartsWith)
WebSocketServerProtocolHandler(java.lang.String websocketPath, boolean checkStartsWith, long handshakeTimeoutMillis)
WebSocketServerProtocolHandler(java.lang.String websocketPath, long handshakeTimeoutMillis)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean checkStartsWith, boolean dropPongFrames, long handshakeTimeoutMillis, WebSocketDecoderConfig decoderConfig)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, boolean dropPongFrames)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, boolean dropPongFrames, long handshakeTimeoutMillis)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith, long handshakeTimeoutMillis)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, long handshakeTimeoutMillis)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, long handshakeTimeoutMillis)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, long handshakeTimeoutMillis)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, long handshakeTimeoutMillis)

Method Summary

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise)	Called once a bind operation is made.
protected WebSocketServerHandshakeException	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.
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	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	read(ChannelHandlerContext ctx)	Intercepts ChannelHandlerContext.read().
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, 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

Constructor Detail

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(WebSocketServerProtocolConfig serverConfig)

Base constructor

Parameters:

serverConfig - Server protocol configuration.

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      long handshakeTimeoutMillis)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      boolean checkStartsWith)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      boolean checkStartsWith,
                                      long handshakeTimeoutMillis)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      long handshakeTimeoutMillis)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      long handshakeTimeoutMillis)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      int maxFrameSize)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      int maxFrameSize,
                                      long handshakeTimeoutMillis)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      int maxFrameSize,
                                      boolean allowMaskMismatch)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      int maxFrameSize,
                                      boolean allowMaskMismatch,
                                      long handshakeTimeoutMillis)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      int maxFrameSize,
                                      boolean allowMaskMismatch,
                                      boolean checkStartsWith)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      int maxFrameSize,
                                      boolean allowMaskMismatch,
                                      boolean checkStartsWith,
                                      long handshakeTimeoutMillis)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      int maxFrameSize,
                                      boolean allowMaskMismatch,
                                      boolean checkStartsWith,
                                      boolean dropPongFrames)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean allowExtensions,
                                      int maxFrameSize,
                                      boolean allowMaskMismatch,
                                      boolean checkStartsWith,
                                      boolean dropPongFrames,
                                      long handshakeTimeoutMillis)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath,
                                      java.lang.String subprotocols,
                                      boolean checkStartsWith,
                                      boolean dropPongFrames,
                                      long handshakeTimeoutMillis,
                                      WebSocketDecoderConfig decoderConfig)

Method Detail

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)

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

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.

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

buildHandshakeException

protected WebSocketServerHandshakeException 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.

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

Throws:

java.lang.Exception

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

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

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