WebSocketImpl (alipay-sdk-java 4.40.54.ALL API)

java.lang.Object
- com.alipay.api.java_websocket.WebSocketImpl

所有已实现的接口:

WebSocket
```
public class WebSocketImpl
extends Object
implements WebSocket
```
Represents one end (client or server) of a single WebSocketImpl connection. Takes care of the "handshake" phase, then allows for easy sending of text frames, and receiving frames through an event-based model.

字段概要

字段
限定符和类型	字段和说明
`ByteChannel`	`channel` the possibly wrapped channel object whose selection is controlled by `key`
`BlockingQueue<ByteBuffer>`	`inQueue` Queue of buffers that need to be processed
`SelectionKey`	`key`
`BlockingQueue<ByteBuffer>`	`outQueue` Queue of buffers that need to be sent to the client.
`static int`	`RCVBUF` Initial buffer size
`WebSocketServer.WebSocketWorker`	`workerThread` Helper variable meant to store the thread which ( exclusively ) triggers this objects decode method.

从接口继承的字段 com.alipay.api.java_websocket.WebSocket
DEFAULT_PORT, DEFAULT_WSS_PORT

构造器概要

构造器
构造器和说明
`WebSocketImpl(WebSocketListener listener, Draft draft)` creates a websocket with client role
`WebSocketImpl(WebSocketListener listener, List<Draft> drafts)` Creates a websocket with server role

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()` Convenience function which behaves like close(CloseFrame.NORMAL)
`void`	`close(int code)` sends the closing handshake. may be send in response to an other handshake.
`void`	`close(int code, String message)` sends the closing handshake. may be send in response to an other handshake.
`void`	`close(int code, String message, boolean remote)`
`void`	`close(InvalidDataException e)`
`void`	`closeConnection()`
`protected void`	`closeConnection(int code, boolean remote)`
`void`	`closeConnection(int code, String message)` This will close the connection immediately without a proper close handshake.
`void`	`closeConnection(int code, String message, boolean remote)` This will close the connection immediately without a proper close handshake.
`void`	`decode(ByteBuffer socketBuffer)` Method to decode the provided ByteBuffer
`void`	`eot()`
`void`	`flushAndClose(int code, String message, boolean remote)`
`<T> T`	`getAttachment()` Getter for the connection attachment.
`Draft`	`getDraft()` Getter for the draft
`InetSocketAddress`	`getLocalSocketAddress()` Returns the address of the endpoint this socket is bound to.
`ReadyState`	`getReadyState()` Retrieve the WebSocket 'ReadyState'.
`InetSocketAddress`	`getRemoteSocketAddress()` Returns the address of the endpoint this socket is connected to, or`null` if it is unconnected.
`String`	`getResourceDescriptor()` Returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2 If the opening handshake has not yet happened it will return null.
`WebSocketListener`	`getWebSocketListener()` Getter for the websocket listener
`boolean`	`hasBufferedData()` Checks if the websocket has buffered data
`boolean`	`isClosed()` Is the websocket in the state CLOSED
`boolean`	`isClosing()` Is the websocket in the state CLOSING
`boolean`	`isFlushAndClose()` Returns true when no further frames may be submitted This happens before the socket connection is closed.
`boolean`	`isOpen()` Is the websocket in the state OPEN
`void`	`send(byte[] bytes)` Send Binary data (plain bytes) to the other end.
`void`	`send(ByteBuffer bytes)` Send Binary data (plain bytes) to the other end.
`void`	`send(String text)` Send Text data to the other end.
`void`	`sendFragmentedFrame(Opcode op, ByteBuffer buffer, boolean fin)` Allows to send continuous/fragmented frames conveniently.
`void`	`sendFrame(Collection<Framedata> frames)` Send a collection of frames to the other end
`void`	`sendFrame(Framedata framedata)` Send a frame to the other end
`void`	`sendPing()` Send a ping to the other end
`<T> void`	`setAttachment(T attachment)` Setter for an attachment on the socket connection.
`void`	`startHandshake(ClientHandshakeBuilder handshakedata)`
`String`	`toString()`
`void`	`updateLastPong()` Update the timestamp when the last pong was received

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - RCVBUF
```
public static final int RCVBUF
```
    Initial buffer size
    
    另请参阅:
    
    常量字段值
  - outQueue
```
public final BlockingQueue<ByteBuffer> outQueue
```
    Queue of buffers that need to be sent to the client.
  - inQueue
```
public final BlockingQueue<ByteBuffer> inQueue
```
    Queue of buffers that need to be processed
  - key
```
public SelectionKey key
```
  - channel
```
public ByteChannel channel
```
    the possibly wrapped channel object whose selection is controlled by key
  - workerThread
```
public volatile WebSocketServer.WebSocketWorker workerThread
```
    Helper variable meant to store the thread which ( exclusively ) triggers this objects decode method.
- 构造器详细资料
  - WebSocketImpl
```
public WebSocketImpl(WebSocketListener listener,
                     List<Draft> drafts)
