WebSocketClientProtocolHandler (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.WebSocketClientProtocolHandler

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler
```
public class WebSocketClientProtocolHandler
extends MessageToMessageDecoder<WebSocketFrame>
```
这个处理程序为你运行一个websocket客户端做了所有繁重的工作。它负责websocket握手以及Ping，Pong框架的处理。文本和二进制数据帧被传递到管道中的下一个处理程序（由您执行）进行处理。如果handleCloseFrames为false ，则关闭连接之前，您可能需要检查该连接， handleCloseFrames该关闭帧传递给下一个处理程序，默认值为true 。一旦与远程服务器的连接完成，此实现将建立websocket连接。要知道一旦握手完成，您可以拦截ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)并检查事件是WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_ISSUED还是WebSocketClientProtocolHandler.ClientHandshakeStateEvent.HANDSHAKE_COMPLETE 。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebSocketClientProtocolHandler.ClientHandshakeStateEvent` 为了通知握手状态而触发的事件

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

构造方法摘要

构造方法
Constructor and Description
`WebSocketClientProtocolHandler(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength)` 基础构造函数
`WebSocketClientProtocolHandler(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames)` 基础构造函数
`WebSocketClientProtocolHandler(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean handleCloseFrames, boolean performMasking, boolean allowMaskMismatch)` 基础构造函数
`WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker)` 基础构造函数
`WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker, boolean handleCloseFrames)` 基础构造函数

方法摘要

所有方法接口方法具体的方法
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)` 子类可以忽略这个方法。
`WebSocketClientHandshaker`	`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
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

- 构造方法详细信息
  - WebSocketClientProtocolHandler
```
public WebSocketClientProtocolHandler(java.net.URI webSocketURL,
                                      WebSocketVersion version,
                                      java.lang.String subprotocol,
                                      boolean allowExtensions,
                                      HttpHeaders customHeaders,
                                      int maxFramePayloadLength,
                                      boolean handleCloseFrames,
                                      boolean performMasking,
                                      boolean allowMaskMismatch)
```
    基础构造函数
    
    参数
    
    webSocketURL - 网络套接字通信的URL。例如“ws：//myhost.com/mypath”。后续的网络套接字帧将被发送到这个URL。
    
    version - 用于连接到服务器的Web套接字规范的版本
    
    subprotocol - 发送到服务器的子协议请求。
    
    customHeaders - 要添加到客户端请求的自定义标头的映射
    
    maxFramePayloadLength - 帧有效负载的最大长度
    
    handleCloseFrames - true如果不应该转发关闭帧并关闭频道
    
    performMasking - 是否屏蔽所有书写的websocket框架。这必须设置为true才能完全兼容websocket规范。与不需要屏蔽的非标准服务器通信的客户端应用程序可能会将其设置为false以实现更高的性能。
    
    allowMaskMismatch - 设置为true时，仍然会接受根据标准未正确屏蔽的帧。
  - WebSocketClientProtocolHandler
```
public WebSocketClientProtocolHandler(java.net.URI webSocketURL,
                                      WebSocketVersion version,
                                      java.lang.String subprotocol,
                                      boolean allowExtensions,
                                      HttpHeaders customHeaders,
                                      int maxFramePayloadLength,
                                      boolean handleCloseFrames)
```
    基础构造函数
    
    参数
    
    webSocketURL - 网络套接字通信的URL。例如“ws：//myhost.com/mypath”。后续的网络套接字帧将被发送到这个URL。
    
    version - 用于连接到服务器的Web套接字规范的版本
    
    subprotocol - 发送到服务器的子协议请求。
    
    customHeaders - 要添加到客户端请求的自定义标头的映射
    
    maxFramePayloadLength - 帧有效负载的最大长度
    
    handleCloseFrames - true如果不应转发关闭帧并关闭频道
  - WebSocketClientProtocolHandler
```
public WebSocketClientProtocolHandler(java.net.URI webSocketURL,
                                      WebSocketVersion version,
                                      java.lang.String subprotocol,
                                      boolean allowExtensions,
                                      HttpHeaders customHeaders,
                                      int maxFramePayloadLength)
```
    基础构造函数
    
    参数
    
    webSocketURL - Web套接字通信的URL。例如“ws：//myhost.com/mypath”。后续的网络套接字帧将被发送到这个URL。
    
    version - 用于连接到服务器的Web套接字规范的版本
    
    subprotocol - 发送到服务器的子协议请求。
    
    customHeaders - 要添加到客户端请求的自定义标头的映射
    
    maxFramePayloadLength - 帧有效负载的最大长度
  - WebSocketClientProtocolHandler
```
public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker,
                                      boolean handleCloseFrames)
```
    基础构造函数
    
    参数
    
    handshaker - WebSocketClientHandshaker一旦连接建立到远端，将用于发起握手。
    
    handleCloseFrames - true如果不应转发关闭帧并关闭频道
  - WebSocketClientProtocolHandler
```
public WebSocketClientProtocolHandler(WebSocketClientHandshaker handshaker)
```
    基础构造函数
    
    参数
    
    handshaker - WebSocketClientHandshaker一旦连接建立到远端，将用于发出握手。
- 方法详细信息
  - handshaker
```
public WebSocketClientHandshaker handshaker()
```
    返回使用过的握手
  - 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 - 如果发生错误则抛出
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded在界面 ChannelHandler
    
    重写：
    
    handlerAdded在课堂上 ChannelHandlerAdapter
  - 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
    
    重写：
    
    exceptionCaught ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception

Class WebSocketClientProtocolHandler

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

构造方法详细信息

WebSocketClientProtocolHandler

WebSocketClientProtocolHandler

WebSocketClientProtocolHandler

WebSocketClientProtocolHandler

WebSocketClientProtocolHandler

方法详细信息

handshaker

decode

handlerAdded

exceptionCaught