Java-WebSocket 1.6.0 · org.java_websocket.WebSocketAdapter

Modifier and Type	Field and Description
private PingFrame	pingFrame

Access	Constructor and Description
public	WebSocketAdapter()

Method Summary

Modifier and Type	Method and Description
public PingFrame	Returns: PingFrame to be sent. onPreparePing(WebSocket The `WebSocket` connection from which the ping frame will be sent. conn) Implements org.java_websocket.WebSocketListener.onPreparePing. Default implementation for onPreparePing, returns a (cached) PingFrame that has no application data.
public void	onWebsocketHandshakeReceivedAsClient(WebSocket conn, ClientHandshake request, ServerHandshake response) Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsClient. Called on the client side when the socket connection is first established, and the WebSocketImpl handshake response has been received.
public ServerHandshakeBuilder	onWebsocketHandshakeReceivedAsServer(WebSocket conn, Draft draft, ClientHandshake request) Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsServer. This default implementation does not do anything.
public void	onWebsocketHandshakeSentAsClient(WebSocket conn, ClientHandshake request) Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeSentAsClient. This default implementation does not do anything which will cause the connections to always progress.
public void	onWebsocketPing(WebSocket conn, Framedata f) Implements org.java_websocket.WebSocketListener.onWebsocketPing. This default implementation will send a pong in response to the received ping.
public void	onWebsocketPong(WebSocket conn, Framedata f) Implements org.java_websocket.WebSocketListener.onWebsocketPong. This default implementation does not do anything.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

pingFrame	back to summary
private PingFrame pingFrame

WebSocketAdapter	back to summary
public WebSocketAdapter()

Method Detail

onPreparePing back to summary

onPreparePing	back to summary
public PingFrame onPreparePing(WebSocket conn) Implements org.java_websocket.WebSocketListener.onPreparePing. Default implementation for onPreparePing, returns a (cached) PingFrame that has no application data. Parameters conn:WebSocket The `WebSocket` connection from which the ping frame will be sent. Returns:PingFrame PingFrame to be sent. Annotations @Override See Also `org.java_websocket.WebSocketListener#onPreparePing(WebSocket)`

public PingFrame onPreparePing(WebSocket conn)

Implements org.java_websocket.WebSocketListener.onPreparePing.

Default implementation for onPreparePing, returns a (cached) PingFrame that has no application data.

Parameters

conn:WebSocket: The WebSocket connection from which the ping frame will be sent.

Returns:PingFrame

PingFrame to be sent.

Annotations

@Override

onWebsocketHandshakeReceivedAsClient	back to summary
public void onWebsocketHandshakeReceivedAsClient(WebSocket conn, ClientHandshake request, ServerHandshake response) throws InvalidDataException Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsClient. Doc from org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsClient. Called on the client side when the socket connection is first established, and the WebSocketImpl handshake response has been received. Annotations @Override Exceptions InvalidDataException: Allows the client to reject the connection with the server in respect of its handshake response.

onWebsocketHandshakeReceivedAsClient

back to summary

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

Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsClient.

Doc from org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsClient.

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

Annotations

@Override

Exceptions

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

onWebsocketHandshakeReceivedAsServer back to summary

onWebsocketHandshakeReceivedAsServer	back to summary
public ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer(WebSocket conn, Draft draft, ClientHandshake request) throws InvalidDataException Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsServer. This default implementation does not do anything. Go ahead and overwrite it. Annotations @Override Exceptions InvalidDataException: Doc from org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsServer. Throwing this exception will cause this handshake to be rejected See Also `org.java_websocket.WebSocketListener#onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake)`

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

Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsServer.

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

Annotations

@Override

Exceptions

InvalidDataException:

Doc from org.java_websocket.WebSocketListener.onWebsocketHandshakeReceivedAsServer.

Throwing this exception will cause this handshake to be rejected

onWebsocketHandshakeSentAsClient back to summary

onWebsocketHandshakeSentAsClient	back to summary
public void onWebsocketHandshakeSentAsClient(WebSocket conn, ClientHandshake request) throws InvalidDataException Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeSentAsClient. This default implementation does not do anything which will cause the connections to always progress. Annotations @Override Exceptions InvalidDataException: Doc from org.java_websocket.WebSocketListener.onWebsocketHandshakeSentAsClient. Allows the client to stop the connection from progressing See Also `org.java_websocket.WebSocketListener#onWebsocketHandshakeSentAsClient(WebSocket, ClientHandshake)`

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

Implements org.java_websocket.WebSocketListener.onWebsocketHandshakeSentAsClient.

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

Annotations

@Override

Exceptions

InvalidDataException:

Doc from org.java_websocket.WebSocketListener.onWebsocketHandshakeSentAsClient.

Allows the client to stop the connection from progressing

onWebsocketPing back to summary

onWebsocketPing	back to summary
public void onWebsocketPing(WebSocket conn, Framedata f) Implements org.java_websocket.WebSocketListener.onWebsocketPing. 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. Annotations @Override See Also `org.java_websocket.WebSocketListener#onWebsocketPing(WebSocket, Framedata)`

public void onWebsocketPing(WebSocket conn, Framedata f)

Implements org.java_websocket.WebSocketListener.onWebsocketPing.

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.

Annotations

@Override

onWebsocketPong back to summary

onWebsocketPong	back to summary
public void onWebsocketPong(WebSocket conn, Framedata f) Implements org.java_websocket.WebSocketListener.onWebsocketPong. This default implementation does not do anything. Go ahead and overwrite it. Annotations @Override See Also `org.java_websocket.WebSocketListener#onWebsocketPong(WebSocket, Framedata)`

public void onWebsocketPong(WebSocket conn, Framedata f)

Implements org.java_websocket.WebSocketListener.onWebsocketPong.

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

Annotations

@Override

public abstract Class WebSocketAdapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail