Direct Known Subclasses:

WebSocketClientHandshaker00, WebSocketClientHandshaker07, WebSocketClientHandshaker08, WebSocketClientHandshaker13

public abstract class WebSocketClientHandshaker
extends java.lang.Object

• Field Summary

  Fields

  Modifier and Type	Field and Description
  protected HttpHeaders	customHeaders

• Constructor Summary

  Constructors

  Modifier	Constructor and Description
  protected	WebSocketClientHandshaker (java.net.URI uri, WebSocketVersion version, java.lang.String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength) Base constructor

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  java.lang.String	actualSubprotocol () Returns the subprotocol response sent by the server.
  ChannelFuture	close (Channel channel, CloseWebSocketFrame frame) Performs the closing handshake
  ChannelFuture	close (Channel channel, CloseWebSocketFrame frame, ChannelPromise promise) Performs the closing handshake
  java.lang.String	expectedSubprotocol () Returns the CSV of requested subprotocol(s) sent to the server as specified in the constructor
  void	finishHandshake (Channel channel, FullHttpResponse response) Validates and finishes the opening handshake initiated by handshake(io.netty.channel.Channel)}.
  ChannelFuture	handshake (Channel channel) Begins the opening handshake
  ChannelFuture	handshake (Channel channel, ChannelPromise promise) Begins the opening handshake
  boolean	isHandshakeComplete () Flag to indicate if the opening handshake is complete
  int	maxFramePayloadLength () Returns the max length for any frame's payload
  protected abstract FullHttpRequest	newHandshakeRequest () Returns a new {@link FullHttpRequest) which will be used for the handshake.
  protected abstract WebSocketFrameDecoder	newWebsocketDecoder () Returns the decoder to use after handshake is complete.
  protected abstract WebSocketFrameEncoder	newWebSocketEncoder () Returns the encoder to use after the handshake is complete.
  ChannelFuture	processHandshake (Channel channel, HttpResponse response) Process the opening handshake initiated by handshake(io.netty.channel.Channel)}.
  ChannelFuture	processHandshake (Channel channel, HttpResponse response, ChannelPromise promise) Process the opening handshake initiated by handshake(io.netty.channel.Channel)}.
  java.net.URI	uri () Returns the URI to the web socket. e.g.
  protected abstract void	verify (FullHttpResponse response) Verify the FullHttpResponse and throws a WebSocketHandshakeException if something is wrong.
  WebSocketVersion	version () Version of the web socket specification that is being used

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Field Detail

  • customHeaders

    protected final HttpHeaders customHeaders

• Constructor Detail

  • WebSocketClientHandshaker

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

    Base constructor

    Parameters:

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

    version - Version of web socket specification to use to connect to the server

    subprotocol - Sub protocol request sent to the server.

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

    maxFramePayloadLength - Maximum length of a frame's payload

• Method Detail

  • uri

    public java.net.URI uri()

    Returns the URI to the web socket. e.g. "ws://myhost.com/path"

  • version

    public WebSocketVersion version()

    Version of the web socket specification that is being used

  • maxFramePayloadLength

    public int maxFramePayloadLength()

    Returns the max length for any frame's payload

  • isHandshakeComplete

    public boolean isHandshakeComplete()

    Flag to indicate if the opening handshake is complete

  • expectedSubprotocol

    public java.lang.String expectedSubprotocol()

    Returns the CSV of requested subprotocol(s) sent to the server as specified in the constructor

  • actualSubprotocol

    public java.lang.String actualSubprotocol()

    Returns the subprotocol response sent by the server. Only available after end of handshake. Null if no subprotocol was requested or confirmed by the server.

  • handshake

    public ChannelFuture handshake(Channel channel)

    Begins the opening handshake

    Parameters:

    channel - Channel

  • handshake

    public final ChannelFuture handshake(Channel channel,
     ChannelPromise promise)

    Begins the opening handshake

    Parameters:

    channel - Channel

    promise - the ChannelPromise to be notified when the opening handshake is sent

  • newHandshakeRequest

    protected abstract FullHttpRequest newHandshakeRequest()

    Returns a new {@link FullHttpRequest) which will be used for the handshake.

  • finishHandshake

    public final void finishHandshake(Channel channel,
     FullHttpResponse response)

    Validates and finishes the opening handshake initiated by handshake(io.netty.channel.Channel)}.

    Parameters:

    channel - Channel

    response - HTTP response containing the closing handshake details

  • processHandshake

    public final ChannelFuture processHandshake(Channel channel,
     HttpResponse response)

    Process the opening handshake initiated by handshake(io.netty.channel.Channel)}.

    Parameters:

    channel - Channel

    response - HTTP response containing the closing handshake details

    Returns:

    future the ChannelFuture which is notified once the handshake completes.

  • processHandshake

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

    Process the opening handshake initiated by handshake(io.netty.channel.Channel)}.

    Parameters:

    channel - Channel

    response - HTTP response containing the closing handshake details

    promise - the ChannelPromise to notify once the handshake completes.

    Returns:

    future the ChannelFuture which is notified once the handshake completes.

  • verify

    protected abstract void verify(FullHttpResponse response)

    Verify the FullHttpResponse and throws a WebSocketHandshakeException if something is wrong.

  • newWebsocketDecoder

    protected abstract WebSocketFrameDecoder newWebsocketDecoder()

    Returns the decoder to use after handshake is complete.

  • newWebSocketEncoder

    protected abstract WebSocketFrameEncoder newWebSocketEncoder()

    Returns the encoder to use after the handshake is complete.

  • close

    public ChannelFuture close(Channel channel,
     CloseWebSocketFrame frame)

    Performs the closing handshake

    Parameters:

    channel - Channel

    frame - Closing Frame that was received

  • close

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

    Performs the closing handshake

    Parameters:

    channel - Channel

    frame - Closing Frame that was received

    promise - the ChannelPromise to be notified when the closing handshake is done