WebSocketServer (alipay-sdk-java 4.9.71.ALL API)

java.lang.Object
- com.alipay.api.java_websocket.WebSocketAdapter
- - com.alipay.api.java_websocket.AbstractWebSocket
  - - com.alipay.api.java_websocket.server.WebSocketServer

所有已实现的接口:

WebSocketListener, Runnable
```
public abstract class WebSocketServer
extends AbstractWebSocket
implements Runnable
```
WebSocketServer is an abstract class that only takes care of the HTTP handshake portion of WebSockets. It's up to a subclass to add functionality/purpose to the server.

嵌套类概要

嵌套类
限定符和类型类和说明

class WebSocketServer.WebSocketWorker
This class is used to process incoming data

嵌套类
限定符和类型	类和说明
`class`	`WebSocketServer.WebSocketWorker` This class is used to process incoming data

字段概要

字段
限定符和类型字段和说明

protected List<WebSocketServer.WebSocketWorker> decoders

static int DECODERS

字段
限定符和类型	字段和说明
`protected List<WebSocketServer.WebSocketWorker>`	`decoders`
`static int`	`DECODERS`

构造器概要

构造器
构造器和说明
`WebSocketServer()` Creates a WebSocketServer that will attempt to listen on port `WebSocket.DEFAULT_PORT`.
`WebSocketServer(InetSocketAddress address)` Creates a WebSocketServer that will attempt to bind/listen on the given `address`.
`WebSocketServer(InetSocketAddress address, int decodercount)`
`WebSocketServer(InetSocketAddress address, int decodercount, List<Draft> drafts)`
`WebSocketServer(InetSocketAddress address, int decodercount, List<Draft> drafts, Collection<WebSocket> connectionscontainer)` Creates a WebSocketServer that will attempt to bind/listen on the given `address`, and comply with `Draft` version `draft`.
`WebSocketServer(InetSocketAddress address, List<Draft> drafts)`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected boolean`	`addConnection(WebSocket ws)`
`protected void`	`allocateBuffers(WebSocket c)`
`void`	`broadcast(byte[] data)` Send a byte array to all connected endpoints
`void`	`broadcast(byte[] data, Collection<WebSocket> clients)` Send a byte array to a specific collection of websocket connections
`void`	`broadcast(ByteBuffer data)` Send a ByteBuffer to all connected endpoints
`void`	`broadcast(ByteBuffer data, Collection<WebSocket> clients)` Send a ByteBuffer to a specific collection of websocket connections
`void`	`broadcast(String text)` Send a text to all connected endpoints
`void`	`broadcast(String text, Collection<WebSocket> clients)` Send a text to a specific collection of websocket connections
`ByteBuffer`	`createBuffer()`
`InetSocketAddress`	`getAddress()`
`Collection<WebSocket>`	`getConnections()` Returns all currently connected clients.
`List<Draft>`	`getDraft()`
`InetSocketAddress`	`getLocalSocketAddress(WebSocket conn)`
`int`	`getPort()` Gets the port number that this server listens on.
`InetSocketAddress`	`getRemoteSocketAddress(WebSocket conn)`
`WebSocketFactory`	`getWebSocketFactory()`
`abstract void`	`onClose(WebSocket conn, int code, String reason, boolean remote)` Called after the websocket connection has been closed.
`void`	`onCloseInitiated(WebSocket conn, int code, String reason)`
`void`	`onClosing(WebSocket conn, int code, String reason, boolean remote)`
`protected boolean`	`onConnect(SelectionKey key)` Returns whether a new connection shall be accepted or not.
`abstract void`	`onError(WebSocket conn, Exception ex)` Called when errors occurs.
`void`	`onMessage(WebSocket conn, ByteBuffer message)` Callback for binary messages received from the remote host
`abstract void`	`onMessage(WebSocket conn, String message)` Callback for string messages received from the remote host
`abstract void`	`onOpen(WebSocket conn, ClientHandshake handshake)` Called after an opening handshake has been performed and the given websocket is ready to be written on.
`abstract void`	`onStart()` Called when the server started up successfully.
`void`	`onWebsocketClose(WebSocket conn, int code, String reason, boolean remote)` Called after `WebSocket#close` is explicity called, or when the other end of the WebSocket connection is closed.
`void`	`onWebsocketCloseInitiated(WebSocket conn, int code, String reason)` send when this peer sends a close handshake
`void`	`onWebsocketClosing(WebSocket conn, int code, String reason, boolean remote)` Called as soon as no further frames are accepted
`void`	`onWebsocketError(WebSocket conn, Exception ex)` Called if an exception worth noting occurred.
`ServerHandshakeBuilder`	`onWebsocketHandshakeReceivedAsServer(WebSocket conn, Draft draft, ClientHandshake request)` This default implementation does not do anything.
`void`	`onWebsocketMessage(WebSocket conn, ByteBuffer blob)` Called when an entire binary frame has been received.
`void`	`onWebsocketMessage(WebSocket conn, String message)` Called when an entire text frame has been received.
`void`	`onWebsocketOpen(WebSocket conn, Handshakedata handshake)` Called after `onHandshakeReceived` returns `true`.
`void`	`onWriteDemand(WebSocket w)` This method is used to inform the selector thread that there is data queued to be written to the socket.
`protected void`	`queue(WebSocketImpl ws)`
`protected void`	`releaseBuffers(WebSocket c)`
`protected boolean`	`removeConnection(WebSocket ws)` This method performs remove operations on the connection and therefore also gives control over whether the operation shall be synchronized `WebSocketServer(InetSocketAddress, int, List, Collection)` allows to specify a collection which will be used to store current connections in.
`void`	`run()`
`void`	`setWebSocketFactory(WebSocketServerFactory wsf)`
`void`	`start()` Starts the server selectorthread that binds to the currently set port number and listeners for WebSocket connection requests.
`void`	`stop()`
`void`	`stop(int timeout)` Closes all connected clients sockets, then closes the underlying ServerSocketChannel, effectively killing the server socket selectorthread, freeing the port the server was bound to and stops all internal workerthreads.

