org.eclipse.jetty.websocket.core.api

Class WebSocketAdapter

java.lang.Object

org.eclipse.jetty.websocket.core.api.WebSocketAdapter

All Implemented Interfaces:

WebSocketListener

public class WebSocketAdapter
extends Object
implements WebSocketListener

Default implementation of the WebSocketListener.

Convenient abstract class to base standard WebSocket implementations off of.

Constructor Summary

Constructors

Constructor and Description
WebSocketAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
WebSocketBlockingConnection	getBlockingConnection()
WebSocketConnection	getConnection()
boolean	isConnected()
boolean	isNotConnected()
void	onWebSocketBinary(byte[] payload, int offset, int len) A WebSocket binary frame has been received.
void	onWebSocketClose(int statusCode, String reason) A Close Event was received.
void	onWebSocketConnect(WebSocketConnection connection) A WebSocketConnection has connected successfully and is ready to be used.
void	onWebSocketException(WebSocketException error) A WebSocket exception has occurred.
void	onWebSocketText(String message) A WebSocket Text frame was received.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketAdapter

public WebSocketAdapter()

Method Detail

getBlockingConnection

public WebSocketBlockingConnection getBlockingConnection()

getConnection

public WebSocketConnection getConnection()

isConnected

public boolean isConnected()

isNotConnected

public boolean isNotConnected()

onWebSocketBinary

public void onWebSocketBinary(byte[] payload,
                     int offset,
                     int len)

Description copied from interface: WebSocketListener

A WebSocket binary frame has been received.

Specified by:

onWebSocketBinary in interface WebSocketListener

Parameters:

payload - the raw payload array received

offset - the offset in the payload array where the data starts

len - the length of bytes in the payload

onWebSocketClose

public void onWebSocketClose(int statusCode,
                    String reason)

Description copied from interface: WebSocketListener

A Close Event was received.

The underlying WebSocketConnection will be considered closed at this point.

Specified by:

onWebSocketClose in interface WebSocketListener

Parameters:

statusCode - the close status code. (See StatusCode)

reason - the optional reason for the close.

onWebSocketConnect

public void onWebSocketConnect(WebSocketConnection connection)

Description copied from interface: WebSocketListener

A WebSocketConnection has connected successfully and is ready to be used.

Note: It is a good idea to track this connection as a field in your object so that you can write messages back.

Specified by:

onWebSocketConnect in interface WebSocketListener

Parameters:

connection - the connection to use to send messages on.

onWebSocketException

public void onWebSocketException(WebSocketException error)

Description copied from interface: WebSocketListener

A WebSocket exception has occurred.

Usually this occurs from bad / malformed incoming packets. (example: bad UTF8 data, frames that are too big, violations of the spec)

This will result in the WebSocketConnection being closed by the implementing side.

Note: you will receive no WebSocketListener.onWebSocketClose(int, String) as this condition results in the API calling BaseConnection.close(int, String) for you.

Specified by:

onWebSocketException in interface WebSocketListener

Parameters:

error - the error that occurred.

onWebSocketText

public void onWebSocketText(String message)

Description copied from interface: WebSocketListener

A WebSocket Text frame was received.

Specified by:

onWebSocketText in interface WebSocketListener