```
    Creates a websocket with server role
    
    参数:
    
    listener - The listener for this instance
    
    drafts - The drafts which should be used
  - WebSocketImpl
```
public WebSocketImpl(WebSocketListener listener,
                     Draft draft)
```
    creates a websocket with client role
    
    参数:
    
    listener - The listener for this instance
    
    draft - The draft which should be used
- 方法详细资料
  - decode
```
public void decode(ByteBuffer socketBuffer)
```
    Method to decode the provided ByteBuffer
    
    参数:
    
    socketBuffer - the ByteBuffer to decode
  - close
```
public void close(int code,
                  String message,
                  boolean remote)
```
  - close
```
public void close(int code,
                  String message)
```
    从接口复制的说明: WebSocket
    
    sends the closing handshake. may be send in response to an other handshake.
    
    指定者:
    
    close 在接口中 WebSocket
    
    参数:
    
    code - the closing code
    
    message - the closing message
  - closeConnection
```
public void closeConnection(int code,
                            String message,
                            boolean remote)
```
    This will close the connection immediately without a proper close handshake. The code and the message therefore won't be transfered over the wire also they will be forwarded to onClose/onWebsocketClose.
    
    参数:
    
    code - the closing code
    
    message - the closing message
    
    remote - Indicates who "generated" code.
    true means that this endpoint received the code from the other endpoint.
    false means this endpoint decided to send the given code,
    remote may also be true if this endpoint started the closing handshake since the other endpoint may not simply echo the code but close the connection the same time this endpoint does do but with an other code.
  - closeConnection
```
protected void closeConnection(int code,
                               boolean remote)
```
  - closeConnection
```
public void closeConnection()
```
  - closeConnection
```
public void closeConnection(int code,
                            String message)
```
    从接口复制的说明: WebSocket
    
    This will close the connection immediately without a proper close handshake. The code and the message therefore won't be transfered over the wire also they will be forwarded to onClose/onWebsocketClose.
    
    指定者:
    
    closeConnection 在接口中 WebSocket
    
    参数:
    
    code - the closing code
    
    message - the closing message
  - flushAndClose
```
public void flushAndClose(int code,
                          String message,
                          boolean remote)
```
  - eot
```
public void eot()
```
  - close
```
public void close(int code)
```
    从接口复制的说明: WebSocket
    
    sends the closing handshake. may be send in response to an other handshake.
    
    指定者:
    
    close 在接口中 WebSocket
    
    参数:
    
    code - the closing code
  - close
```
public void close(InvalidDataException e)
```
  - send
```
public void send(String text)
          throws WebsocketNotConnectedException
```
    Send Text data to the other end.
    
    指定者:
    
    send 在接口中 WebSocket
    
    参数:
    
    text - the text data to send
    
    抛出:
    
    NotYetConnectedException - websocket is not yet connected
    
    WebsocketNotConnectedException
  - send
```
public void send(ByteBuffer bytes)
          throws IllegalArgumentException,
                 WebsocketNotConnectedException
