字段详细信息

• logger

  protected static final io.netty.util.internal.logging.InternalLogger logger

• SUB_PROTOCOL_WILDCARD

  public static final java.lang.String SUB_PROTOCOL_WILDCARD

  将其用作通配符来支持所有请求的子协议

  另请参见：

  Constant Field Values

构造方法详细信息

• WebSocketServerHandshaker

  protected WebSocketServerHandshaker(WebSocketVersion version,
                                      java.lang.String uri,
                                      java.lang.String subprotocols,
                                      int maxFramePayloadLength)

  指定目标Web套接字位置的构造函数

  参数

  version - 协议版本

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

  subprotocols - 支持的协议的CSV。 如果不支持子协议，则为空。

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

方法详细信息

• uri

  public java.lang.String uri()

  返回Web套接字的URL

• subprotocols

  public java.util.Set<java.lang.String> subprotocols()

  返回支持的子协议的CSV

• version

  public WebSocketVersion version()

  返回支持的规范版本

• maxFramePayloadLength

  public int maxFramePayloadLength()

  获取任何帧的有效载荷的最大长度。

  结果

  帧有效负载的最大长度

• handshake

  public ChannelFuture handshake(Channel channel,
                                 FullHttpRequest req)

  执行开始握手。 当调用这个方法时，你不能保留传入的FullHttpRequest 。

  参数

  channel - 频道

  req - HTTP请求

  结果

  未来开放握手完成后通知的ChannelFuture

• handshake

  public final ChannelFuture handshake(Channel channel,
                                       FullHttpRequest req,
                                       HttpHeaders responseHeaders,
                                       ChannelPromise promise)

  执行打开握手当调用此方法必须不保留FullHttpRequest这是在过去。

  参数

  channel - 频道

  req - HTTP请求

  responseHeaders - 额外的头添加到握手响应或 null如果没有额外的头应该被添加

  promise - ChannelPromise在开放握手完成时通知

  结果

  未来ChannelFuture这是开放握手完成时通知

• handshake

  public ChannelFuture handshake(Channel channel,
                                 HttpRequest req)

  执行开始握手。 当调用这个方法时，你不能保留传入的FullHttpRequest 。

  参数

  channel - 频道

  req - HTTP请求

  结果

  未来开放握手完成后通知的ChannelFuture

• handshake

  public final ChannelFuture handshake(Channel channel,
                                       HttpRequest req,
                                       HttpHeaders responseHeaders,
                                       ChannelPromise promise)

  执行打开握手当调用此方法时，您不能保留传入的HttpRequest 。

  参数

  channel - 频道

  req - HTTP请求

  responseHeaders - 额外的头添加到握手响应或 null如果没有额外的头应该被添加

  promise - ChannelPromise在开始握手完成时通知

  结果

  未来ChannelFuture ，当开放握手完成时通知

• newHandshakeResponse

  protected abstract FullHttpResponse newHandshakeResponse(FullHttpRequest req,
                                                           HttpHeaders responseHeaders)

  返回将用于响应握手请求的新{@link FullHttpResponse）。

• close

  public ChannelFuture close(Channel channel,
                             CloseWebSocketFrame frame)

  执行关闭握手

  参数

  channel - 频道

  frame - 收到已收到的帧

• close

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

  执行关闭握手

  参数

  channel - 频道

  frame - 已收到关闭帧

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

• selectSubprotocol

  protected java.lang.String selectSubprotocol(java.lang.String requestedSubprotocols)

  选择第一个匹配的支持的子协议

  参数

  requestedSubprotocols - 要支持的协议的CSV。 例如“聊天，超级聊天”

  结果

  首先匹配支持的子协议。 如果找不到，则为空。

• selectedSubprotocol

  public java.lang.String selectedSubprotocol()

  返回选定的子协议。 如果没有选择子协议，则为空。

  这仅在调用handshake()后才可用。

• newWebsocketDecoder

  protected abstract WebSocketFrameDecoder newWebsocketDecoder()

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

• newWebSocketEncoder

  protected abstract WebSocketFrameEncoder newWebSocketEncoder()

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