WebSocketClient

java.lang.Object
- org.java_websocket.WebSocketAdapter
- - org.java_websocket.AbstractWebSocket
  - - org.java_websocket.client.WebSocketClient

所有已实现的接口:

java.lang.Runnable, WebSocket, WebSocketListener
```
public abstract class WebSocketClient
extends AbstractWebSocket
implements java.lang.Runnable, WebSocket
```
A subclass must implement at least onOpen, onClose, and onMessage to be useful. At runtime the user is expected to establish a connection via connect(), then receive events like onMessage(String) via the overloaded methods and to send(String) data to the server.

嵌套类概要
- 从接口继承的嵌套类/接口 org.java_websocket.WebSocket
  WebSocket.READYSTATE, WebSocket.Role

字段概要
- 从接口继承的字段 org.java_websocket.WebSocket
  DEFAULT_PORT, DEFAULT_WSS_PORT

构造器概要

构造器
构造器和说明
`WebSocketClient(java.net.URI serverUri)` Constructs a WebSocketClient instance and sets it to the connect to the specified URI.
`WebSocketClient(java.net.URI serverUri, Draft protocolDraft)` Constructs a WebSocketClient instance and sets it to the connect to the specified URI.
`WebSocketClient(java.net.URI serverUri, Draft protocolDraft, java.util.Map<java.lang.String,java.lang.String> httpHeaders, int connectTimeout)` Constructs a WebSocketClient instance and sets it to the connect to the specified URI.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`close()` Initiates the websocket close handshake.
`void`	`close(int code)` sends the closing handshake.
`void`	`close(int code, java.lang.String message)` sends the closing handshake.
`void`	`closeBlocking()` Same as `close` but blocks until the websocket closed or failed to do so.
`void`	`closeConnection(int code, java.lang.String message)` This will close the connection immediately without a proper close handshake.
`void`	`connect()` Initiates the websocket connection.
`boolean`	`connectBlocking()` Same as `connect` but blocks until the websocket connected or failed to do so.
`WebSocket`	`getConnection()` Getter for the engine
`Draft`	`getDraft()` Returns the protocol version this channel uses.
`java.net.InetSocketAddress`	`getLocalSocketAddress()` Returns the address of the endpoint this socket is bound to.
`java.net.InetSocketAddress`	`getLocalSocketAddress(WebSocket conn)`
`WebSocket.READYSTATE`	`getReadyState()` This represents the state of the connection.
`java.net.InetSocketAddress`	`getRemoteSocketAddress()` Returns the address of the endpoint this socket is connected to, or`null` if it is unconnected.
`java.net.InetSocketAddress`	`getRemoteSocketAddress(WebSocket conn)`
`java.lang.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.
`java.net.Socket`	`getSocket()` Returns the socket to allow Hostname Verification
`java.net.URI`	`getURI()` Returns the URI that this WebSocketClient is connected to.
`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`	`isConnecting()` Is the websocket in the state CONNECTING
`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
`abstract void`	`onClose(int code, java.lang.String reason, boolean remote)`
`void`	`onCloseInitiated(int code, java.lang.String reason)` Send when this peer sends a close handshake
`void`	`onClosing(int code, java.lang.String reason, boolean remote)` Called as soon as no further frames are accepted
`abstract void`	`onError(java.lang.Exception ex)`
`void`	`onFragment(Framedata frame)`
`void`	`onMessage(java.nio.ByteBuffer bytes)`
`abstract void`	`onMessage(java.lang.String message)`
`abstract void`	`onOpen(ServerHandshake handshakedata)`
`void`	`onWebsocketClose(WebSocket conn, int code, java.lang.String reason, boolean remote)` Calls subclass' implementation of `onClose`.
`void`	`onWebsocketCloseInitiated(WebSocket conn, int code, java.lang.String reason)` send when this peer sends a close handshake
`void`	`onWebsocketClosing(WebSocket conn, int code, java.lang.String reason, boolean remote)` Called as soon as no further frames are accepted
`void`	`onWebsocketError(WebSocket conn, java.lang.Exception ex)` Calls subclass' implementation of `onIOError`.
`void`	`onWebsocketMessage(WebSocket conn, java.nio.ByteBuffer blob)` Called when an entire binary frame has been received.
`void`	`onWebsocketMessage(WebSocket conn, java.lang.String message)` Calls subclass' implementation of `onMessage`.
`void`	`onWebsocketMessageFragment(WebSocket conn, Framedata frame)` This default implementation does not do anything.
`void`	`onWebsocketOpen(WebSocket conn, Handshakedata handshake)` Calls subclass' implementation of `onOpen`.
`void`	`onWriteDemand(WebSocket conn)` This method is used to inform the selector thread that there is data queued to be written to the socket.
`void`	`run()`
`void`	`send(byte[] data)` Sends binary `data` to the connected webSocket server.
`void`	`send(java.nio.ByteBuffer bytes)` Send Binary data (plain bytes) to the other end.
`void`	`send(java.lang.String text)` Sends `text` to the connected websocket server.
`void`	`sendFragmentedFrame(Framedata.Opcode op, java.nio.ByteBuffer buffer, boolean fin)` Allows to send continuous/fragmented frames conveniently.
`void`	`sendFrame(Framedata framedata)` Send a frame to the other end
`void`	`sendPing()` Send a ping to the other end
`void`	`setProxy(java.net.Proxy proxy)`
`void`	`setSocket(java.net.Socket socket)` Accepts bound and unbound sockets.

