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

Class WebSocketImpl

java.lang.Object

com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase

com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketImpl

All Implemented Interfaces:

WebSocket

public class WebSocketImpl
extends WebSocketBase

A simple websocket client this class is implement the WebSocket RFC6455 specification.

Author:

t-hashimoto

See Also:

RFC6455

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	extensions The extensions.
protected String[]	serverExtentions The server extentions.

Fields inherited from class com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase

bufferSize, closeLatch, connectionReadTimeout, connectionTimeout, downstreamBuffer, endpointAddress, executorService, handler, handshakeLatch, location, origin, path, pipeline, protocols, proxy, quit, requestHeader, responseHeader, responseStatus, selector, serverProtocols, socket, sslHandshake, state, upstreamBuffer, upstreamQueue, useSsl

Constructor Summary

Constructors

Constructor and Description
WebSocketImpl(String url, Proxy proxy, WebSocketHandler handler, String... protocols) Instantiates a new web socket RFC6455.
WebSocketImpl(String url, String origin, Proxy proxy, WebSocketHandler handler, String... protocols) Instantiates a new web socket RFC6455.
WebSocketImpl(String url, String origin, WebSocketHandler handler, String... protocols) Instantiates a new web socket RFC6455.
WebSocketImpl(String url, WebSocketHandler handler, String... protocols) Instantiates a new web socket RFC6455.

Method Summary

Modifier and Type	Method and Description
void	addExtension(String extension) Adds the extension.
protected void	closeWebSocket() Close web socket.
Frame	createFrame(byte[] bytes) Creates the frame.
Frame	createFrame(String str) Creates the frame.
protected int	getWebSocketVersion() Gets the web socket version.
protected void	initializePipeline(WebSocketPipeline pipeline) Initialize pipeline.
protected FrameParser	newFrameParserInstance() New frame parser instance.
protected Handshake	newHandshakeInstance() New handshake instance.
void	removeExtension(String extension) Removes the extension.

Methods inherited from class com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase

addHeader, awaitClose, awaitTermination, close, connect, createFrame, createFrame, createSocket, getBufferSize, getConnectionReadTimeout, getConnectionTimeout, getEndpoint, getFrameParser, getHandshake, getLocation, getOrigin, getPacketDumpMode, getPath, getProtocols, getRequestHeader, getResponseHeader, getResponseStatus, getServerProtocols, init, initializePipeline, initializeProperties, isBlockingMode, isConnected, join, join, join, processBuffer, read, send, send, send, send, send, setBlockingMode, setConnectionReadTimeout, setConnectionTimeout, setOrigin, setPacketDumpMode, setServerProtocols, state, transitionTo

Methods inherited from class java.lang.Object

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

Field Detail

extensions

protected Set<String> extensions

The extensions.

serverExtentions

protected String[] serverExtentions

The server extentions.

Constructor Detail

WebSocketImpl

public WebSocketImpl(String url,
                     String origin,
                     WebSocketHandler handler,
                     String... protocols)
              throws WebSocketException

Instantiates a new web socket RFC6455.

Parameters:

url - the url

origin - the origin

handler - the handler

protocols - the protocols

Throws:

WebSocketException - the web socket exception

WebSocketImpl

public WebSocketImpl(String url,
                     WebSocketHandler handler,
                     String... protocols)
              throws WebSocketException

Instantiates a new web socket RFC6455.

Parameters:

url - the url

handler - the handler

protocols - the protocols

Throws:

WebSocketException - the web socket exception

WebSocketImpl

public WebSocketImpl(String url,
                     String origin,
                     Proxy proxy,
                     WebSocketHandler handler,
                     String... protocols)
              throws WebSocketException

Instantiates a new web socket RFC6455.

Parameters:

url - the url

origin - the origin

proxy - the proxy

handler - the handler

protocols - the protocols

Throws:

WebSocketException - the web socket exception

WebSocketImpl

public WebSocketImpl(String url,
                     Proxy proxy,
                     WebSocketHandler handler,
                     String... protocols)
              throws WebSocketException

Instantiates a new web socket RFC6455.

Parameters:

url - the url

proxy - the proxy

handler - the handler

protocols - the protocols

Throws:

WebSocketException - the web socket exception

Method Detail

initializePipeline

protected void initializePipeline(WebSocketPipeline pipeline)
                           throws WebSocketException

Description copied from class: WebSocketBase

Initialize pipeline.

Overrides:

initializePipeline in class WebSocketBase

Parameters:

pipeline - the pipeline

Throws:

WebSocketException - the web socket exception

newHandshakeInstance

protected Handshake newHandshakeInstance()

Description copied from class: WebSocketBase

New handshake instance.

Specified by:

newHandshakeInstance in class WebSocketBase

Returns:

the handshake

newFrameParserInstance

protected FrameParser newFrameParserInstance()

Description copied from class: WebSocketBase

New frame parser instance.

Specified by:

newFrameParserInstance in class WebSocketBase

Returns:

the frame parser

createFrame

public Frame createFrame(byte[] bytes)
                  throws WebSocketException

Description copied from interface: WebSocket

Creates the frame.

Specified by:

createFrame in interface WebSocket

Specified by:

createFrame in class WebSocketBase

Parameters:

bytes - the byte array

Returns:

the frame

Throws:

WebSocketException - the web socket exception

createFrame

public Frame createFrame(String str)
                  throws WebSocketException

Description copied from interface: WebSocket

Creates the frame.

Specified by:

createFrame in interface WebSocket

Specified by:

createFrame in class WebSocketBase

Parameters:

str - the str

Returns:

the frame

Throws:

WebSocketException - the web socket exception

getWebSocketVersion

protected int getWebSocketVersion()

Description copied from class: WebSocketBase

Gets the web socket version.

Specified by:

getWebSocketVersion in class WebSocketBase

Returns:

the web socket version

addExtension

public void addExtension(String extension)

Adds the extension.

Parameters:

extension - the extension

removeExtension

public void removeExtension(String extension)

Removes the extension.

Parameters:

extension - the extension

closeWebSocket

protected void closeWebSocket()
                       throws WebSocketException

Description copied from class: WebSocketBase

Close web socket.

Overrides:

closeWebSocket in class WebSocketBase

Throws:

WebSocketException - the web socket exception