WebSocketBase (alibaba-dingtalk-service-sdk 2.0.0 API)

java.lang.Object
- com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase

All Implemented Interfaces:

WebSocket

Direct Known Subclasses:

WebSocketDraft06, WebSocketDraft76, WebSocketImpl
```
public abstract class WebSocketBase
extends Object
implements WebSocket
```
The WebSocket base client.

Author:

t-hashimoto

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bufferSize` The buffer size.
`protected CountDownLatch`	`closeLatch` The close latch.
`protected int`	`connectionReadTimeout` connection read timeout(second).
`protected int`	`connectionTimeout` connection timeout(second).
`protected ByteBuffer`	`downstreamBuffer` The downstream buffer.
`protected InetSocketAddress`	`endpointAddress` endpoint.
`protected ExecutorService`	`executorService` worker.
`protected WebSocketHandler`	`handler` websocket handler.
`protected CountDownLatch`	`handshakeLatch` The handshake latch.
`protected URI`	`location` The location.
`protected String`	`origin` The origin.
`protected String`	`path` the URL to which to connect.
`protected WebSocketPipeline`	`pipeline` The pipeline.
`protected String[]`	`protocols` subprotocol name array.
`protected Proxy`	`proxy` proxy.
`protected boolean`	`quit` quit flag.
`protected HttpHeader`	`requestHeader` The request header map.
`protected HttpHeader`	`responseHeader` The response header map.
`protected int`	`responseStatus` The response status.
`protected Selector`	`selector` The selector.
`protected String[]`	`serverProtocols` The server protocols.
`protected SocketChannel`	`socket` The socket.
`protected SSLHandshake`	`sslHandshake` The ssl handshake.
`protected com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase.State`	`state` The state.
`protected ByteBuffer`	`upstreamBuffer` The upstream buffer.
`protected BlockingQueue<ByteBuffer>`	`upstreamQueue` The upstream queue.
`protected boolean`	`useSsl` The use ssl.

Constructor Summary

Constructors
Constructor and Description
`WebSocketBase(String url, Proxy proxy, WebSocketHandler handler, String... protocols)` Instantiates a new web socket base.
`WebSocketBase(String url, String origin, Proxy proxy, WebSocketHandler handler, String... protocols)` Instantiates a new web socket base.
`WebSocketBase(String url, String origin, WebSocketHandler handler, String... protocols)` Instantiates a new web socket base.
`WebSocketBase(String url, WebSocketHandler handler, String... protocols)` Instantiates a new web socket base.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`addHeader(StringBuilder sb, String key, String value)` Adds the header.
`void`	`awaitClose()` await close
`protected void`	`awaitTermination(int timeout, TimeUnit unit)` Await termination.
`void`	`close()` Close.
`protected void`	`closeWebSocket()` Close web socket.
`void`	`connect()` Connect.
`abstract Frame`	`createFrame(byte[] bytes)` Creates the frame.
`Frame`	`createFrame(ByteBuffer buffer)` Creates the frame.
`Frame`	`createFrame(Object obj)` Creates the frame.
`abstract Frame`	`createFrame(String str)` Creates the frame.
`protected SocketChannel`	`createSocket()` Creates the socket.
`int`	`getBufferSize()` Gets the buffer size.
`int`	`getConnectionReadTimeout()` Gets the connection read timeout.
`int`	`getConnectionTimeout()` Gets the connection timeout.
`InetSocketAddress`	`getEndpoint()` Gets the endpoint.
`protected FrameParser`	`getFrameParser()` Gets the frame parser.
`protected Handshake`	`getHandshake()` Gets the handshake.
`URI`	`getLocation()` Gets the location.
`String`	`getOrigin()` Gets the origin.
`int`	`getPacketDumpMode()` Gets the packet dump mode.
`String`	`getPath()` Gets the path.
`String[]`	`getProtocols()` Gets the protocols.
`HttpHeader`	`getRequestHeader()` Gets the request header.
`HttpHeader`	`getResponseHeader()` Gets the response header.
`int`	`getResponseStatus()` Gets the response status.
`String[]`	`getServerProtocols()` Gets the server protocols.
`protected abstract int`	`getWebSocketVersion()` Gets the web socket version.
`protected void`	`init(String url)` Inits the.
`protected void`	`initializePipeline()` Initialize pipeline.
`protected void`	`initializePipeline(WebSocketPipeline pipeline)` Initialize pipeline.
`protected void`	`initializeProperties()` Initialize properties.
`boolean`	`isBlockingMode()` Checks if is blocking mode.
`boolean`	`isConnected()` Checks if is connected.
`protected static String`	`join(String delim, Collection<String> collections)` Join.
`protected static String`	`join(String delim, int start, int end, String... strings)` Join.
`protected static String`	`join(String delim, String... strings)` Join.
`protected abstract FrameParser`	`newFrameParserInstance()` New frame parser instance.
`protected abstract Handshake`	`newHandshakeInstance()` New handshake instance.
`protected void`	`processBuffer(ByteBuffer buffer)` Process buffer.
`protected void`	`read(SocketChannel socket, ByteBuffer buffer)` Read.
`void`	`send(byte[] bytes)` Send.
`void`	`send(ByteBuffer buffer)` Send.
`void`	`send(Frame frame)` Send.
`void`	`send(Object obj)` Send.
`void`	`send(String str)` Send.
`void`	`setBlockingMode(boolean blockingMode)` Sets the blocking mode.
`void`	`setConnectionReadTimeout(int connectionReadTimeout)` Sets the connection read timeout.
`void`	`setConnectionTimeout(int connectionTimeout)` Sets the connection timeout.
`void`	`setOrigin(String origin)` Sets the origin.
`void`	`setPacketDumpMode(int packetDumpMode)` Sets the packet dump mode.
`void`	`setServerProtocols(String[] serverProtocols)` Sets the server protocols.
`protected com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase.State`	`state()` State.
`protected com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase.State`	`transitionTo(com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase.State to)` Transition to.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - location
```
protected URI location
```
    The location.
  - path
```
protected String path
```
    the URL to which to connect.
  - useSsl
```
protected boolean useSsl
```
    The use ssl.
  - sslHandshake
```
protected SSLHandshake sslHandshake
```
    The ssl handshake.
  - endpointAddress
```
protected InetSocketAddress endpointAddress
```
    endpoint.
  - proxy
```
protected Proxy proxy
```
    proxy.
  - connectionTimeout
```
protected int connectionTimeout
```
    connection timeout(second).
  - connectionReadTimeout
```
protected int connectionReadTimeout
```
    connection read timeout(second).
  - quit
```
protected volatile boolean quit
```
    quit flag.
  - protocols
```
protected String[] protocols
```
    subprotocol name array.
  - serverProtocols
```
protected String[] serverProtocols
```
    The server protocols.
  - bufferSize
```
protected int bufferSize
```
    The buffer size.
  - upstreamBuffer
```
protected ByteBuffer upstreamBuffer
```
    The upstream buffer.
  - downstreamBuffer
```
protected ByteBuffer downstreamBuffer
```
    The downstream buffer.
  - origin
```
protected String origin
```
    The origin.
  - upstreamQueue
```
protected BlockingQueue<ByteBuffer> upstreamQueue
```
    The upstream queue.
  - handler
```
protected WebSocketHandler handler
```
    websocket handler.
  - pipeline
```
protected WebSocketPipeline pipeline
```
    The pipeline.
  - socket
```
protected SocketChannel socket
```
    The socket.
  - selector
```
protected Selector selector
```
    The selector.
  - responseHeader
```
protected HttpHeader responseHeader
```
    The response header map.
  - requestHeader
```
protected HttpHeader requestHeader
```
    The request header map.
  - responseStatus
```
protected int responseStatus
```
    The response status.
  - state
```
protected volatile com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase.State state
```
    The state.
  - closeLatch
```
protected CountDownLatch closeLatch
```
    The close latch.
  - handshakeLatch
```
protected CountDownLatch handshakeLatch
```
    The handshake latch.
  - executorService
```
protected ExecutorService executorService
```
    worker.
- Constructor Detail
  - WebSocketBase
```
public WebSocketBase(String url,
                     String origin,
                     WebSocketHandler handler,
                     String... protocols)
              throws WebSocketException
