Netty/Codec/HTTP 4.1.107.Final · io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker

Modifier and Type	Field and Description
private final boolean	absoluteUpgradeUrl
private volatile String	actualSubprotocol
protected final HttpHeaders	customHeaders
protected static final int	DEFAULT_FORCE_CLOSE_TIMEOUT_MILLIS
private final String	expectedSubprotocol
private static final AtomicIntegerFieldUpdater<WebSocketClientHandshaker>	FORCE_CLOSE_INIT_UPDATER
private volatile boolean	forceCloseComplete
private volatile int	forceCloseInit
private volatile long	forceCloseTimeoutMillis
protected final boolean	generateOriginHeader
private volatile boolean	handshakeComplete
private static final String	HTTP_SCHEME_PREFIX
private static final String	HTTPS_SCHEME_PREFIX
private final int	maxFramePayloadLength
private final URI	uri
private final WebSocketVersion	version

Constructor Summary

Access	Constructor and Description
protected	WebSocketClientHandshaker(URI URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL. uri, WebSocketVersion Version of web socket specification to use to connect to the server version, String Sub protocol request sent to the server. subprotocol, HttpHeaders Map of custom headers to add to the client request customHeaders, int Maximum length of a frame's payload maxFramePayloadLength) Base constructor
protected	WebSocketClientHandshaker(URI URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL. uri, WebSocketVersion Version of web socket specification to use to connect to the server version, String Sub protocol request sent to the server. subprotocol, HttpHeaders Map of custom headers to add to the client request customHeaders, int Maximum length of a frame's payload maxFramePayloadLength, long Close the connection if it was not closed by the server after timeout specified forceCloseTimeoutMillis) Base constructor
protected	WebSocketClientHandshaker(URI URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL. uri, WebSocketVersion Version of web socket specification to use to connect to the server version, String Sub protocol request sent to the server. subprotocol, HttpHeaders Map of custom headers to add to the client request customHeaders, int Maximum length of a frame's payload maxFramePayloadLength, long Close the connection if it was not closed by the server after timeout specified forceCloseTimeoutMillis, boolean Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP absoluteUpgradeUrl) Base constructor
protected	WebSocketClientHandshaker(URI URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL. uri, WebSocketVersion Version of web socket specification to use to connect to the server version, String Sub protocol request sent to the server. subprotocol, HttpHeaders Map of custom headers to add to the client request customHeaders, int Maximum length of a frame's payload maxFramePayloadLength, long Close the connection if it was not closed by the server after timeout specified forceCloseTimeoutMillis, boolean Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP absoluteUpgradeUrl, boolean Allows to generate the `Origin`\|`Sec-WebSocket-Origin` header value for handshake request according to the given webSocketURL generateOriginHeader) Base constructor

Method Summary

Modifier and Type	Method and Description
public String	actualSubprotocol() Returns the subprotocol response sent by the server.
public ChannelFuture	close(Channel Channel channel, CloseWebSocketFrame Closing Frame that was received frame) Performs the closing handshake.
public ChannelFuture	close(Channel Channel channel, CloseWebSocketFrame Closing Frame that was received frame, ChannelPromise the `ChannelPromise` to be notified when the closing handshake is done promise) Performs the closing handshake When called from within a `ChannelHandler` you most likely want to use `close(ChannelHandlerContext, CloseWebSocketFrame, ChannelPromise)`.
public ChannelFuture	close(ChannelHandlerContext the `ChannelHandlerContext` to use. ctx, CloseWebSocketFrame Closing Frame that was received frame) Performs the closing handshake
public ChannelFuture	close(ChannelHandlerContext the `ChannelHandlerContext` to use. ctx, CloseWebSocketFrame Closing Frame that was received frame, ChannelPromise the `ChannelPromise` to be notified when the closing handshake is done promise) Performs the closing handshake
private ChannelFuture	close0(final ChannelOutboundInvoker invoker, final Channel channel, CloseWebSocketFrame frame, ChannelPromise promise)
public String	expectedSubprotocol() Returns the CSV of requested subprotocol(s) sent to the server as specified in the constructor
public final void	finishHandshake(Channel Channel channel, FullHttpResponse HTTP response containing the closing handshake details response) Validates and finishes the opening handshake initiated by `handshake`}.
public long	forceCloseTimeoutMillis()
public ChannelFuture	handshake(Channel Channel channel) Begins the opening handshake
public final ChannelFuture	handshake(Channel Channel channel, final ChannelPromise the `ChannelPromise` to be notified when the opening handshake is sent promise) Begins the opening handshake
protected boolean	isForceCloseComplete() Flag to indicate if the closing handshake was initiated because of timeout.
public boolean	isHandshakeComplete() Flag to indicate if the opening handshake is complete
public 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.
public final ChannelFuture	Returns: future the `ChannelFuture` which is notified once the handshake completes. processHandshake(final Channel Channel channel, HttpResponse HTTP response containing the closing handshake details response) Process the opening handshake initiated by `handshake`}.
public final ChannelFuture	Returns: future the `ChannelFuture` which is notified once the handshake completes. processHandshake(final Channel Channel channel, HttpResponse HTTP response containing the closing handshake details response, final ChannelPromise the `ChannelPromise` to notify once the handshake completes. promise) Process the opening handshake initiated by `handshake`}.
private void	setActualSubprotocol(String actualSubprotocol)
public WebSocketClientHandshaker	setForceCloseTimeoutMillis(long Close the connection if it was not closed by the server after timeout specified forceCloseTimeoutMillis) Sets timeout to close the connection if it was not closed by the server.
private void	setHandshakeComplete()
protected String	upgradeUrl(URI wsURL) Return the constructed raw path for the give `URI`.
public URI	uri() Returns the URI to the web socket.
protected abstract void	verify(FullHttpResponse response) Verify the `FullHttpResponse` and throws a `WebSocketHandshakeException` if something is wrong.
public WebSocketVersion	version() Version of the web socket specification that is being used
pack-priv static CharSequence	websocketHostValue(URI wsURL)
pack-priv static CharSequence	websocketOriginValue(URI wsURL)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

absoluteUpgradeUrl	back to summary
private final boolean absoluteUpgradeUrl

actualSubprotocol	back to summary
private volatile String actualSubprotocol

customHeaders	back to summary
protected final HttpHeaders customHeaders

DEFAULT_FORCE_CLOSE_TIMEOUT_MILLIS	back to summary
protected static final int DEFAULT_FORCE_CLOSE_TIMEOUT_MILLIS

expectedSubprotocol	back to summary
private final String expectedSubprotocol

FORCE_CLOSE_INIT_UPDATER	back to summary
private static final AtomicIntegerFieldUpdater<WebSocketClientHandshaker> FORCE_CLOSE_INIT_UPDATER

forceCloseComplete	back to summary
private volatile boolean forceCloseComplete

forceCloseInit	back to summary
private volatile int forceCloseInit

forceCloseTimeoutMillis	back to summary
private volatile long forceCloseTimeoutMillis

generateOriginHeader	back to summary
protected final boolean generateOriginHeader

handshakeComplete	back to summary
private volatile boolean handshakeComplete

HTTP_SCHEME_PREFIX	back to summary
private static final String HTTP_SCHEME_PREFIX

HTTPS_SCHEME_PREFIX	back to summary
private static final String HTTPS_SCHEME_PREFIX

maxFramePayloadLength	back to summary
private final int maxFramePayloadLength

uri	back to summary
private final URI uri

version	back to summary
private final WebSocketVersion version

Constructor Detail

WebSocketClientHandshaker	back to summary
protected WebSocketClientHandshaker(URI uri, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength) Base constructor Parameters uri:URI URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL. version:WebSocketVersion Version of web socket specification to use to connect to the server subprotocol:String Sub protocol request sent to the server. customHeaders:HttpHeaders Map of custom headers to add to the client request maxFramePayloadLength:int Maximum length of a frame's payload

WebSocketClientHandshaker

back to summary

protected WebSocketClientHandshaker(URI uri, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength)

Base constructor

Parameters

uri:URI: URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.
version:WebSocketVersion: Version of web socket specification to use to connect to the server
subprotocol:String: Sub protocol request sent to the server.
customHeaders:HttpHeaders: Map of custom headers to add to the client request
maxFramePayloadLength:int: Maximum length of a frame's payload

WebSocketClientHandshaker	back to summary
protected WebSocketClientHandshaker(URI uri, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength, long forceCloseTimeoutMillis) Base constructor Parameters uri:URI URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL. version:WebSocketVersion Version of web socket specification to use to connect to the server subprotocol:String Sub protocol request sent to the server. customHeaders:HttpHeaders Map of custom headers to add to the client request maxFramePayloadLength:int Maximum length of a frame's payload forceCloseTimeoutMillis:long Close the connection if it was not closed by the server after timeout specified

WebSocketClientHandshaker

back to summary

protected WebSocketClientHandshaker(URI uri, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength, long forceCloseTimeoutMillis)

Base constructor

Parameters

uri:URI: URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.
version:WebSocketVersion: Version of web socket specification to use to connect to the server
subprotocol:String: Sub protocol request sent to the server.
customHeaders:HttpHeaders: Map of custom headers to add to the client request
maxFramePayloadLength:int: Maximum length of a frame's payload
forceCloseTimeoutMillis:long: Close the connection if it was not closed by the server after timeout specified

WebSocketClientHandshaker	back to summary
protected WebSocketClientHandshaker(URI uri, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength, long forceCloseTimeoutMillis, boolean absoluteUpgradeUrl) Base constructor Parameters uri:URI URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL. version:WebSocketVersion Version of web socket specification to use to connect to the server subprotocol:String Sub protocol request sent to the server. customHeaders:HttpHeaders Map of custom headers to add to the client request maxFramePayloadLength:int Maximum length of a frame's payload forceCloseTimeoutMillis:long Close the connection if it was not closed by the server after timeout specified absoluteUpgradeUrl:boolean Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP

WebSocketClientHandshaker

back to summary

protected WebSocketClientHandshaker(URI uri, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength, long forceCloseTimeoutMillis, boolean absoluteUpgradeUrl)

Base constructor

Parameters

uri:URI: URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.
version:WebSocketVersion: Version of web socket specification to use to connect to the server
subprotocol:String: Sub protocol request sent to the server.
customHeaders:HttpHeaders: Map of custom headers to add to the client request
maxFramePayloadLength:int: Maximum length of a frame's payload
forceCloseTimeoutMillis:long: Close the connection if it was not closed by the server after timeout specified
absoluteUpgradeUrl:boolean: Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP

WebSocketClientHandshaker	back to summary
protected WebSocketClientHandshaker(URI uri, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength, long forceCloseTimeoutMillis, boolean absoluteUpgradeUrl, boolean generateOriginHeader) Base constructor Parameters uri:URI URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL. version:WebSocketVersion Version of web socket specification to use to connect to the server subprotocol:String Sub protocol request sent to the server. customHeaders:HttpHeaders Map of custom headers to add to the client request maxFramePayloadLength:int Maximum length of a frame's payload forceCloseTimeoutMillis:long Close the connection if it was not closed by the server after timeout specified absoluteUpgradeUrl:boolean Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP generateOriginHeader:boolean Allows to generate the `Origin`\|`Sec-WebSocket-Origin` header value for handshake request according to the given webSocketURL

WebSocketClientHandshaker

back to summary

Base constructor

Parameters

uri:URI: URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.
version:WebSocketVersion: Version of web socket specification to use to connect to the server
subprotocol:String: Sub protocol request sent to the server.
customHeaders:HttpHeaders: Map of custom headers to add to the client request
maxFramePayloadLength:int: Maximum length of a frame's payload
forceCloseTimeoutMillis:long: Close the connection if it was not closed by the server after timeout specified
absoluteUpgradeUrl:boolean: Use an absolute url for the Upgrade request, typically when connecting through an HTTP proxy over clear HTTP
generateOriginHeader:boolean: Allows to generate the `Origin`|`Sec-WebSocket-Origin` header value for handshake request according to the given webSocketURL

Method Detail

actualSubprotocol	back to summary
public 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.

close back to summary

close	back to summary
public ChannelFuture close(Channel channel, CloseWebSocketFrame frame) Performs the closing handshake. When called from within a `ChannelHandler` you most likely want to use `close(ChannelHandlerContext, CloseWebSocketFrame)`. Parameters channel:Channel Channel frame:CloseWebSocketFrame Closing Frame that was received

public ChannelFuture close(Channel channel, CloseWebSocketFrame frame)

Performs the closing handshake. When called from within a ChannelHandler you most likely want to use close(ChannelHandlerContext, CloseWebSocketFrame).

Parameters

channel:Channel: Channel
frame:CloseWebSocketFrame: Closing Frame that was received

close back to summary

close	back to summary
public ChannelFuture close(Channel channel, CloseWebSocketFrame frame, ChannelPromise promise) Performs the closing handshake When called from within a `ChannelHandler` you most likely want to use `close(ChannelHandlerContext, CloseWebSocketFrame, ChannelPromise)`. Parameters channel:Channel Channel frame:CloseWebSocketFrame Closing Frame that was received promise:ChannelPromise the `ChannelPromise` to be notified when the closing handshake is done

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

Performs the closing handshake When called from within a ChannelHandler you most likely want to use close(ChannelHandlerContext, CloseWebSocketFrame, ChannelPromise).

Parameters

channel:Channel: Channel
frame:CloseWebSocketFrame: Closing Frame that was received
promise:ChannelPromise: the ChannelPromise to be notified when the closing handshake is done

close back to summary

close	back to summary
public ChannelFuture close(ChannelHandlerContext ctx, CloseWebSocketFrame frame) Performs the closing handshake Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` to use. frame:CloseWebSocketFrame Closing Frame that was received

public ChannelFuture close(ChannelHandlerContext ctx, CloseWebSocketFrame frame)

Performs the closing handshake

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext to use.
frame:CloseWebSocketFrame: Closing Frame that was received

close back to summary

close	back to summary
public ChannelFuture close(ChannelHandlerContext ctx, CloseWebSocketFrame frame, ChannelPromise promise) Performs the closing handshake Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` to use. frame:CloseWebSocketFrame Closing Frame that was received promise:ChannelPromise the `ChannelPromise` to be notified when the closing handshake is done

public ChannelFuture close(ChannelHandlerContext ctx, CloseWebSocketFrame frame, ChannelPromise promise)

Performs the closing handshake

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext to use.
frame:CloseWebSocketFrame: Closing Frame that was received
promise:ChannelPromise: the ChannelPromise to be notified when the closing handshake is done

close0	back to summary
private ChannelFuture close0(final ChannelOutboundInvoker invoker, final Channel channel, CloseWebSocketFrame frame, ChannelPromise promise)

expectedSubprotocol	back to summary
public String expectedSubprotocol() Returns the CSV of requested subprotocol(s) sent to the server as specified in the constructor

finishHandshake back to summary

finishHandshake	back to summary
public final void finishHandshake(Channel channel, FullHttpResponse response) Validates and finishes the opening handshake initiated by `handshake`}. Parameters channel:Channel Channel response:FullHttpResponse HTTP response containing the closing handshake details

