io.netty.handler.codec.http.websocketx

Class WebSocketServerProtocolHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundMessageHandlerAdapter<WebSocketFrame>

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

All Implemented Interfaces:

ChannelHandler, ChannelHandlerUtil.SingleInboundMessageHandler<WebSocketFrame>, ChannelInboundMessageHandler<WebSocketFrame>, ChannelStateHandler

public class WebSocketServerProtocolHandler
extends ChannelInboundMessageHandlerAdapter<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.

Nested Class Summary

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

ChannelHandler.Sharable

Field Summary

Fields inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

ABORT

Constructor Summary

Constructors

Constructor and Description
WebSocketServerProtocolHandler(String websocketPath)
WebSocketServerProtocolHandler(String websocketPath, String subprotocols)
WebSocketServerProtocolHandler(String websocketPath, String subprotocols, boolean allowExtensions)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterAdd(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	messageReceived(ChannelHandlerContext ctx, WebSocketFrame frame) Is called once a message was received.

Methods inherited from class io.netty.channel.ChannelInboundMessageHandlerAdapter

acceptInboundMessage, beginMessageReceived, endMessageReceived, freeInboundBuffer, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

afterRemove, beforeAdd, beforeRemove

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

channelActive, channelInactive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

afterRemove, beforeAdd, beforeRemove

Constructor Detail

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(String websocketPath)

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(String websocketPath,
                              String subprotocols)

WebSocketServerProtocolHandler

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

Method Detail

afterAdd

public void afterAdd(ChannelHandlerContext ctx)

Description copied from class: ChannelHandlerAdapter

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

Specified by:

afterAdd in interface ChannelHandler

Overrides:

afterAdd in class ChannelHandlerAdapter

messageReceived

public void messageReceived(ChannelHandlerContext ctx,
                   WebSocketFrame frame)
                     throws Exception

Description copied from interface: ChannelHandlerUtil.SingleInboundMessageHandler

Is called once a message was received.

Parameters:

ctx - the ChannelHandlerContext which this ChannelHandler belongs to

frame - the message to handle

Throws:

Exception

exceptionCaught

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

Description copied from class: ChannelHandlerAdapter

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

Overrides:

exceptionCaught in class ChannelHandlerAdapter

Throws:

Exception