从类继承的方法 org.java_websocket.AbstractWebSocket
getConnectionLostTimeout, isTcpNoDelay, setConnectionLostTimeout, setTcpNoDelay

从类继承的方法 org.java_websocket.WebSocketAdapter
getFlashPolicy, onWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeReceivedAsServer, onWebsocketHandshakeSentAsClient, onWebsocketPing, onWebsocketPong

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

- 构造器详细资料
  - WebSocketClient
```
public WebSocketClient(java.net.URI serverUri)
```
    Constructs a WebSocketClient instance and sets it to the connect to the specified URI. The channel does not attampt to connect automatically. The connection will be established once you call connect.
    
    参数:
    
    serverUri - the server URI to connect to
  - WebSocketClient
```
public WebSocketClient(java.net.URI serverUri,
                       Draft protocolDraft)
```
    Constructs a WebSocketClient instance and sets it to the connect to the specified URI. The channel does not attampt to connect automatically. The connection will be established once you call connect.
    
    参数:
    
    serverUri - the server URI to connect to
    
    protocolDraft - The draft which should be used for this connection
  - WebSocketClient
```
public WebSocketClient(java.net.URI serverUri,
                       Draft protocolDraft,
                       java.util.Map<java.lang.String,java.lang.String> httpHeaders,
                       int connectTimeout)
```
    Constructs a WebSocketClient instance and sets it to the connect to the specified URI. The channel does not attampt to connect automatically. The connection will be established once you call connect.
    
    参数:
    
    serverUri - the server URI to connect to
    
    protocolDraft - The draft which should be used for this connection
    
    httpHeaders - Additional HTTP-Headers
    
    connectTimeout - The Timeout for the connection
- 方法详细资料
  - getURI
```
public java.net.URI getURI()
```
    Returns the URI that this WebSocketClient is connected to.
    
    返回:
    
    the URI connected to
  - getDraft
```
public Draft getDraft()
```
    Returns the protocol version this channel uses.
    For more infos see https://github.com/TooTallNate/Java-WebSocket/wiki/Drafts
    
    指定者:
    
    getDraft 在接口中 WebSocket
    
    返回:
    
    The draft used for this client
  - getSocket
```
public java.net.Socket getSocket()
```
    Returns the socket to allow Hostname Verification
    
    返回:
    
    the socket used for this connection
  - connect
```
public void connect()
```
    Initiates the websocket connection. This method does not block.
  - connectBlocking