public final void finishHandshake(Channel channel, FullHttpResponse response)

Validates and finishes the opening handshake initiated by handshake}.

Parameters

channel:Channel: Channel
response:FullHttpResponse: HTTP response containing the closing handshake details

forceCloseTimeoutMillis	back to summary
public long forceCloseTimeoutMillis()

handshake	back to summary
public ChannelFuture handshake(Channel channel) Begins the opening handshake Parameters channel:Channel Channel

handshake

back to summary

public ChannelFuture handshake(Channel channel)

Begins the opening handshake

Parameters

channel:Channel: Channel

handshake back to summary

handshake	back to summary
public final ChannelFuture handshake(Channel channel, final ChannelPromise promise) Begins the opening handshake Parameters channel:Channel Channel promise:ChannelPromise the `ChannelPromise` to be notified when the opening handshake is sent

public final ChannelFuture handshake(Channel channel, final ChannelPromise promise)

Begins the opening handshake

Parameters

channel:Channel: Channel
promise:ChannelPromise: the ChannelPromise to be notified when the opening handshake is sent

isForceCloseComplete	back to summary
protected boolean isForceCloseComplete() Flag to indicate if the closing handshake was initiated because of timeout. For testing only.

isHandshakeComplete	back to summary
public boolean isHandshakeComplete() Flag to indicate if the opening handshake is complete