从类继承的方法 com.alipay.api.java_websocket.AbstractWebSocket
getConnectionLostTimeout, isReuseAddr, isTcpNoDelay, setConnectionLostTimeout, setReuseAddr, setTcpNoDelay, startConnectionLostTimer, stopConnectionLostTimer

从类继承的方法 com.alipay.api.java_websocket.WebSocketAdapter
onWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeSentAsClient, onWebsocketPing, onWebsocketPong

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

- 字段详细资料
  - DECODERS
```
public static int DECODERS
```
  - decoders
```
protected List<WebSocketServer.WebSocketWorker> decoders
```
- 构造器详细资料
  - WebSocketServer
```
public WebSocketServer()
```
    Creates a WebSocketServer that will attempt to listen on port WebSocket.DEFAULT_PORT.
    
    另请参阅:
    
    more details here
  - WebSocketServer
```
public WebSocketServer(InetSocketAddress address)
```
    Creates a WebSocketServer that will attempt to bind/listen on the given address.
    
    参数:
    
    address - The address to listen to
    
    另请参阅:
    
    more details here
  - WebSocketServer
```
public WebSocketServer(InetSocketAddress address,
                       int decodercount)
```
    参数:
    
    address - The address (host:port) this server should listen on.
    
    decodercount - The number of WebSocketServer.WebSocketWorkers that will be used to process the incoming network data. By default this will be Runtime.getRuntime().availableProcessors()
    
    另请参阅:
    
    more details here
  - WebSocketServer
```
public WebSocketServer(InetSocketAddress address,
                       List<Draft> drafts)
```
    参数:
    
    address - The address (host:port) this server should listen on.
    
    drafts - The versions of the WebSocket protocol that this server instance should comply to. Clients that use an other protocol version will be rejected.
    
    另请参阅:
    
    more details here
  - WebSocketServer
