org.eclipse.jetty.websocket.api

Interface WebSocketListener

All Known Implementing Classes:

WebSocketAdapter

public interface WebSocketListener

Basic WebSocket Listener interface for incoming WebSocket events.

Method Summary

Methods

Modifier and Type	Method and Description
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(Session session) A WebSocket Session has connected successfully and is ready to be used.
void	onWebSocketError(Throwable cause) A WebSocket exception has occurred.
void	onWebSocketText(String message) A WebSocket Text frame was received.

Method Detail

onWebSocketBinary

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

A WebSocket binary frame has been received.

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

void onWebSocketClose(int statusCode,
                    String reason)

A Close Event was received.

The underlying Connection will be considered closed at this point.

Parameters:

statusCode - the close status code. (See StatusCode)

reason - the optional reason for the close.

onWebSocketConnect

void onWebSocketConnect(Session session)

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

Parameters:

session - the websocket session.

onWebSocketError

void onWebSocketError(Throwable cause)

A WebSocket exception has occurred.

This is a way for the internal implementation to notify of exceptions occured 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.

Parameters:

error - the error that occurred.

onWebSocketText

void onWebSocketText(String message)

A WebSocket Text frame was received.

Parameters:

message -