```
public boolean connectBlocking()
                        throws java.lang.InterruptedException
```
    Same as connect but blocks until the websocket connected or failed to do so.
    
    返回:
    
    Returns whether it succeeded or not.
    
    抛出:
    
    java.lang.InterruptedException - Thrown when the threads get interrupted
  - close
```
public void close()
```
    Initiates the websocket close handshake. This method does not block
    In oder to make sure the connection is closed use closeBlocking
    
    指定者:
    
    close 在接口中 WebSocket
  - closeBlocking
```
public void closeBlocking()
                   throws java.lang.InterruptedException
```
    Same as close but blocks until the websocket closed or failed to do so.
    
    抛出:
    
    java.lang.InterruptedException - Thrown when the threads get interrupted
  - send
```
public void send(java.lang.String text)
          throws java.nio.channels.NotYetConnectedException
```
    Sends text to the connected websocket server.
    
    指定者:
    
    send 在接口中 WebSocket
    
    参数:
    
    text - The string which will be transmitted.
    
    抛出:
    
    java.nio.channels.NotYetConnectedException - websocket is not yet connected
  - send
```
public void send(byte[] data)
          throws java.nio.channels.NotYetConnectedException
```
    Sends binary data to the connected webSocket server.
    
    指定者:
    
    send 在接口中 WebSocket
    
    参数:
    
    data - The byte-Array of data to send to the WebSocket server.
    
    抛出:
    
    java.nio.channels.NotYetConnectedException - websocket is not yet connected
  - sendPing
```
public void sendPing()
              throws java.nio.channels.NotYetConnectedException
```
    从接口复制的说明: WebSocket
    
    Send a ping to the other end
    
    指定者:
    
    sendPing 在接口中 WebSocket
    
    抛出:
    
    java.nio.channels.NotYetConnectedException - websocket is not yet connected
  - run
```
public void run()
```
    指定者:
    
    run 在接口中 java.lang.Runnable
  - getReadyState
```
public WebSocket.READYSTATE getReadyState()
```
    This represents the state of the connection.
    
    指定者:
    
    getReadyState 在接口中 WebSocket
    
    返回:
    
    Returns '0 = CONNECTING', '1 = OPEN', '2 = CLOSING' or '3 = CLOSED'
  - onWebsocketMessage
```
public final void onWebsocketMessage(WebSocket conn,
                                     java.lang.String message)
```
    Calls subclass' implementation of onMessage.
    
    指定者:
    
    onWebsocketMessage 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occurring on.
    
    message - The UTF-8 decoded message that was received.
  - onWebsocketMessage
```
public final void onWebsocketMessage(WebSocket conn,
                                     java.nio.ByteBuffer blob)
```
    从接口复制的说明: WebSocketListener
    
    Called when an entire binary frame has been received. Do whatever you want here...
    
    指定者:
    
    onWebsocketMessage 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occurring on.
    
    blob - The binary message that was received.
  - onWebsocketMessageFragment
```
public void onWebsocketMessageFragment(WebSocket conn,
                                       Framedata frame)
```
    从类复制的说明: WebSocketAdapter
    
    This default implementation does not do anything. Go ahead and overwrite it
    
    指定者:
    
    onWebsocketMessageFragment 在接口中 WebSocketListener
    
    覆盖:
    
    onWebsocketMessageFragment 在类中 WebSocketAdapter
    
    参数:
    
    conn - The WebSocket instance this event is occurring on.
    
    frame - The fragmented frame
    
    另请参阅:
    
    WebSocketListener.onWebsocketMessageFragment(WebSocket, Framedata)
  - onWebsocketOpen
```
public final void onWebsocketOpen(WebSocket conn,
                                  Handshakedata handshake)
```
    Calls subclass' implementation of onOpen.
    
    指定者:
    
    onWebsocketOpen 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    handshake - The handshake of the websocket instance
  - onWebsocketClose