```
    Instantiates a new web socket base.
    
    Parameters:
    
    url - the url
    
    handler - the handler
    
    protocols - the protocols
    
    Throws:
    
    WebSocketException - the web socket exception
  - WebSocketBase
```
public WebSocketBase(String url,
                     WebSocketHandler handler,
                     String... protocols)
              throws WebSocketException
```
    Instantiates a new web socket base.
    
    Parameters:
    
    url - the url
    
    handler - the handler
    
    protocols - the protocols
    
    Throws:
    
    WebSocketException - the web socket exception
  - WebSocketBase
```
public WebSocketBase(String url,
                     String origin,
                     Proxy proxy,
                     WebSocketHandler handler,
                     String... protocols)
              throws WebSocketException
```
    Instantiates a new web socket base.
    
    Parameters:
    
    url - the url
    
    origin - the origin
    
    proxy - the proxy
    
    handler - the handler
    
    protocols - the protocols
    
    Throws:
    
    WebSocketException - the web socket exception
  - WebSocketBase
```
public WebSocketBase(String url,
                     Proxy proxy,
                     WebSocketHandler handler,
                     String... protocols)
              throws WebSocketException
```
    Instantiates a new web socket base.
    
    Parameters:
    
    url - the url
    
    proxy - the proxy
    
    handler - the handler
    
    protocols - the protocols
    
    Throws:
    
    WebSocketException - the web socket exception
- Method Detail
  - init
```
protected void init(String url)
             throws WebSocketException