maxFramePayloadLength	back to summary
public int maxFramePayloadLength() Returns the max length for any frame's payload

newHandshakeRequest	back to summary
protected abstract FullHttpRequest newHandshakeRequest() Returns a new {@link FullHttpRequest) which will be used for the handshake.

newWebsocketDecoder	back to summary
protected abstract WebSocketFrameDecoder newWebsocketDecoder() Returns the decoder to use after handshake is complete.

newWebSocketEncoder	back to summary
protected abstract WebSocketFrameEncoder newWebSocketEncoder() Returns the encoder to use after the handshake is complete.

processHandshake back to summary

processHandshake	back to summary
public final ChannelFuture processHandshake(final Channel channel, HttpResponse response) Process the opening handshake initiated by `handshake`}. Parameters channel:Channel Channel response:HttpResponse HTTP response containing the closing handshake details Returns:ChannelFuture future the `ChannelFuture` which is notified once the handshake completes.

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

Process the opening handshake initiated by handshake}.

Parameters

channel:Channel: Channel
response:HttpResponse: HTTP response containing the closing handshake details

Returns:ChannelFuture

future the ChannelFuture which is notified once the handshake completes.

processHandshake back to summary

processHandshake	back to summary
public final ChannelFuture processHandshake(final Channel channel, HttpResponse response, final ChannelPromise promise) Process the opening handshake initiated by `handshake`}. Parameters channel:Channel Channel response:HttpResponse HTTP response containing the closing handshake details promise:ChannelPromise the `ChannelPromise` to notify once the handshake completes. Returns:ChannelFuture future the `ChannelFuture` which is notified once the handshake completes.

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