```
public final void onWebsocketClose(WebSocket conn,
                                   int code,
                                   java.lang.String reason,
                                   boolean remote)
```
    Calls subclass' implementation of onClose.
    
    指定者:
    
    onWebsocketClose 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    code - The codes can be looked up here: CloseFrame
    
    reason - Additional information string
    
    remote - Returns whether or not the closing of the connection was initiated by the remote host.
  - onWebsocketError
```
public final void onWebsocketError(WebSocket conn,
                                   java.lang.Exception ex)
```
    Calls subclass' implementation of onIOError.
    
    指定者:
    
    onWebsocketError 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    ex - The exception that occurred.
    Might be null if the exception is not related to any specific connection. For example if the server port could not be bound.
  - onWriteDemand
```
public final void onWriteDemand(WebSocket conn)
```
    从接口复制的说明: WebSocketListener
    
    This method is used to inform the selector thread that there is data queued to be written to the socket.
    
    指定者:
    
    onWriteDemand 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
  - onWebsocketCloseInitiated
```
public void onWebsocketCloseInitiated(WebSocket conn,
                                      int code,
                                      java.lang.String reason)
```
    从接口复制的说明: WebSocketListener
    
    send when this peer sends a close handshake
    
    指定者:
    
    onWebsocketCloseInitiated 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    code - The codes can be looked up here: CloseFrame
    
    reason - Additional information string
  - onWebsocketClosing
```
public void onWebsocketClosing(WebSocket conn,
                               int code,
                               java.lang.String reason,
                               boolean remote)
```
    从接口复制的说明: WebSocketListener
    
    Called as soon as no further frames are accepted
    
    指定者:
    
    onWebsocketClosing 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    code - The codes can be looked up here: CloseFrame
    
    reason - Additional information string
    
    remote - Returns whether or not the closing of the connection was initiated by the remote host.
  - onCloseInitiated
```
public void onCloseInitiated(int code,
                             java.lang.String reason)
```
    Send when this peer sends a close handshake
    
    参数:
    
    code - The codes can be looked up here: CloseFrame
    
    reason - Additional information string
  - onClosing
```
public void onClosing(int code,
                      java.lang.String reason,
                      boolean remote)
```
    Called as soon as no further frames are accepted
    
    参数:
    
    code - The codes can be looked up here: CloseFrame
    
    reason - Additional information string
    
    remote - Returns whether or not the closing of the connection was initiated by the remote host.
  - getConnection
```
public WebSocket getConnection()
```
    Getter for the engine
    
    返回:
    
    the engine
  - getLocalSocketAddress
```
public java.net.InetSocketAddress getLocalSocketAddress(WebSocket conn)
```
    指定者:
    
    getLocalSocketAddress 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    返回:
    
    Returns the address of the endpoint this socket is bound to.
    
    另请参阅:
    
    WebSocket.getLocalSocketAddress()
  - getRemoteSocketAddress
```
public java.net.InetSocketAddress getRemoteSocketAddress(WebSocket conn)
```
    指定者:
    
    getRemoteSocketAddress 在接口中 WebSocketListener
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    返回:
    
    Returns the address of the endpoint this socket is connected to, ornull if it is unconnected.
    
    另请参阅:
    
    WebSocket.getRemoteSocketAddress()
  - onOpen
```
public abstract void onOpen(ServerHandshake handshakedata)
```
  - onMessage
```
public abstract void onMessage(java.lang.String message)
```
  - onClose
```
public abstract void onClose(int code,
                             java.lang.String reason,
                             boolean remote)
```
  - onError
```
public abstract void onError(java.lang.Exception ex)
```
  - onMessage
```
public void onMessage(java.nio.ByteBuffer bytes)
```
  - onFragment
```
public void onFragment(Framedata frame)
```
  - setProxy
```
public void setProxy(java.net.Proxy proxy)
```
  - setSocket
```
public void setSocket(java.net.Socket socket)
```
    Accepts bound and unbound sockets.
    This method must be called before connect. If the given socket is not yet bound it will be bound to the uri specified in the constructor.
    
    参数:
    
    socket - The socket which should be used for the connection
  - sendFragmentedFrame
