io.netty.handler.codec.http.websocketx

Class WebSocketClientHandshaker00

java.lang.Object

io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker

io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker00

public class WebSocketClientHandshaker00
extends WebSocketClientHandshaker

Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 00

A very large portion of this code was taken from the Netty 3.2 HTTP example.

Field Summary

Fields inherited from class io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker

customHeaders, DEFAULT_FORCE_CLOSE_TIMEOUT_MILLIS, generateOriginHeader

Constructor Summary

Constructors

Constructor and Description
WebSocketClientHandshaker00(URI webSocketURL, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength) Creates a new instance with the specified destination WebSocket location and version to initiate.
WebSocketClientHandshaker00(URI webSocketURL, WebSocketVersion version, String subprotocol, HttpHeaders customHeaders, int maxFramePayloadLength, long forceCloseTimeoutMillis) Creates a new instance with the specified destination WebSocket location and version to initiate.

Method Summary

Modifier and Type	Method and Description
protected FullHttpRequest	newHandshakeRequest() Sends the opening request to the server: GET /demo HTTP/1.1 Upgrade: WebSocket Connection: Upgrade Host: example.com Origin: http://example.com Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5 Sec-WebSocket-Key2: 12998 5 Y3 1 .P00 ^n:ds[4U
protected WebSocketFrameDecoder	newWebsocketDecoder() Returns the decoder to use after handshake is complete.
protected WebSocketFrameEncoder	newWebSocketEncoder() Returns the encoder to use after the handshake is complete.
WebSocketClientHandshaker00	setForceCloseTimeoutMillis(long forceCloseTimeoutMillis) Sets timeout to close the connection if it was not closed by the server.
protected void	verify(FullHttpResponse response) Process server response: HTTP/1.1 101 WebSocket Protocol Handshake Upgrade: WebSocket Connection: Upgrade Sec-WebSocket-Origin: http://example.com Sec-WebSocket-Location: ws://example.com/demo Sec-WebSocket-Protocol: sample 8jKS'y:G*Co,Wxa-

Methods inherited from class io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker

actualSubprotocol, close, close, close, close, expectedSubprotocol, finishHandshake, forceCloseTimeoutMillis, handshake, handshake, isForceCloseComplete, isHandshakeComplete, maxFramePayloadLength, processHandshake, processHandshake, upgradeUrl, uri, version

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketClientHandshaker00

public WebSocketClientHandshaker00(URI webSocketURL,
                                   WebSocketVersion version,
                                   String subprotocol,
                                   HttpHeaders customHeaders,
                                   int maxFramePayloadLength)

Creates a new instance with the specified destination WebSocket location and version to initiate.

Parameters:

webSocketURL - 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

WebSocketClientHandshaker00

public WebSocketClientHandshaker00(URI webSocketURL,
                                   WebSocketVersion version,
                                   String subprotocol,
                                   HttpHeaders customHeaders,
                                   int maxFramePayloadLength,
                                   long forceCloseTimeoutMillis)

Creates a new instance with the specified destination WebSocket location and version to initiate.

Parameters:

webSocketURL - 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

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

Method Detail

newHandshakeRequest

protected FullHttpRequest newHandshakeRequest()

Sends the opening request to the server:

 GET /demo HTTP/1.1
 Upgrade: WebSocket
 Connection: Upgrade
 Host: example.com
 Origin: http://example.com
 Sec-WebSocket-Key1: 4 @1  46546xW%0l 1 5
 Sec-WebSocket-Key2: 12998 5 Y3 1  .P00

 ^n:ds[4U
 

Specified by:

newHandshakeRequest in class WebSocketClientHandshaker

verify

protected void verify(FullHttpResponse response)

Process server response:

 HTTP/1.1 101 WebSocket Protocol Handshake
 Upgrade: WebSocket
 Connection: Upgrade
 Sec-WebSocket-Origin: http://example.com
 Sec-WebSocket-Location: ws://example.com/demo
 Sec-WebSocket-Protocol: sample

 8jKS'y:G*Co,Wxa-
 

Specified by:

verify in class WebSocketClientHandshaker

Parameters:

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

Throws:

WebSocketHandshakeException

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 WebSocketClientHandshaker00 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