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

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 and 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 and Description
WebSocketServerProtocolHandler(String websocketPath)
WebSocketServerProtocolHandler(String websocketPath, boolean checkStartsWith)
WebSocketServerProtocolHandler(String websocketPath, String subprotocols)
WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions)
WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize)
WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch)
WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith)

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext ctx, WebSocketFrame frame, List<Object> out) Decode from one message to an other.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.

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

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, 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(String websocketPath)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(String websocketPath,
                                      boolean checkStartsWith)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(String websocketPath,
                                      String subprotocols)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(String websocketPath,
                                      String subprotocols,
                                      boolean allowExtensions)

WebSocketServerProtocolHandler

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

WebSocketServerProtocolHandler

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

WebSocketServerProtocolHandler

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

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,
                      List<Object> out)
               throws 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 encoder.

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:

Exception - is thrown if an error occurs

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                            Throwable cause)
                     throws 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:

Exception