```
    Inits the.
    
    Parameters:
    
    url - the url
    
    Throws:
    
    WebSocketException - the web socket exception
  - initializeProperties
```
protected void initializeProperties()
                             throws WebSocketException
```
    Initialize properties.
    
    Throws:
    
    WebSocketException - the web socket exception
  - initializePipeline
```
protected void initializePipeline()
                           throws WebSocketException
```
    Initialize pipeline.
    
    Throws:
    
    WebSocketException - the web socket exception
  - initializePipeline
```
protected void initializePipeline(WebSocketPipeline pipeline)
                           throws WebSocketException
```
    Initialize pipeline.
    
    Parameters:
    
    pipeline - the pipeline
    
    Throws:
    
    WebSocketException - the web socket exception
  - getLocation
```
public URI getLocation()
```
    Description copied from interface: WebSocket
    
    Gets the location.
    
    Specified by:
    
    getLocation in interface WebSocket
    
    Returns:
    
    the location
  - send
```
public void send(Frame frame)
          throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Send.
    
    Specified by:
    
    send in interface WebSocket
    
    Parameters:
    
    frame - the frame
    
    Throws:
    
    WebSocketException - the web socket exception
  - send
```
public void send(Object obj)
          throws WebSocketException
```
    Send.
    
    Parameters:
    
    obj - the obj
    
    Throws:
    
    WebSocketException - the web socket exception
  - send
```
public void send(ByteBuffer buffer)
          throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Send.
    
    Specified by:
    
    send in interface WebSocket
    
    Parameters:
    
    buffer - the ByteBuffer
    
    Throws:
    
    WebSocketException - the web socket exception
  - send
```
public void send(byte[] bytes)
          throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Send.
    
    Specified by:
    
    send in interface WebSocket
    
    Parameters:
    
    bytes - the bytes
    
    Throws:
    
    WebSocketException - the web socket exception
  - send
```
public void send(String str)
          throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Send.
    
    Specified by:
    
    send in interface WebSocket
    
    Parameters:
    
    str - the text
    
    Throws:
    
    WebSocketException - the web socket exception
  - transitionTo
```
protected com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase.State transitionTo(com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase.State to)
```
    Transition to.
    
    Parameters:
    
    to - the to
    
    Returns:
    
    the state
  - state
```
protected com.taobao.api.internal.toplink.embedded.websocket.impl.WebSocketBase.State state()
```
    State.
    
    Returns:
    
    the state
  - read
```
protected void read(SocketChannel socket,
                    ByteBuffer buffer)
             throws WebSocketException
```
    Read.
    
    Parameters:
    
    socket - the socket
    
    buffer - the buffer
    
    Throws:
    
    WebSocketException - the web socket exception
  - createSocket
```
protected SocketChannel createSocket()
                              throws IOException
```
    Creates the socket.
    
    Returns:
    
    the socket channel
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - connect
```
public void connect()
             throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Connect.
    
    Specified by:
    
    connect in interface WebSocket
    
    Throws:
    
    WebSocketException - the web socket exception
  - processBuffer
