public class WebSocketAdapter extends Object implements WebSocketListener
WebSocketListener
.
Convenient abstract class to base standard WebSocket implementations off of.
Constructor and Description |
---|
WebSocketAdapter() |
Modifier and Type | Method and 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,
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(Throwable cause)
A WebSocket exception has occurred.
|
void |
onWebSocketText(String message)
A WebSocket Text frame was received.
|
public RemoteEndpoint getRemote()
public Session getSession()
public boolean isConnected()
public boolean isNotConnected()
public void onWebSocketBinary(byte[] payload, int offset, int len)
WebSocketListener
onWebSocketBinary
in interface WebSocketListener
payload
- the raw payload array receivedoffset
- the offset in the payload array where the data startslen
- the length of bytes in the payloadpublic void onWebSocketClose(int statusCode, String reason)
WebSocketConnectionListener
The underlying Connection will be considered closed at this point.
onWebSocketClose
in interface WebSocketConnectionListener
statusCode
- the close status code. (See StatusCode
)reason
- the optional reason for the close.public void onWebSocketConnect(Session sess)
WebSocketConnectionListener
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
onWebSocketConnect
in interface WebSocketConnectionListener
sess
- the websocket session.public void onWebSocketError(Throwable cause)
WebSocketConnectionListener
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.
onWebSocketError
in interface WebSocketConnectionListener
cause
- the error that occurred.public void onWebSocketText(String message)
WebSocketListener
onWebSocketText
in interface WebSocketListener
message
- the messageCopyright © 2010 - 2020 Adobe. All Rights Reserved