Package com.iizix.nio
Interface WebSocketCommListener
- All Known Subinterfaces:
IServerWebSocketCommListener
- All Known Implementing Classes:
AbstractEndPoint,LoadBalancerEndPoint,RemoteBuilderEndPoint,ServerSession,VirtualizedMonitorEndPoint
public interface WebSocketCommListener
The WebSocket communication listener.
- Author:
- Christopher Mindus
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intAbnormal Closure: iOS causes 1006 "Read EOF" if Safari is closed, or "Harsh disconnect" if just left alone for a long time.static final intGoing Away: sent when e.g.static final intInternal Error.static final intInvalid frame payload data.static final intMandatory Ext.static final intMessage Too Big.static final intNo Status Received: send when e.g.static final intNormal Closure.static final intPolicy Violation.static final intProtocol error.static final intService Restart.static final intTLS handshakestatic final intTry Again Later.static final intUnsupported Data.Method Summary
Modifier and TypeMethodDescriptionvoidonCommClosed(IWebSocketComm comm, int code, String reason) Called when the communication link is closed.voidonCommClosing(IWebSocketComm comm) Called when the communication link is closing.voidCalled when the communication link is connected.voidonCommData(IWebSocketComm comm, byte[] data, int offset, int len) Called when the communication link has received binary data.voidonCommData(IWebSocketComm comm, String data) Called when the communication link has received String data.voidonCommError(IWebSocketComm comm, Throwable e) Called when the communication link is closed.voidonCommHeartBeat(IWebSocketComm comm, long duration) Called when a heart-beat frame is received.voidonCommOpen(IWebSocketComm comm) Called when the communication link is opened.voidonCommTimeout(IWebSocketComm comm, boolean isReadTimeout) Called when the communication link has timed out on a read or write operation.
Field Details
CC_NORMAL
static final int CC_NORMALNormal Closure.- See Also:
CC_GOING_AWAY
static final int CC_GOING_AWAYGoing Away: sent when e.g. IE closes a window.- See Also:
CC_PROTOCOL_ERROR
static final int CC_PROTOCOL_ERRORProtocol error.- See Also:
CC_UNSUPPORTED_DATA
static final int CC_UNSUPPORTED_DATAUnsupported Data.- See Also:
CC_NO_STATUS_RECEIVED
static final int CC_NO_STATUS_RECEIVEDNo Status Received: send when e.g. JS performs Close without code/reason.- See Also:
CC_ABNORMAL_CLOSURE
static final int CC_ABNORMAL_CLOSUREAbnormal Closure: iOS causes 1006 "Read EOF" if Safari is closed, or "Harsh disconnect" if just left alone for a long time.- See Also:
CC_INVALID_PAYLOAD_DATA
static final int CC_INVALID_PAYLOAD_DATAInvalid frame payload data.- See Also:
CC_POLICY_VIOLATION
static final int CC_POLICY_VIOLATIONPolicy Violation.- See Also:
CC_MESSAGE_TOO_BIG
static final int CC_MESSAGE_TOO_BIGMessage Too Big.- See Also:
CC_MANDATORY_EXT
static final int CC_MANDATORY_EXTMandatory Ext.- See Also:
CC_INTERNAL_ERROR
static final int CC_INTERNAL_ERRORInternal Error.- See Also:
CC_SERVICE_RESTART
static final int CC_SERVICE_RESTARTService Restart.- See Also:
CC_TRY_AGAIN_LATER
static final int CC_TRY_AGAIN_LATERTry Again Later.- See Also:
CC_TLS_HANDSHAKE
static final int CC_TLS_HANDSHAKETLS handshake- See Also:
Method Details
onCommOpen
Called when the communication link is opened.- Parameters:
comm- The WebSocket communication instance.
onCommConnected
Called when the communication link is connected.- Parameters:
comm- The WebSocket communication instance.
onCommData
Called when the communication link has received binary data.- Parameters:
comm- The WebSocket communication instance.data- The data byte array.offset- Offset in buffer.len- Length of data.
onCommData
Called when the communication link has received String data.- Parameters:
comm- The WebSocket communication instance.data- The String data.
onCommHeartBeat
Called when a heart-beat frame is received.- Parameters:
comm- The WebSocket communication instance.duration- Duration of the PING-PONG message exchange in milliseconds.
onCommTimeout
Called when the communication link has timed out on a read or write operation.- Parameters:
comm- The WebSocket communication instance.isReadTimeout- Flag indicating read timeout when true, false indicates write timeout.
onCommError
Called when the communication link is closed.- Parameters:
comm- The WebSocket communication instance.e- The exception.
onCommClosing
Called when the communication link is closing.- Parameters:
comm- The WebSocket communication instance.
onCommClosed
Called when the communication link is closed.- Parameters:
comm- The WebSocket communication instance.code- The reason code for closure.reason- The reason string explanation for closure.