io.netty.handler.codec.http.websocketx

类 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

所有已实现的接口:

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

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	WebSocketServerProtocolHandler.ServerHandshakeStateEvent Events that are fired to notify about handshake status

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
WebSocketServerProtocolHandler(java.lang.String websocketPath)
WebSocketServerProtocolHandler(java.lang.String websocketPath, boolean checkStartsWith)
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)
WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean checkStartsWith)

方法概要

方法

限定符和类型	方法和说明
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.
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.

从类继承的方法 io.netty.handler.codec.MessageToMessageDecoder

acceptInboundMessage, channelRead

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelHandler

handlerRemoved

构造器详细资料

WebSocketServerProtocolHandler

public WebSocketServerProtocolHandler(java.lang.String websocketPath)

WebSocketServerProtocolHandler

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

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)

WebSocketServerProtocolHandler

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

方法详细资料

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)

从类复制的说明: ChannelHandlerAdapter

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

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

decode

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

从类复制的说明: MessageToMessageDecoder

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

参数:

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

抛出:

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

exceptionCaught

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

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

exceptionCaught 在接口中 ChannelHandler

指定者:

exceptionCaught 在接口中 ChannelInboundHandler

抛出:

java.lang.Exception