接口的使用
org.java_websocket.WebSocket

使用WebSocket的程序包

程序包	说明
org.java_websocket
org.java_websocket.client
org.java_websocket.server

org.java_websocket中WebSocket的使用

实现WebSocket的org.java_websocket中的类

限定符和类型	类和说明
class	WebSocketImpl Represents one end (client or server) of a single WebSocketImpl connection.

返回WebSocket的org.java_websocket中的方法

限定符和类型	方法和说明
WebSocket	WebSocketFactory.createWebSocket(WebSocketAdapter a, Draft d) Create a new Websocket with the provided listener, drafts and socket
WebSocket	WebSocketFactory.createWebSocket(WebSocketAdapter a, java.util.List<Draft> drafts) Create a new Websocket with the provided listener, drafts and socket

参数类型为WebSocket的org.java_websocket中的方法

限定符和类型	方法和说明
java.lang.String	WebSocketListener.getFlashPolicy(WebSocket conn)
java.lang.String	WebSocketAdapter.getFlashPolicy(WebSocket conn) Gets the XML string that should be returned if a client requests a Flash security policy.
java.net.InetSocketAddress	WebSocketListener.getLocalSocketAddress(WebSocket conn)
java.net.InetSocketAddress	WebSocketListener.getRemoteSocketAddress(WebSocket conn)
void	WebSocketListener.onWebsocketClose(WebSocket ws, 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	WebSocketListener.onWebsocketCloseInitiated(WebSocket ws, int code, java.lang.String reason) send when this peer sends a close handshake
void	WebSocketListener.onWebsocketClosing(WebSocket ws, int code, java.lang.String reason, boolean remote) Called as soon as no further frames are accepted
void	WebSocketListener.onWebsocketError(WebSocket conn, java.lang.Exception ex) Called if an exception worth noting occurred.
void	WebSocketListener.onWebsocketHandshakeReceivedAsClient(WebSocket conn, ClientHandshake request, ServerHandshake response) Called on the client side when the socket connection is first established, and the WebSocketImpl handshake response has been received.
void	WebSocketAdapter.onWebsocketHandshakeReceivedAsClient(WebSocket conn, ClientHandshake request, ServerHandshake response)
ServerHandshakeBuilder	WebSocketListener.onWebsocketHandshakeReceivedAsServer(WebSocket conn, Draft draft, ClientHandshake request) Called on the server side when the socket connection is first established, and the WebSocket handshake has been received.
ServerHandshakeBuilder	WebSocketAdapter.onWebsocketHandshakeReceivedAsServer(WebSocket conn, Draft draft, ClientHandshake request) This default implementation does not do anything.
void	WebSocketListener.onWebsocketHandshakeSentAsClient(WebSocket conn, ClientHandshake request) Called on the client side when the socket connection is first established, and the WebSocketImpl handshake has just been sent.
void	WebSocketAdapter.onWebsocketHandshakeSentAsClient(WebSocket conn, ClientHandshake request) This default implementation does not do anything which will cause the connections to always progress.
void	WebSocketListener.onWebsocketMessage(WebSocket conn, java.nio.ByteBuffer blob) Called when an entire binary frame has been received.
void	WebSocketListener.onWebsocketMessage(WebSocket conn, java.lang.String message) Called when an entire text frame has been received.
void	WebSocketListener.onWebsocketMessageFragment(WebSocket conn, Framedata frame) Called when a frame fragment has been recieved
void	WebSocketAdapter.onWebsocketMessageFragment(WebSocket conn, Framedata frame) This default implementation does not do anything.
void	WebSocketListener.onWebsocketOpen(WebSocket conn, Handshakedata d) Called after onHandshakeReceived returns true.
void	WebSocketListener.onWebsocketPing(WebSocket conn, Framedata f) Called a ping frame has been received.
void	WebSocketAdapter.onWebsocketPing(WebSocket conn, Framedata f) This default implementation will send a pong in response to the received ping.
void	WebSocketListener.onWebsocketPong(WebSocket conn, Framedata f) Called when a pong frame is received.
void	WebSocketAdapter.onWebsocketPong(WebSocket conn, Framedata f) This default implementation does not do anything.
void	WebSocketListener.onWriteDemand(WebSocket conn) This method is used to inform the selector thread that there is data queued to be written to the socket.

org.java_websocket.client中WebSocket的使用

实现WebSocket的org.java_websocket.client中的类

限定符和类型	类和说明
class	WebSocketClient A subclass must implement at least onOpen, onClose, and onMessage to be useful.

返回WebSocket的org.java_websocket.client中的方法

限定符和类型	方法和说明
WebSocket	WebSocketClient.getConnection() Getter for the engine

参数类型为WebSocket的org.java_websocket.client中的方法

限定符和类型	方法和说明
java.net.InetSocketAddress	WebSocketClient.getLocalSocketAddress(WebSocket conn)
java.net.InetSocketAddress	WebSocketClient.getRemoteSocketAddress(WebSocket conn)
void	WebSocketClient.onWebsocketClose(WebSocket conn, int code, java.lang.String reason, boolean remote) Calls subclass' implementation of onClose.
void	WebSocketClient.onWebsocketCloseInitiated(WebSocket conn, int code, java.lang.String reason)
void	WebSocketClient.onWebsocketClosing(WebSocket conn, int code, java.lang.String reason, boolean remote)
void	WebSocketClient.onWebsocketError(WebSocket conn, java.lang.Exception ex) Calls subclass' implementation of onIOError.
void	WebSocketClient.onWebsocketMessage(WebSocket conn, java.nio.ByteBuffer blob)
void	WebSocketClient.onWebsocketMessage(WebSocket conn, java.lang.String message) Calls subclass' implementation of onMessage.
void	WebSocketClient.onWebsocketMessageFragment(WebSocket conn, Framedata frame)
void	WebSocketClient.onWebsocketOpen(WebSocket conn, Handshakedata handshake) Calls subclass' implementation of onOpen.
void	WebSocketClient.onWriteDemand(WebSocket conn)

org.java_websocket.server中WebSocket的使用

返回变量类型为WebSocket的类型的org.java_websocket.server中的方法

限定符和类型	方法和说明
java.util.Collection<WebSocket>	WebSocketServer.connections() Returns a WebSocket[] of currently connected clients.

参数类型为WebSocket的org.java_websocket.server中的方法

限定符和类型	方法和说明
java.net.InetSocketAddress	WebSocketServer.getLocalSocketAddress(WebSocket conn)
java.net.InetSocketAddress	WebSocketServer.getRemoteSocketAddress(WebSocket conn)
abstract void	WebSocketServer.onClose(WebSocket conn, int code, java.lang.String reason, boolean remote) Called after the websocket connection has been closed.
void	WebSocketServer.onCloseInitiated(WebSocket conn, int code, java.lang.String reason)
void	WebSocketServer.onClosing(WebSocket conn, int code, java.lang.String reason, boolean remote)
abstract void	WebSocketServer.onError(WebSocket conn, java.lang.Exception ex) Called when errors occurs.
void	WebSocketServer.onFragment(WebSocket conn, Framedata fragment) Callback for fragmented frames
void	WebSocketServer.onMessage(WebSocket conn, java.nio.ByteBuffer message) Callback for binary messages received from the remote host
abstract void	WebSocketServer.onMessage(WebSocket conn, java.lang.String message) Callback for string messages received from the remote host
abstract void	WebSocketServer.onOpen(WebSocket conn, ClientHandshake handshake) Called after an opening handshake has been performed and the given websocket is ready to be written on.
void	WebSocketServer.onWebsocketClose(WebSocket conn, int code, java.lang.String reason, boolean remote)
void	WebSocketServer.onWebsocketCloseInitiated(WebSocket conn, int code, java.lang.String reason)
void	WebSocketServer.onWebsocketClosing(WebSocket conn, int code, java.lang.String reason, boolean remote)
void	WebSocketServer.onWebsocketError(WebSocket conn, java.lang.Exception ex)
ServerHandshakeBuilder	WebSocketServer.onWebsocketHandshakeReceivedAsServer(WebSocket conn, Draft draft, ClientHandshake request)
void	WebSocketServer.onWebsocketMessage(WebSocket conn, java.nio.ByteBuffer blob)
void	WebSocketServer.onWebsocketMessage(WebSocket conn, java.lang.String message)
void	WebSocketServer.onWebsocketMessageFragment(WebSocket conn, Framedata frame) 已过时。
void	WebSocketServer.onWebsocketOpen(WebSocket conn, Handshakedata handshake)
void	WebSocketServer.onWriteDemand(WebSocket w)

类型变量类型为WebSocket的org.java_websocket.server中的构造器参数

构造器和说明
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.