WebSocketServerProtocolHandler (Netty API Reference (4.1.22.Final))

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>
```
这个处理程序为你运行一个websocket服务器做了所有繁重的工作。它负责websocket握手以及控制框架的处理（Close，Ping，Pong）。文本和二进制数据帧被传递到管道中的下一个处理程序（由您执行）进行处理。请参阅io.netty.example.http.websocketx.html5.WebSocketServer的使用说明。这个处理程序的实现假定你只是想运行一个websocket服务器而不处理其他类型的HTTP请求（如GET和POST）。如果您希望在一台服务器中同时支持HTTP请求和websocket，请参阅io.netty.example.http.websocketx.server.WebSocketServer示例。要知道一旦握手完成，您可以拦截ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)并检查事件是否为WebSocketServerProtocolHandler.HandshakeComplete的实例，该事件将包含有关握手的额外信息，例如请求和所选的子协议。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebSocketServerProtocolHandler.HandshakeComplete` 握手成功完成，频道升级为网络套接字。
`static class`	`WebSocketServerProtocolHandler.ServerHandshakeStateEvent` 为了通知握手状态而触发的事件

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

构造方法摘要

构造方法
Constructor and Description
`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 allowMaskMismatch)`
`WebSocketServerProtocolHandler(java.lang.String websocketPath, java.lang.String subprotocols, boolean allowExtensions, int maxFrameSize, boolean allowMaskMismatch, boolean checkStartsWith)`

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected void`	`decode(ChannelHandlerContext ctx, WebSocketFrame frame, java.util.List<java.lang.Object> out)` 从一条消息解码到另一条消息。
`void`	`exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause)` 致电`ChannelHandlerContext.fireExceptionCaught(Throwable)`转发到`ChannelPipeline`中的下一个`ChannelHandler` 。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。

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

构造方法详细信息

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 allowMaskMismatch)

WebSocketServerProtocolHandler

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

方法详细信息
- handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
```
  从类复制的描述： ChannelHandlerAdapter
  
  子类可以忽略这个方法。
  
  Specified by:
  
  handlerAdded在界面 ChannelHandler
  
  重写：
  
  handlerAdded ChannelHandlerAdapter
- decode
```
protected void decode(ChannelHandlerContext ctx,
                      WebSocketFrame frame,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
  从类复制的描述： MessageToMessageDecoder
  
  从一条消息解码到另一条消息。这个方法将被编码器处理的每个书面信息调用。
  
  参数
  
  ctx - 这MessageToMessageDecoder属于的ChannelHandlerContext
  
  frame - 解码到另一个的消息
  
  out - 应该添加解码消息的 List
  
  异常
  
  java.lang.Exception - 发生错误时抛出
- exceptionCaught
```
public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception
```
  从类复制的描述： ChannelInboundHandlerAdapter
  
  致电ChannelHandlerContext.fireExceptionCaught(Throwable)转发至ChannelPipeline中的下一个ChannelHandler 。子类可以重写此方法来更改行为。
  
  Specified by:
  
  exceptionCaught接口 ChannelHandler
  
  Specified by:
  
  exceptionCaught在界面 ChannelInboundHandler
  
  异常
  
  java.lang.Exception

Class WebSocketServerProtocolHandler

Nested Class Summary

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

构造方法摘要

方法摘要

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

WebSocketServerProtocolHandler

WebSocketServerProtocolHandler

WebSocketServerProtocolHandler

WebSocketServerProtocolHandler

WebSocketServerProtocolHandler

WebSocketServerProtocolHandler

WebSocketServerProtocolHandler

方法详细信息

handlerAdded

decode

exceptionCaught