```
    Send Binary data (plain bytes) to the other end.
    
    指定者:
    
    send 在接口中 WebSocket
    
    参数:
    
    bytes - the binary data to send
    
    抛出:
    
    IllegalArgumentException - the data is null
    
    NotYetConnectedException - websocket is not yet connected
    
    WebsocketNotConnectedException
  - send
```
public void send(byte[] bytes)
          throws IllegalArgumentException,
                 WebsocketNotConnectedException
```
    从接口复制的说明: WebSocket
    
    Send Binary data (plain bytes) to the other end.
    
    指定者:
    
    send 在接口中 WebSocket
    
    参数:
    
    bytes - the byte array to send
    
    抛出:
    
    IllegalArgumentException - the data is null
    
    WebsocketNotConnectedException
  - sendFragmentedFrame
```
public void sendFragmentedFrame(Opcode op,
                                ByteBuffer buffer,
                                boolean fin)
```
    从接口复制的说明: WebSocket
    
    Allows to send continuous/fragmented frames conveniently.
    For more into on this frame type see http://tools.ietf.org/html/rfc6455#section-5.4
    
    If the first frame you send is also the last then it is not a fragmented frame and will received via onMessage instead of onFragmented even though it was send by this method.
    
    指定者:
    
    sendFragmentedFrame 在接口中 WebSocket
    
    参数:
    
    op - This is only important for the first frame in the sequence. Opcode.TEXT, Opcode.BINARY are allowed.
    
    buffer - The buffer which contains the payload. It may have no bytes remaining.
    
    fin - true means the current frame is the last in the sequence.
  - sendFrame
```
public void sendFrame(Collection<Framedata> frames)
```
    从接口复制的说明: WebSocket
    
    Send a collection of frames to the other end
    
    指定者:
    
    sendFrame 在接口中 WebSocket
    
    参数:
    
    frames - the frames to send to the other end
  - sendFrame
```
public void sendFrame(Framedata framedata)
```
    从接口复制的说明: WebSocket
    
    Send a frame to the other end
    
    指定者:
    
    sendFrame 在接口中 WebSocket
    
    参数:
    
    framedata - the frame to send to the other end
  - sendPing
```
public void sendPing()
              throws NotYetConnectedException
```
    从接口复制的说明: WebSocket
    
    Send a ping to the other end
    
    指定者:
    
    sendPing 在接口中 WebSocket
    
    抛出:
    
    NotYetConnectedException - websocket is not yet connected
  - hasBufferedData
```
public boolean hasBufferedData()
```
    从接口复制的说明: WebSocket
    
    Checks if the websocket has buffered data
    
    指定者:
    
    hasBufferedData 在接口中 WebSocket
    
    返回:
    
    has the websocket buffered data
  - startHandshake
```
public void startHandshake(ClientHandshakeBuilder handshakedata)
                    throws InvalidHandshakeException
