Constructor Detail

• WebSocketClientHandshaker13

  public WebSocketClientHandshaker13​(URI webSocketURL,
                                     String subprotocol,
                                     boolean allowExtensions,
                                     HttpHeaders customHeaders,
                                     int maxFramePayloadLength)

  Creates a new instance.

  Parameters:

  webSocketURL - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

  subprotocol - Sub protocol request sent to the server.

  allowExtensions - Allow extensions to be used in the reserved bits of the web socket frame

  customHeaders - Map of custom headers to add to the client request

  maxFramePayloadLength - Maximum length of a frame's payload

• WebSocketClientHandshaker13

  public WebSocketClientHandshaker13​(URI webSocketURL,
                                     String subprotocol,
                                     boolean allowExtensions,
                                     HttpHeaders customHeaders,
                                     int maxFramePayloadLength,
                                     boolean performMasking,
                                     boolean allowMaskMismatch)

  Creates a new instance.

  Parameters:

  webSocketURL - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

  subprotocol - Sub protocol request sent to the server.

  allowExtensions - Allow extensions to be used in the reserved bits of the web socket frame

  customHeaders - Map of custom headers to add to the client request

  maxFramePayloadLength - Maximum length of a frame's payload

  performMasking - Whether to mask all written websocket frames. This must be set to true in order to be fully compatible with the websocket specifications. Client applications that communicate with a non-standard server which doesn't require masking might set this to false to achieve a higher performance.

  allowMaskMismatch - When set to true, frames which are not masked properly according to the standard will still be accepted.

• WebSocketClientHandshaker13

  public WebSocketClientHandshaker13​(URI webSocketURL,
                                     String subprotocol,
                                     boolean allowExtensions,
                                     HttpHeaders customHeaders,
                                     int maxFramePayloadLength,
                                     boolean performMasking,
                                     boolean allowMaskMismatch,
                                     long forceCloseTimeoutMillis)

  Creates a new instance.

  Parameters:

  webSocketURL - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

  subprotocol - Sub protocol request sent to the server.

  allowExtensions - Allow extensions to be used in the reserved bits of the web socket frame

  customHeaders - Map of custom headers to add to the client request

  maxFramePayloadLength - Maximum length of a frame's payload

  performMasking - Whether to mask all written websocket frames. This must be set to true in order to be fully compatible with the websocket specifications. Client applications that communicate with a non-standard server which doesn't require masking might set this to false to achieve a higher performance.

  allowMaskMismatch - When set to true, frames which are not masked properly according to the standard will still be accepted

  forceCloseTimeoutMillis - Close the connection if it was not closed by the server after timeout specified.

Method Detail

• newHandshakeRequest

  protected FullHttpRequest newHandshakeRequest​(BufferAllocator allocator)

  /**

  Sends the opening request to the server:

   GET /chat HTTP/1.1
   Host: server.example.com
   Upgrade: websocket
   Connection: Upgrade
   Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
   Sec-WebSocket-Protocol: chat, superchat
   Sec-WebSocket-Version: 13
   

  Specified by:

  newHandshakeRequest in class WebSocketClientHandshaker

• verify

  protected void verify​(FullHttpResponse response)

  Process server response:

   HTTP/1.1 101 Switching Protocols
   Upgrade: websocket
   Connection: Upgrade
   Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
   Sec-WebSocket-Protocol: chat
   

  Specified by:

  verify in class WebSocketClientHandshaker

  Parameters:

  response - HTTP response returned from the server for the request sent by beginOpeningHandshake00().

  Throws:

  WebSocketHandshakeException - if handshake response is invalid.

• newWebsocketDecoder

  protected WebSocketFrameDecoder newWebsocketDecoder()

  Description copied from class: WebSocketClientHandshaker
  Returns the decoder to use after handshake is complete.

  Specified by:

  newWebsocketDecoder in class WebSocketClientHandshaker

• newWebSocketEncoder

  protected WebSocketFrameEncoder newWebSocketEncoder()

  Description copied from class: WebSocketClientHandshaker
  Returns the encoder to use after the handshake is complete.

  Specified by:

  newWebSocketEncoder in class WebSocketClientHandshaker

• setForceCloseTimeoutMillis

  public WebSocketClientHandshaker13 setForceCloseTimeoutMillis​(long forceCloseTimeoutMillis)

  Description copied from class: WebSocketClientHandshaker
  Sets timeout to close the connection if it was not closed by the server.

  Overrides:

  setForceCloseTimeoutMillis in class WebSocketClientHandshaker

  Parameters:

  forceCloseTimeoutMillis - Close the connection if it was not closed by the server after timeout specified