org.java_websocket.server

类 WebSocketServer

java.lang.Object

org.java_websocket.WebSocketAdapter

org.java_websocket.AbstractWebSocket

org.java_websocket.server.WebSocketServer

所有已实现的接口:

java.lang.Runnable, WebSocketListener

public abstract class WebSocketServer
extends AbstractWebSocket
implements java.lang.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.

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	WebSocketServer.WebSocketServerFactory Interface to encapsulate the required methods for a websocket factory
class	WebSocketServer.WebSocketWorker This class is used to process incoming data

字段概要

字段

限定符和类型	字段和说明
static int	DECODERS

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
java.util.Collection<WebSocket>	connections() Returns a WebSocket[] of currently connected clients.
java.nio.ByteBuffer	createBuffer()
java.net.InetSocketAddress	getAddress()
java.util.List<Draft>	getDraft()
java.net.InetSocketAddress	getLocalSocketAddress(WebSocket conn)
int	getPort() Gets the port number that this server listens on.
java.net.InetSocketAddress	getRemoteSocketAddress(WebSocket conn)
WebSocketFactory	getWebSocketFactory()
abstract void	onClose(WebSocket conn, int code, java.lang.String reason, boolean remote) Called after the websocket connection has been closed.
void	onCloseInitiated(WebSocket conn, int code, java.lang.String reason)
void	onClosing(WebSocket conn, int code, java.lang.String reason, boolean remote)
abstract void	onError(WebSocket conn, java.lang.Exception ex) Called when errors occurs.
void	onFragment(WebSocket conn, Framedata fragment) Callback for fragmented frames
void	onMessage(WebSocket conn, java.nio.ByteBuffer message) Callback for binary messages received from the remote host
abstract void	onMessage(WebSocket conn, java.lang.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, java.lang.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, 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) 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, java.nio.ByteBuffer blob) Called when an entire binary frame has been received.
void	onWebsocketMessage(WebSocket conn, java.lang.String message) Called when an entire text frame has been received.
void	onWebsocketMessageFragment(WebSocket conn, Framedata frame) 已过时。
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.
void	run()
void	setWebSocketFactory(WebSocketServer.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.

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

getConnectionLostTimeout, isTcpNoDelay, setConnectionLostTimeout, setTcpNoDelay

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

getFlashPolicy, onWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeSentAsClient, onWebsocketPing, onWebsocketPong

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

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

字段详细资料

DECODERS

public static int DECODERS

构造器详细资料

WebSocketServer

public WebSocketServer()

Creates a WebSocketServer that will attempt to listen on port WebSocket.DEFAULT_PORT.

另请参阅:

more details here

WebSocketServer

public WebSocketServer(java.net.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(java.net.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(java.net.InetSocketAddress address,
                       java.util.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(java.net.InetSocketAddress address,
                       int decodercount,
                       java.util.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(java.net.InetSocketAddress address,
                       int decodercount,
                       java.util.List<Draft> drafts,
                       java.util.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.

抛出:

java.lang.IllegalStateException - Starting an instance again

stop

public void stop(int timeout)
          throws java.lang.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.

抛出:

java.lang.InterruptedException - Interrupt

stop

public void stop()
          throws java.io.IOException,
                 java.lang.InterruptedException

抛出:

java.io.IOException

java.lang.InterruptedException

connections

public java.util.Collection<WebSocket> connections()

Returns a WebSocket[] of currently connected clients. Its iterators will be failfast and its not judicious to modify it.

返回:

The currently connected clients.

getAddress

public java.net.InetSocketAddress getAddress()

getPort

public int getPort()

Gets the port number that this server listens on.

返回:

The port number.

getDraft

public java.util.List<Draft> getDraft()

run

public void run()

指定者:

run 在接口中 java.lang.Runnable

createBuffer

public java.nio.ByteBuffer createBuffer()

onWebsocketMessage

public final void onWebsocketMessage(WebSocket conn,
                                     java.lang.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.

onWebsocketMessageFragment

@Deprecated
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)

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.

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,
                                   java.lang.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.

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)

onWebsocketError

public final void onWebsocketError(WebSocket conn,
                                   java.lang.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,
                                      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(WebSocket conn,
                             int code,
                             java.lang.String reason)

onClosing

public void onClosing(WebSocket conn,
                      int code,
                      java.lang.String reason,
                      boolean remote)

setWebSocketFactory

public final void setWebSocketFactory(WebSocketServer.WebSocketServerFactory wsf)

getWebSocketFactory

public final WebSocketFactory getWebSocketFactory()

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(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,
                             java.lang.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,
                               java.lang.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,
                             java.lang.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,
                      java.nio.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)

onFragment

public void onFragment(WebSocket conn,
                       Framedata fragment)

Callback for fragmented frames

参数:

conn - The WebSocket instance this event is occurring on.

fragment - The fragmented frame

另请参阅:

WebSocket.sendFragmentedFrame(org.java_websocket.framing.Framedata.Opcode, ByteBuffer, boolean)