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.WebSocketProtocolHandler

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

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class WebSocketServerProtocolHandler
extends WebSocketProtocolHandler

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 of type WebSocketServerProtocolHandler.ServerHandshakeStateEvent.HANDSHAKE_COMPLETE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowExtensions
private static AttributeKey<WebSocketServerHandshaker>	HANDSHAKER_ATTR_KEY
private int	maxFramePayloadLength
private java.lang.String	subprotocols
private java.lang.String	websocketPath

Constructor Summary

Constructors

Constructor and Description
WebSocketServerProtocolHandler(java.lang.String websocketPath)
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 allowExtensions, int maxFrameSize)

Method Summary

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext ctx, WebSocketFrame frame, java.util.List<java.lang.Object> out) Decode from one message to an other.
void	exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
(package private) static ChannelHandler	forbiddenHttpRequestResponder()
(package private) static WebSocketServerHandshaker	getHandshaker(Channel channel)
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
(package private) static void	setHandshaker(Channel channel, WebSocketServerHandshaker handshaker)

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

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

HANDSHAKER_ATTR_KEY

private static final AttributeKey<WebSocketServerHandshaker> HANDSHAKER_ATTR_KEY

websocketPath

private final java.lang.String websocketPath

subprotocols

private final java.lang.String subprotocols

allowExtensions

private final boolean allowExtensions

maxFramePayloadLength

private final int maxFramePayloadLength

Constructor Detail

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath)

WebSocketServerProtocolHandler

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

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,
                                      int maxFrameSize)

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 encoder.

Overrides:

decode in class WebSocketProtocolHandler

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 accour

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 WebSocketProtocolHandler

Throws:

java.lang.Exception

getHandshaker

static WebSocketServerHandshaker getHandshaker(Channel channel)

setHandshaker

static void setHandshaker(Channel channel,
                          WebSocketServerHandshaker handshaker)

forbiddenHttpRequestResponder

static ChannelHandler forbiddenHttpRequestResponder()