```
public WebSocketServer(InetSocketAddress address,
                       int decodercount,
                       List<Draft> drafts)
```
    参数:
    
    address - The address (host:port) this server should listen on.
    
    decodercount - The number of WebSocketServer.WebSocketWorkers that will be used to process the incoming network data. By default this will be Runtime.getRuntime().availableProcessors()
    
    drafts - The versions of the WebSocket protocol that this server instance should comply to. Clients that use an other protocol version will be rejected.
    
    另请参阅:
    
    more details here
  - WebSocketServer
```
public WebSocketServer(InetSocketAddress address,
                       int decodercount,
                       List<Draft> drafts,
                       Collection<WebSocket> connectionscontainer)
```
    Creates a WebSocketServer that will attempt to bind/listen on the given address, and comply with Draft version draft.
    
    参数:
    
    address - The address (host:port) this server should listen on.
    
    decodercount - The number of WebSocketServer.WebSocketWorkers that will be used to process the incoming network data. By default this will be Runtime.getRuntime().availableProcessors()
    
    drafts - The versions of the WebSocket protocol that this server instance should comply to. Clients that use an other protocol version will be rejected.
    
    connectionscontainer - Allows to specify a collection that will be used to store the websockets in.
    If you plan to often iterate through the currently connected websockets you may want to use a collection that does not require synchronization like a CopyOnWriteArraySet. In that case make sure that you overload removeConnection(WebSocket) and addConnection(WebSocket).
    By default a HashSet will be used.
    
    另请参阅:
    
    for more control over syncronized operation, more about drafts
- 方法详细资料
  - start
```
public void start()
```
    Starts the server selectorthread that binds to the currently set port number and listeners for WebSocket connection requests. Creates a fixed thread pool with the size DECODERS
    May only be called once.
    Alternatively you can call run() directly.
    
    抛出:
    
    IllegalStateException - Starting an instance again
  - stop
```
public void stop(int timeout)
          throws InterruptedException
```
    Closes all connected clients sockets, then closes the underlying ServerSocketChannel, effectively killing the server socket selectorthread, freeing the port the server was bound to and stops all internal workerthreads.
    If this method is called before the server is started it will never start.
    
    参数:
    
    timeout - Specifies how many milliseconds the overall close handshaking may take altogether before the connections are closed without proper close handshaking.
    
    抛出:
    
    InterruptedException - Interrupt
  - stop
```
public void stop()
          throws IOException,
                 InterruptedException
```
    抛出:
    
    IOException
    
    InterruptedException
  - getConnections
```
public Collection<WebSocket> getConnections()
```
    Returns all currently connected clients. This collection does not allow any modification e.g. removing a client.
    
    指定者:
    
    getConnections 在类中 AbstractWebSocket
    
    返回:
    
    A unmodifiable collection of all currently connected clients
    
    从以下版本开始:
    
    1.3.8
  - getAddress
```
public InetSocketAddress getAddress()
```
  - getPort
```
public int getPort()
```
    Gets the port number that this server listens on.
    
    返回:
    
    The port number.
  - getDraft
```
public List<Draft> getDraft()
```
  - run
```
public void run()
```
    指定者:
    
    run 在接口中 Runnable
  - allocateBuffers
```
protected void allocateBuffers(WebSocket c)
                        throws InterruptedException
```
    抛出:
    
    InterruptedException
  - releaseBuffers
```
protected void releaseBuffers(WebSocket c)
                       throws InterruptedException
```
    抛出:
    
    InterruptedException
  - createBuffer
```
public ByteBuffer createBuffer()
```
  - queue
```
protected void queue(WebSocketImpl ws)
              throws InterruptedException
```
    抛出:
    
    InterruptedException
  - onWebsocketMessage
```
public final void onWebsocketMessage(WebSocket conn,
                                     String message)
```
    从接口复制的说明: WebSocketListener
    
    Called when an entire text frame has been received. Do whatever you want here...
    
    指定者:
    
    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,
                                     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.
  - onWebsocketOpen
