org.java_websocket

类 WebSocketAdapter

java.lang.Object

org.java_websocket.WebSocketAdapter

所有已实现的接口:

WebSocketListener

直接已知子类:

AbstractWebSocket

public abstract class WebSocketAdapter
extends java.lang.Object
implements WebSocketListener

This class default implements all methods of the WebSocketListener that can be overridden optionally when advances functionalities is needed.

构造器概要

构造器

构造器和说明
WebSocketAdapter()

方法概要

限定符和类型	方法和说明
java.lang.String	getFlashPolicy(WebSocket conn) Gets the XML string that should be returned if a client requests a Flash security policy.
void	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.
ServerHandshakeBuilder	onWebsocketHandshakeReceivedAsServer(WebSocket conn, Draft draft, ClientHandshake request) This default implementation does not do anything.
void	onWebsocketHandshakeSentAsClient(WebSocket conn, ClientHandshake request) This default implementation does not do anything which will cause the connections to always progress.
void	onWebsocketMessageFragment(WebSocket conn, Framedata frame) This default implementation does not do anything.
void	onWebsocketPing(WebSocket conn, Framedata f) This default implementation will send a pong in response to the received ping.
void	onWebsocketPong(WebSocket conn, Framedata f) This default implementation does not do anything.

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

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

从接口继承的方法 org.java_websocket.WebSocketListener

getLocalSocketAddress, getRemoteSocketAddress, onWebsocketClose, onWebsocketCloseInitiated, onWebsocketClosing, onWebsocketError, onWebsocketMessage, onWebsocketMessage, onWebsocketOpen, onWriteDemand

构造器详细资料

WebSocketAdapter

public WebSocketAdapter()

方法详细资料

onWebsocketHandshakeReceivedAsServer

public ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer(WebSocket conn,
                                                                   Draft draft,
                                                                   ClientHandshake request)
                                                            throws InvalidDataException

This default implementation does not do anything. Go ahead and overwrite it.

指定者:

onWebsocketHandshakeReceivedAsServer 在接口中 WebSocketListener

参数:

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)

onWebsocketHandshakeReceivedAsClient

public void onWebsocketHandshakeReceivedAsClient(WebSocket conn,
                                                 ClientHandshake request,
                                                 ServerHandshake response)
                                          throws InvalidDataException

从接口复制的说明: WebSocketListener

Called on the client side when the socket connection is first established, and the WebSocketImpl handshake response has been received.

指定者:

onWebsocketHandshakeReceivedAsClient 在接口中 WebSocketListener

参数:

conn - The WebSocket related to this event

request - The handshake initially send out to the server by this websocket.

response - The handshake the server sent in response to the request.

抛出:

InvalidDataException - Allows the client to reject the connection with the server in respect of its handshake response.

onWebsocketHandshakeSentAsClient

public void onWebsocketHandshakeSentAsClient(WebSocket conn,
                                             ClientHandshake request)
                                      throws InvalidDataException

This default implementation does not do anything which will cause the connections to always progress.

指定者:

onWebsocketHandshakeSentAsClient 在接口中 WebSocketListener

参数:

conn - The WebSocket related to this event

request - The handshake sent to the server by this websocket

抛出:

InvalidDataException - Allows the client to stop the connection from progressing

另请参阅:

WebSocketListener.onWebsocketHandshakeSentAsClient(WebSocket, ClientHandshake)

onWebsocketMessageFragment

public void onWebsocketMessageFragment(WebSocket conn,
                                       Framedata frame)

This default implementation does not do anything. Go ahead and overwrite it

指定者:

onWebsocketMessageFragment 在接口中 WebSocketListener

参数:

conn - The WebSocket instance this event is occurring on.

frame - The fragmented frame

另请参阅:

WebSocketListener.onWebsocketMessageFragment(WebSocket, Framedata)

onWebsocketPing

public void onWebsocketPing(WebSocket conn,
                            Framedata f)

This default implementation will send a pong in response to the received ping. The pong frame will have the same payload as the ping frame.

指定者:

onWebsocketPing 在接口中 WebSocketListener

参数:

conn - The WebSocket instance this event is occuring on.

f - The ping frame. Control frames may contain payload.

另请参阅:

WebSocketListener.onWebsocketPing(WebSocket, Framedata)

onWebsocketPong

public void onWebsocketPong(WebSocket conn,
                            Framedata f)

This default implementation does not do anything. Go ahead and overwrite it.

指定者:

onWebsocketPong 在接口中 WebSocketListener

参数:

conn - The WebSocket instance this event is occuring on.

f - The pong frame. Control frames may contain payload.

另请参阅:

WebSocketListener.onWebsocketPong(WebSocket, Framedata)

getFlashPolicy

public java.lang.String getFlashPolicy(WebSocket conn)
                                throws InvalidDataException

Gets the XML string that should be returned if a client requests a Flash security policy.

The default implementation allows access from all remote domains, but only on the port that this WebSocketServer is listening on.

This is specifically implemented for gitime's WebSocket client for Flash: http://github.com/gimite/web-socket-js

指定者:

getFlashPolicy 在接口中 WebSocketListener

参数:

conn - The WebSocket instance this event is occuring on.

返回:

An XML String that comforts to Flash's security policy. You MUST not include the null char at the end, it is appended automatically.

抛出:

InvalidDataException - thrown when some data that is required to generate the flash-policy like the websocket local port could not be obtained e.g because the websocket is not connected.

另请参阅:

getFlashPolicy(WebSocket)