```
public void sendFragmentedFrame(Framedata.Opcode op,
                                java.nio.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.
  - isOpen
```
public boolean isOpen()
```
    从接口复制的说明: WebSocket
    
    Is the websocket in the state OPEN
    
    指定者:
    
    isOpen 在接口中 WebSocket
    
    返回:
    
    state equals READYSTATE.OPEN
  - 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
  - isClosing
```
public boolean isClosing()
```
    从接口复制的说明: WebSocket
    
    Is the websocket in the state CLOSING
    
    指定者:
    
    isClosing 在接口中 WebSocket
    
    返回:
    
    state equals READYSTATE.CLOSING
  - isConnecting
```
public boolean isConnecting()
```
    从接口复制的说明: WebSocket
    
    Is the websocket in the state CONNECTING
    
    指定者:
    
    isConnecting 在接口中 WebSocket
    
    返回:
    
    state equals READYSTATE.CONNECTING
  - hasBufferedData
```
public boolean hasBufferedData()
```
    从接口复制的说明: WebSocket
    
    Checks if the websocket has buffered data
    
    指定者:
    
    hasBufferedData 在接口中 WebSocket
    
    返回:
    
    has the websocket buffered data
  - 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(int code,
                  java.lang.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,
                            java.lang.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
  - send
```
public void send(java.nio.ByteBuffer bytes)
          throws java.lang.IllegalArgumentException,
                 java.nio.channels.NotYetConnectedException
```
    从接口复制的说明: WebSocket
    
    Send Binary data (plain bytes) to the other end.
    
    指定者:
    
    send 在接口中 WebSocket
    
    参数:
    
    bytes - the binary data to send
    
    抛出:
    
    java.lang.IllegalArgumentException - the data is null
    
    java.nio.channels.NotYetConnectedException - websocket is not yet connected
  - 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
  - getLocalSocketAddress
```
public java.net.InetSocketAddress getLocalSocketAddress()
```
    从接口复制的说明: WebSocket
    
    Returns the address of the endpoint this socket is bound to.
    
    指定者:
    
    getLocalSocketAddress 在接口中 WebSocket
    
    返回:
    
    never returns null
  - getRemoteSocketAddress
```
public java.net.InetSocketAddress getRemoteSocketAddress()
```
    从接口复制的说明: WebSocket
    
    Returns the address of the endpoint this socket is connected to, ornull if it is unconnected.
    
    指定者:
    
    getRemoteSocketAddress 在接口中 WebSocket
    
    返回:
    
    never returns null
  - getResourceDescriptor
```
public java.lang.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.

类 WebSocketClient

嵌套类概要

从接口继承的嵌套类/接口 org.java_websocket.WebSocket

字段概要

从接口继承的字段 org.java_websocket.WebSocket

构造器概要

方法概要

从类继承的方法 org.java_websocket.AbstractWebSocket

从类继承的方法 org.java_websocket.WebSocketAdapter

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

构造器详细资料

WebSocketClient

WebSocketClient

WebSocketClient

方法详细资料

getURI

getDraft

getSocket

connect

connectBlocking

close

closeBlocking

send

send

sendPing

run

getReadyState

onWebsocketMessage

onWebsocketMessage

onWebsocketMessageFragment

onWebsocketOpen

onWebsocketClose

onWebsocketError

onWriteDemand

onWebsocketCloseInitiated

onWebsocketClosing

onCloseInitiated

onClosing

getConnection

getLocalSocketAddress

getRemoteSocketAddress

onOpen

onMessage

onClose

onError

onMessage

onFragment

setProxy

setSocket

sendFragmentedFrame

isOpen

isFlushAndClose

isClosed

isClosing

isConnecting

hasBufferedData

close

close

closeConnection

send

sendFrame

getLocalSocketAddress

getRemoteSocketAddress

getResourceDescriptor