```
public final void onWebsocketOpen(WebSocket conn,
                                  Handshakedata handshake)
```
    从接口复制的说明: WebSocketListener
    
    Called after onHandshakeReceived returns true. Indicates that a complete WebSocket connection has been established, and we are ready to send/receive data.
    
    指定者:
    
    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,
                                   String reason,
                                   boolean remote)
```
    从接口复制的说明: WebSocketListener
    
    Called after WebSocket#close is explicity called, or when the other end of the WebSocket connection is closed.
    
    指定者:
    
    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.
  - removeConnection
```
protected boolean removeConnection(WebSocket ws)
```
    This method performs remove operations on the connection and therefore also gives control over whether the operation shall be synchronized
    WebSocketServer(InetSocketAddress, int, List, Collection) allows to specify a collection which will be used to store current connections in.
    Depending on the type on the connection, modifications of that collection may have to be synchronized.
    
    参数:
    
    ws - The Webscoket connection which should be removed
    
    返回:
    
    Removing connection successful
  - onWebsocketHandshakeReceivedAsServer
```
public ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer(WebSocket conn,
                                                                   Draft draft,
                                                                   ClientHandshake request)
                                                            throws InvalidDataException
```
    从类复制的说明: WebSocketAdapter
    
    This default implementation does not do anything. Go ahead and overwrite it.
    
    指定者:
    
    onWebsocketHandshakeReceivedAsServer 在接口中 WebSocketListener
    
    覆盖:
    
    onWebsocketHandshakeReceivedAsServer 在类中 WebSocketAdapter
    
    参数:
    
    conn - The WebSocket related to this event
    
    draft - The protocol draft the client uses to connect
    
    request - The opening http message send by the client. Can be used to access additional fields like cookies.
    
    返回:
    
    Returns an incomplete handshake containing all optional fields
    
    抛出:
    
    InvalidDataException - Throwing this exception will cause this handshake to be rejected
    
    另请参阅:
    
    WebSocketListener.onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake)
  - addConnection
```
protected boolean addConnection(WebSocket ws)
```
    参数:
    
    ws - the Webscoket connection which should be added
    
    返回:
    
    Adding connection successful
    
    另请参阅:
    
    removeConnection(WebSocket)
  - onWebsocketError
```
public final void onWebsocketError(WebSocket conn,
                                   Exception ex)
```
    从接口复制的说明: WebSocketListener
    
    Called if an exception worth noting occurred. If an error causes the connection to fail onClose will be called additionally afterwards.
    
    指定者:
    
    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 w)
```
    从接口复制的说明: WebSocketListener
    
    This method is used to inform the selector thread that there is data queued to be written to the socket.
    
    指定者:
    
    onWriteDemand 在接口中 WebSocketListener
    
    参数:
    
    w - The WebSocket instance this event is occuring on.
  - onWebsocketCloseInitiated
```
public void onWebsocketCloseInitiated(WebSocket conn,
                                      int code,
                                      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,
                               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(WebSocket conn,
                             int code,
                             String reason)
```
  - onClosing
```
public void onClosing(WebSocket conn,
                      int code,
                      String reason,
                      boolean remote)
```
  - setWebSocketFactory
```
public final void setWebSocketFactory(WebSocketServerFactory wsf)
```
  - getWebSocketFactory
```
public final WebSocketFactory getWebSocketFactory()
```
  - onConnect
```
protected boolean onConnect(SelectionKey key)
```
    Returns whether a new connection shall be accepted or not.
    Therefore method is well suited to implement some kind of connection limitation.
    
    参数:
    
    key - the SelectionKey for the new connection
    
    返回:
    
    Can this new connection be accepted
    
    另请参阅:
    
    onOpen(WebSocket, ClientHandshake), onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake)
  - getLocalSocketAddress
```
public 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 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(WebSocket conn,
                            ClientHandshake handshake)
```
    Called after an opening handshake has been performed and the given websocket is ready to be written on.
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    handshake - The handshake of the websocket instance
  - onClose