```
protected void processBuffer(ByteBuffer buffer)
                      throws WebSocketException
```
    Process buffer.
    
    Parameters:
    
    buffer - the buffer
    
    Throws:
    
    WebSocketException - the web socket exception
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: WebSocket
    
    Checks if is connected.
    
    Specified by:
    
    isConnected in interface WebSocket
    
    Returns:
    
    true, if is connected
  - close
```
public void close()
```
    Description copied from interface: WebSocket
    
    Close.
    
    Specified by:
    
    close in interface WebSocket
  - awaitTermination
```
protected void awaitTermination(int timeout,
                                TimeUnit unit)
                         throws InterruptedException
```
    Await termination.
    
    Parameters:
    
    timeout - the timeout
    
    unit - the unit
    
    Throws:
    
    InterruptedException - the interrupted exception
  - awaitClose
```
public void awaitClose()
                throws InterruptedException
```
    Description copied from interface: WebSocket
    
    await close
    
    Specified by:
    
    awaitClose in interface WebSocket
    
    Throws:
    
    InterruptedException
  - closeWebSocket
```
protected void closeWebSocket()
                       throws WebSocketException
```
    Close web socket.
    
    Throws:
    
    WebSocketException - the web socket exception
  - createFrame
```
public Frame createFrame(Object obj)
                  throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Creates the frame.
    
    Specified by:
    
    createFrame in interface WebSocket
    
    Parameters:
    
    obj - the obj
    
    Returns:
    
    the frame
    
    Throws:
    
    WebSocketException - the web socket exception
  - createFrame
```
public Frame createFrame(ByteBuffer buffer)
                  throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Creates the frame.
    
    Specified by:
    
    createFrame in interface WebSocket
    
    Parameters:
    
    buffer - the ByteBuffer
    
    Returns:
    
    the frame
    
    Throws:
    
    WebSocketException - the web socket exception
  - createFrame
```
public abstract Frame createFrame(byte[] bytes)
                           throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Creates the frame.
    
    Specified by:
    
    createFrame in interface WebSocket
    
    Parameters:
    
    bytes - the byte array
    
    Returns:
    
    the frame
    
    Throws:
    
    WebSocketException - the web socket exception
  - createFrame
```
public abstract Frame createFrame(String str)
                           throws WebSocketException
```
    Description copied from interface: WebSocket
    
    Creates the frame.
    
    Specified by:
    
    createFrame in interface WebSocket
    
    Parameters:
    
    str - the str
    
    Returns:
    
    the frame
    
    Throws:
    
    WebSocketException - the web socket exception
  - join
```
protected static String join(String delim,
                             Collection<String> collections)
```
    Join.
    
    Parameters:
    
    delim - the delim
    
    collections - the collections
    
    Returns:
    
    the string
  - join
```
protected static String join(String delim,
                             String... strings)
```
    Join.
    
    Parameters:
    
    delim - the delim
    
    strings - the strings
    
    Returns:
    
    the string
  - join
```
protected static String join(String delim,
                             int start,
                             int end,
                             String... strings)
```
    Join.
    
    Parameters:
    
    delim - the delim
    
    start - the start
    
    end - the end
    
    strings - the strings
    
    Returns:
    
    the string
  - addHeader
```
protected static void addHeader(StringBuilder sb,
                                String key,
                                String value)
