字段详细信息

• customHeaders

  protected final HttpHeaders customHeaders

构造方法详细信息

• WebSocketClientHandshaker

  protected WebSocketClientHandshaker(java.net.URI uri,
                                      WebSocketVersion version,
                                      java.lang.String subprotocol,
                                      HttpHeaders customHeaders,
                                      int maxFramePayloadLength)

  基础构造函数

  参数

  uri - Web套接字通信的URL。 例如“ws：//myhost.com/mypath”。 后续的网络套接字帧将被发送到这个URL。

  version - 用于连接到服务器的Web套接字规范的版本

  subprotocol - 发送到服务器的子协议请求。

  customHeaders - 要添加到客户端请求的自定义标头的映射

  maxFramePayloadLength - 帧有效负载的最大长度

方法详细信息

• uri

  public java.net.URI uri()

  返回网络套接字的URI。 例如“ws：//myhost.com/path”

• version

  public WebSocketVersion version()

  正在使用的Web套接字规范的版本

• maxFramePayloadLength

  public int maxFramePayloadLength()

  返回任何帧的有效载荷的最大长度

• isHandshakeComplete

  public boolean isHandshakeComplete()

  标记以指示开始握手是否完成

• expectedSubprotocol

  public java.lang.String expectedSubprotocol()

  按照构造函数中的指定返回发送到服务器的请求的子协议的CSV

• actualSubprotocol

  public java.lang.String actualSubprotocol()

  返回服务器发送的子协议响应。 只有在握手结束后才可用。 如果服务器没有请求或确认子协议，则为空。

• handshake

  public ChannelFuture handshake(Channel channel)

  开始握手

  参数

  channel - 频道

• handshake

  public final ChannelFuture handshake(Channel channel,
                                       ChannelPromise promise)

  开始握手

  参数

  channel - 频道

  promise - ChannelPromise在开始握手时发送通知

• newHandshakeRequest

  protected abstract FullHttpRequest newHandshakeRequest()

  返回将用于握手的新的{@link FullHttpRequest）。

• finishHandshake

  public final void finishHandshake(Channel channel,
                                    FullHttpResponse response)

  验证并完成由 handshake(io.netty.channel.Channel) }发起的开放握手。

  参数

  channel - 频道

  response - 包含关闭握手细节的HTTP响应

• processHandshake

  public final ChannelFuture processHandshake(Channel channel,
                                              HttpResponse response)

  处理由 handshake(io.netty.channel.Channel) }发起的开放握手。

  参数

  channel - 频道

  response - 包含关闭握手细节的HTTP响应

  结果

  未来ChannelFuture一旦握手完成就会收到通知。

• processHandshake

  public final ChannelFuture processHandshake(Channel channel,
                                              HttpResponse response,
                                              ChannelPromise promise)

  处理由 handshake(io.netty.channel.Channel) }发起的开放握手。

  参数

  channel - 频道

  response - 包含关闭握手细节的HTTP响应

  promise - 在握手完成后通知ChannelPromise 。

  结果

  未来ChannelFuture一旦握手完成就会收到通知。

• verify

  protected abstract void verify(FullHttpResponse response)

  验证FullHttpResponse并在出现问题时抛出WebSocketHandshakeException 。

• newWebsocketDecoder

  protected abstract WebSocketFrameDecoder newWebsocketDecoder()

  返回握手完成后使用的解码器。

• newWebSocketEncoder

  protected abstract WebSocketFrameEncoder newWebSocketEncoder()

  返回握手完成后使用的编码器。

• close

  public ChannelFuture close(Channel channel,
                             CloseWebSocketFrame frame)

  执行关闭握手

  参数

  channel - 频道

  frame - 已收到的关闭帧

• close

  public ChannelFuture close(Channel channel,
                             CloseWebSocketFrame frame,
                             ChannelPromise promise)

  执行关闭握手

  参数

  channel - 频道

  frame - 收到已收到的帧

  promise - ChannelPromise关闭握手完成时通知