```
public abstract void onClose(WebSocket conn,
                             int code,
                             String reason,
                             boolean remote)
```
    Called after the websocket connection has been closed.
    
    参数:
    
    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.
  - onMessage
```
public abstract void onMessage(WebSocket conn,
                               String message)
```
    Callback for string messages received from the remote host
    
    参数:
    
    conn - The WebSocket instance this event is occuring on.
    
    message - The UTF-8 decoded message that was received.
    
    另请参阅:
    
    onMessage(WebSocket, ByteBuffer)
  - onError
```
public abstract void onError(WebSocket conn,
                             Exception ex)
```
    Called when errors occurs. If an error causes the websocket connection to fail onClose(WebSocket, int, String, boolean) will be called additionally.
    This method will be called primarily because of IO or protocol errors.
    If the given exception is an RuntimeException that probably means that you encountered a bug.
    
    参数:
    
    conn - Can be null if there error does not belong to one specific websocket. For example if the servers port could not be bound.
    
    ex - The exception causing this error
  - onStart
```
public abstract void onStart()
```
    Called when the server started up successfully.
    If any error occured, onError is called instead.
  - onMessage
```
public void onMessage(WebSocket conn,
                      ByteBuffer message)
```
    Callback for binary messages received from the remote host
    
    参数:
    
    conn - The WebSocket instance this event is occurring on.
    
    message - The binary message that was received.
    
    另请参阅:
    
    onMessage(WebSocket, ByteBuffer)
  - broadcast
```
public void broadcast(String text)
```
    Send a text to all connected endpoints
    
    参数:
    
    text - the text to send to the endpoints
  - broadcast
```
public void broadcast(byte[] data)
```
    Send a byte array to all connected endpoints
    
    参数:
    
    data - the data to send to the endpoints
  - broadcast
```
public void broadcast(ByteBuffer data)
```
    Send a ByteBuffer to all connected endpoints
    
    参数:
    
    data - the data to send to the endpoints
  - broadcast
```
public void broadcast(byte[] data,
                      Collection<WebSocket> clients)
```
    Send a byte array to a specific collection of websocket connections
    
    参数:
    
    data - the data to send to the endpoints
    
    clients - a collection of endpoints to whom the text has to be send
  - broadcast
```
public void broadcast(ByteBuffer data,
                      Collection<WebSocket> clients)
```
    Send a ByteBuffer to a specific collection of websocket connections
    
    参数:
    
    data - the data to send to the endpoints
    
    clients - a collection of endpoints to whom the text has to be send
  - broadcast
```
public void broadcast(String text,
                      Collection<WebSocket> clients)
```
    Send a text to a specific collection of websocket connections
    
    参数:
    
    text - the text to send to the endpoints
    
    clients - a collection of endpoints to whom the text has to be send

类 WebSocketServer

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.alipay.api.java_websocket.AbstractWebSocket

从类继承的方法 com.alipay.api.java_websocket.WebSocketAdapter

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

字段详细资料

DECODERS

decoders

构造器详细资料

WebSocketServer

WebSocketServer

WebSocketServer

WebSocketServer

WebSocketServer

WebSocketServer

方法详细资料

start

stop

stop

getConnections

getAddress

getPort

getDraft

run

allocateBuffers

releaseBuffers

createBuffer

queue

onWebsocketMessage

onWebsocketMessage

onWebsocketOpen

onWebsocketClose

removeConnection

onWebsocketHandshakeReceivedAsServer

addConnection

onWebsocketError

onWriteDemand

onWebsocketCloseInitiated

onWebsocketClosing

onCloseInitiated

onClosing

setWebSocketFactory

getWebSocketFactory

onConnect

getLocalSocketAddress

getRemoteSocketAddress

onOpen

onClose

onMessage

onError

onStart

onMessage

broadcast

broadcast

broadcast

broadcast

broadcast

broadcast