```
    Adds the header.
    
    Parameters:
    
    sb - the sb
    
    key - the key
    
    value - the value
  - getWebSocketVersion
```
protected abstract int getWebSocketVersion()
```
    Gets the web socket version.
    
    Returns:
    
    the web socket version
  - newHandshakeInstance
```
protected abstract Handshake newHandshakeInstance()
```
    New handshake instance.
    
    Returns:
    
    the handshake
  - getHandshake
```
protected Handshake getHandshake()
```
    Gets the handshake.
    
    Returns:
    
    the handshake
  - newFrameParserInstance
```
protected abstract FrameParser newFrameParserInstance()
```
    New frame parser instance.
    
    Returns:
    
    the frame parser
  - getFrameParser
```
protected FrameParser getFrameParser()
```
    Gets the frame parser.
    
    Returns:
    
    the frame parser
  - isBlockingMode
```
public boolean isBlockingMode()
```
    Description copied from interface: WebSocket
    
    Checks if is blocking mode.
    
    Specified by:
    
    isBlockingMode in interface WebSocket
    
    Returns:
    
    true, if is blocking mode
  - setBlockingMode
```
public void setBlockingMode(boolean blockingMode)
```
    Description copied from interface: WebSocket
    
    Sets the blocking mode.
    
    Specified by:
    
    setBlockingMode in interface WebSocket
    
    Parameters:
    
    blockingMode - the new blocking mode
  - getServerProtocols
```
public String[] getServerProtocols()
```
    Gets the server protocols.
    
    Returns:
    
    the server protocols
  - setServerProtocols
```
public void setServerProtocols(String[] serverProtocols)
```
    Sets the server protocols.
    
    Parameters:
    
    serverProtocols - the new server protocols
  - getPath
```
public String getPath()
```
    Gets the path.
    
    Returns:
    
    the path
  - getEndpoint
```
public InetSocketAddress getEndpoint()
```
    Description copied from interface: WebSocket
    
    Gets the endpoint.
    
    Specified by:
    
    getEndpoint in interface WebSocket
    
    Returns:
    
    the endpoint
  - getProtocols
```
public String[] getProtocols()
```
    Gets the protocols.
    
    Returns:
    
    the protocols
  - getOrigin
```
public String getOrigin()
```
    Gets the origin.
    
    Returns:
    
    the origin
  - getResponseHeader
```
public HttpHeader getResponseHeader()
```
    Gets the response header.
    
    Returns:
    
    the response header
  - getRequestHeader
```
public HttpHeader getRequestHeader()
```
    Gets the request header.
    
    Returns:
    
    the request header
  - getResponseStatus
```
public int getResponseStatus()
```
    Gets the response status.
    
    Returns:
    
    the response status
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Description copied from interface: WebSocket
    
    Gets the connection timeout.
    
    Specified by:
    
    getConnectionTimeout in interface WebSocket
    
    Returns:
    
    the connection timeout
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
    Description copied from interface: WebSocket
    
    Sets the connection timeout.
    
    Specified by:
    
    setConnectionTimeout in interface WebSocket
    
    Parameters:
    
    connectionTimeout - the new connection timeout
  - getConnectionReadTimeout
```
public int getConnectionReadTimeout()
```
    Gets the connection read timeout.
    
    Returns:
    
    the connection read timeout
  - setConnectionReadTimeout
```
public void setConnectionReadTimeout(int connectionReadTimeout)
```
    Sets the connection read timeout.
    
    Parameters:
    
    connectionReadTimeout - the new connection read timeout
  - setOrigin
```
public void setOrigin(String origin)
```
    Sets the origin.
    
    Parameters:
    
    origin - the new origin
  - getBufferSize
```
public int getBufferSize()
```
    Description copied from interface: WebSocket
    
    Gets the buffer size.
    
    Specified by:
    
    getBufferSize in interface WebSocket
    
    Returns:
    
    the buffer size
  - getPacketDumpMode
```
public int getPacketDumpMode()
```
    Gets the packet dump mode.
    
    Returns:
    
    the packet dump mode
  - setPacketDumpMode
```
public void setPacketDumpMode(int packetDumpMode)
```
    Sets the packet dump mode.
    
    Parameters:
    
    packetDumpMode - the new packet dump mode

Class WebSocketBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

location

path

useSsl

sslHandshake

endpointAddress

proxy

connectionTimeout

connectionReadTimeout

quit

protocols

serverProtocols

bufferSize

upstreamBuffer

downstreamBuffer

origin

upstreamQueue

handler

pipeline

socket

selector

responseHeader

requestHeader

responseStatus

state

closeLatch

handshakeLatch

executorService

Constructor Detail

WebSocketBase

WebSocketBase

WebSocketBase

WebSocketBase

Method Detail

init

initializeProperties

initializePipeline

initializePipeline

getLocation

send

send

send

send

send

transitionTo

state

read

createSocket

connect

processBuffer

isConnected

close

awaitTermination

awaitClose

closeWebSocket

createFrame

createFrame

createFrame

createFrame

join

join

join

addHeader

getWebSocketVersion

newHandshakeInstance

getHandshake

newFrameParserInstance

getFrameParser

isBlockingMode

setBlockingMode

getServerProtocols

setServerProtocols

getPath

getEndpoint

getProtocols