```
    抛出:
    
    InvalidHandshakeException
  - isOpen
```
public boolean isOpen()
```
    从接口复制的说明: WebSocket
    
    Is the websocket in the state OPEN
    
    指定者:
    
    isOpen 在接口中 WebSocket
    
    返回:
    
    state equals ReadyState.OPEN
  - isClosing
```
public boolean isClosing()
```
    从接口复制的说明: WebSocket
    
    Is the websocket in the state CLOSING
    
    指定者:
    
    isClosing 在接口中 WebSocket
    
    返回:
    
    state equals ReadyState.CLOSING
  - isFlushAndClose
```
public boolean isFlushAndClose()
```
    从接口复制的说明: WebSocket
    
    Returns true when no further frames may be submitted
    This happens before the socket connection is closed.
    
    指定者:
    
    isFlushAndClose 在接口中 WebSocket
    
    返回:
    
    true when no further frames may be submitted
  - isClosed
```
public boolean isClosed()
```
    从接口复制的说明: WebSocket
    
    Is the websocket in the state CLOSED
    
    指定者:
    
    isClosed 在接口中 WebSocket
    
    返回:
    
    state equals ReadyState.CLOSED
  - getReadyState
```
public ReadyState getReadyState()
```
    从接口复制的说明: WebSocket
    
    Retrieve the WebSocket 'ReadyState'. This represents the state of the connection. It returns a numerical value, as per W3C WebSockets specs.
    
    指定者:
    
    getReadyState 在接口中 WebSocket
    
    返回:
    
    Returns '0 = CONNECTING', '1 = OPEN', '2 = CLOSING' or '3 = CLOSED'
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getRemoteSocketAddress
```
public InetSocketAddress getRemoteSocketAddress()
```
    从接口复制的说明: WebSocket
    
    Returns the address of the endpoint this socket is connected to, ornull if it is unconnected.
    
    指定者:
    
    getRemoteSocketAddress 在接口中 WebSocket
    
    返回:
    
    never returns null
  - getLocalSocketAddress
```
public InetSocketAddress getLocalSocketAddress()
```
    从接口复制的说明: WebSocket
    
    Returns the address of the endpoint this socket is bound to.
    
    指定者:
    
    getLocalSocketAddress 在接口中 WebSocket
    
    返回:
    
    never returns null
  - getDraft
```
public Draft getDraft()
```
    从接口复制的说明: WebSocket
    
    Getter for the draft
    
    指定者:
    
    getDraft 在接口中 WebSocket
    
    返回:
    
    the used draft
  - close
```
public void close()
```
    从接口复制的说明: WebSocket
    
    Convenience function which behaves like close(CloseFrame.NORMAL)
    
    指定者:
    
    close 在接口中 WebSocket
  - getResourceDescriptor
```
public String getResourceDescriptor()
```
    从接口复制的说明: WebSocket
    
    Returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2
    If the opening handshake has not yet happened it will return null.
    
    指定者:
    
    getResourceDescriptor 在接口中 WebSocket
    
    返回:
    
    Returns the decoded path component of this URI.
  - updateLastPong
```
public void updateLastPong()
```
    Update the timestamp when the last pong was received
  - getWebSocketListener
```
public WebSocketListener getWebSocketListener()
```
    Getter for the websocket listener
    
    返回:
    
    the websocket listener associated with this instance
  - getAttachment
```
public <T> T getAttachment()
```
    从接口复制的说明: WebSocket
    
    Getter for the connection attachment.
    
    指定者:
    
    getAttachment 在接口中 WebSocket
    
    类型参数:
    
    T - The type of the attachment
    
    返回:
    
    Returns the user attachment
  - setAttachment
```
public <T> void setAttachment(T attachment)
```
    从接口复制的说明: WebSocket
    
    Setter for an attachment on the socket connection. The attachment may be of any type.
    
    指定者:
    
    setAttachment 在接口中 WebSocket
    
    类型参数:
    
    T - The type of the attachment
    
    参数:
    
    attachment - The object to be attached to the user

类 WebSocketImpl

字段概要

从接口继承的字段 com.alipay.api.java_websocket.WebSocket

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

RCVBUF

outQueue

inQueue

key

channel

workerThread

构造器详细资料

WebSocketImpl

WebSocketImpl

方法详细资料

decode

close

close

closeConnection

closeConnection

closeConnection

closeConnection

flushAndClose

eot

close

close

send

send

send

sendFragmentedFrame

sendFrame

sendFrame

sendPing

hasBufferedData

startHandshake

isOpen

isClosing

isFlushAndClose

isClosed

getReadyState

toString

getRemoteSocketAddress

getLocalSocketAddress

getDraft

close

getResourceDescriptor

updateLastPong

getWebSocketListener

getAttachment

setAttachment