public interface WebSocketListener
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.
|
void onWebSocketBinary(byte[] payload, int offset, int len)
payload
- the raw payload array receivedoffset
- the offset in the payload array where the data startslen
- the length of bytes in the payloadvoid onWebSocketClose(int statusCode, String reason)
The underlying Connection will be considered closed at this point.
statusCode
- the close status code. (See StatusCode
)reason
- the optional reason for the close.void onWebSocketConnect(Session session)
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
session
- the websocket session.void onWebSocketError(Throwable cause)
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.
error
- the error that occurred.void onWebSocketText(String message)
message
- Copyright © 1995-2014 Mort Bay Consulting. All Rights Reserved.