Package org.eclipse.jetty.websocket.api

Class WebSocketAdapter

java.lang.Object

org.eclipse.jetty.websocket.api.WebSocketAdapter

All Implemented Interfaces:

WebSocketConnectionListener, WebSocketListener

Direct Known Subclasses:

NoOpEndpoint

public class WebSocketAdapter
extends java.lang.Object
implements WebSocketListener

Default implementation of the WebSocketListener.

Convenient abstract class to base standard WebSocket implementations off of.

Constructor Summary

Constructors

Constructor	Description
WebSocketAdapter()

Method Summary

Modifier and Type	Method	Description
RemoteEndpoint	getRemote()
Session	getSession()
boolean	isConnected()
boolean	isNotConnected()
void	onWebSocketBinary(byte[] payload, int offset, int len)	A WebSocket binary frame has been received.
void	onWebSocketClose(int statusCode, java.lang.String reason)	A Close Event was received.
void	onWebSocketConnect(Session sess)	A WebSocket Session has connected successfully and is ready to be used.
void	onWebSocketError(java.lang.Throwable cause)	A WebSocket exception has occurred.
void	onWebSocketText(java.lang.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

getRemote

public RemoteEndpoint getRemote()

getSession

public Session getSession()

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

Description copied from interface: WebSocketConnectionListener

A Close Event was received.

The underlying Connection will be considered closed at this point.

Specified by:

onWebSocketClose in interface WebSocketConnectionListener

Parameters:

statusCode - the close status code. (See StatusCode)

reason - the optional reason for the close.

onWebSocketConnect

public void onWebSocketConnect(Session sess)

Description copied from interface: WebSocketConnectionListener

A WebSocket Session has connected successfully and is ready to be used.

Note: It is a good idea to track this session as a field in your object so that you can write messages back via the RemoteEndpoint

Specified by:

onWebSocketConnect in interface WebSocketConnectionListener

Parameters:

sess - the websocket session.

onWebSocketError

public void onWebSocketError(java.lang.Throwable cause)

Description copied from interface: WebSocketConnectionListener

A WebSocket exception has occurred.

This is a way for the internal implementation to notify of exceptions occurred during the processing of websocket.

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 Session being closed by the implementing side.

Specified by:

onWebSocketError in interface WebSocketConnectionListener

Parameters:

cause - the error that occurred.

onWebSocketText

public void onWebSocketText(java.lang.String message)

Description copied from interface: WebSocketListener

A WebSocket Text frame was received.

Specified by:

onWebSocketText in interface WebSocketListener

Parameters:

message - the message