Process the opening handshake initiated by handshake}.

Parameters

channel:Channel: Channel
response:HttpResponse: HTTP response containing the closing handshake details
promise:ChannelPromise: the ChannelPromise to notify once the handshake completes.

Returns:ChannelFuture

future the ChannelFuture which is notified once the handshake completes.

setActualSubprotocol	back to summary
private void setActualSubprotocol(String actualSubprotocol)

setForceCloseTimeoutMillis	back to summary
public WebSocketClientHandshaker setForceCloseTimeoutMillis(long forceCloseTimeoutMillis) Sets timeout to close the connection if it was not closed by the server. Parameters forceCloseTimeoutMillis:long Close the connection if it was not closed by the server after timeout specified

setForceCloseTimeoutMillis

back to summary

public WebSocketClientHandshaker setForceCloseTimeoutMillis(long forceCloseTimeoutMillis)

Sets timeout to close the connection if it was not closed by the server.

Parameters

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

setHandshakeComplete	back to summary
private void setHandshakeComplete()

upgradeUrl	back to summary
protected String upgradeUrl(URI wsURL) Return the constructed raw path for the give `URI`.

uri	back to summary
public URI uri() Returns the URI to the web socket. e.g. "ws://myhost.com/path"

verify	back to summary
protected abstract void verify(FullHttpResponse response) Verify the `FullHttpResponse` and throws a `WebSocketHandshakeException` if something is wrong.

version	back to summary
public WebSocketVersion version() Version of the web socket specification that is being used

websocketHostValue	back to summary
pack-priv static CharSequence websocketHostValue(URI wsURL)

websocketOriginValue	back to summary
pack-priv static CharSequence websocketOriginValue(URI wsURL)

public abstract Class WebSocketClientHandshaker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail