com.taobao.api.internal.toplink.embedded.websocket.handshake

Class Handshake

java.lang.Object

com.taobao.api.internal.toplink.embedded.websocket.handshake.Handshake

public abstract class Handshake
extends Object

Processing WebSocket Handshake

 Sample (Draft06)
 client => server
 GET /chat HTTP/1.1
 Host: server.example.com
 Upgrade: websocket
 Connection: Upgrade
 Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
 Sec-WebSocket-Origin: http://example.com
 Sec-WebSocket-Protocol: chat, superchat
 Sec-WebSocket-Version:6
 
 server => client
 HTTP/1.1 101 Switching Protocols
 Upgrade: websocket
 Connection: Upgrade
 Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
 Sec-WebSocket-Protocol: chat
 

Author:

Takahiro Hashimoto

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferManager	bufferManager The buffer manager.

Constructor Summary

Constructors

Constructor and Description
Handshake()

Method Summary

Modifier and Type	Method and Description
abstract ByteBuffer	createHandshakeRequest() Creates the handshake request.
protected boolean	done() Done.
HttpHeader	getResponseHeader() Gets the response header map.
int	getResponseStatus() Gets the response status.
boolean	handshakeResponse(ByteBuffer downloadBuffer) Handshake response.
boolean	isDone() Checks if is done.
protected boolean	parseHandshakeResponseBody(ByteBuffer buffer) Parses the handshake response contents.
protected boolean	parseHandshakeResponseHeader(ByteBuffer buffer) Parses the handshake response header.
protected com.taobao.api.internal.toplink.embedded.websocket.handshake.Handshake.State	state() State.
protected com.taobao.api.internal.toplink.embedded.websocket.handshake.Handshake.State	transitionTo(com.taobao.api.internal.toplink.embedded.websocket.handshake.Handshake.State to) Transition to.

Methods inherited from class java.lang.Object

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

Field Detail

bufferManager

protected BufferManager bufferManager

The buffer manager.

Constructor Detail

Handshake

public Handshake()

Method Detail

transitionTo

protected com.taobao.api.internal.toplink.embedded.websocket.handshake.Handshake.State transitionTo(com.taobao.api.internal.toplink.embedded.websocket.handshake.Handshake.State to)

Transition to.

Parameters:

to - the to

Returns:

the state

state

protected com.taobao.api.internal.toplink.embedded.websocket.handshake.Handshake.State state()

State.

Returns:

the state

handshakeResponse

public final boolean handshakeResponse(ByteBuffer downloadBuffer)
                                throws WebSocketException

Handshake response.

Parameters:

downloadBuffer - the download buffer

Returns:

true, if successful

Throws:

WebSocketException - the web socket exception

done

protected boolean done()

Done.

Returns:

true, if successful

isDone

public boolean isDone()

Checks if is done.

Returns:

true, if is done

parseHandshakeResponseBody

protected boolean parseHandshakeResponseBody(ByteBuffer buffer)
                                      throws WebSocketException

Parses the handshake response contents.

Parameters:

buffer - the buffer

Returns:

true, if successful

Throws:

WebSocketException - the web socket exception

parseHandshakeResponseHeader

protected boolean parseHandshakeResponseHeader(ByteBuffer buffer)
                                        throws WebSocketException

Parses the handshake response header.

Parameters:

buffer - the buffer

Returns:

true, if successful

Throws:

WebSocketException - the web socket exception

createHandshakeRequest

public abstract ByteBuffer createHandshakeRequest()
                                           throws WebSocketException

Creates the handshake request.

Returns:

the byte buffer

Throws:

WebSocketException - the web socket exception

getResponseStatus

public int getResponseStatus()

Gets the response status.

Returns:

the response status

getResponseHeader

public HttpHeader getResponseHeader()

Gets the response header map.

Returns:

the response header map