org.wso2.transport.http.netty.contract.websocket

Interface WebSocketConnectorListener

public interface WebSocketConnectorListener

Message processor for WebSocket inbound messages.

Method Summary

Modifier and Type	Method and Description
void	onClose(WebSocketConnection webSocketConnection) This lets the listener know when the connection closes.
void	onError(WebSocketConnection webSocketConnection, Throwable throwable) Trigger any transport error.
void	onHandshake(WebSocketHandshaker webSocketHandshaker) Trigger WebSocket handshake.
void	onIdleTimeout(WebSocketControlMessage controlMessage) This is triggered in a IdleTimeout for WebSocket.
void	onMessage(WebSocketBinaryMessage binaryMessage) Trigger incoming WebSocket binary messages.
void	onMessage(WebSocketCloseMessage closeMessage) Trigger incoming WebSocket close messages.
void	onMessage(WebSocketControlMessage controlMessage) Trigger incoming WebSocket control messages.
void	onMessage(WebSocketTextMessage textMessage) Trigger incoming WebSocket text messages.

Method Detail

onHandshake

void onHandshake(WebSocketHandshaker webSocketHandshaker)

Trigger WebSocket handshake. This will initialize a client connection for WebSocket server connector.

Parameters:

webSocketHandshaker - WebSocketHandshaker to initialize connection.

onMessage

void onMessage(WebSocketTextMessage textMessage)

Trigger incoming WebSocket text messages.

Parameters:

textMessage - WebSocketTextMessage to process text messages.

onMessage

void onMessage(WebSocketBinaryMessage binaryMessage)

Trigger incoming WebSocket binary messages.

Parameters:

binaryMessage - WebSocketBinaryMessage to process binary messages.

onMessage

void onMessage(WebSocketControlMessage controlMessage)

Trigger incoming WebSocket control messages.

Parameters:

controlMessage - WebSocketControlMessage to indicate a incoming pong messages.

onMessage

void onMessage(WebSocketCloseMessage closeMessage)

Trigger incoming WebSocket close messages.

Parameters:

closeMessage - WebSocketCloseMessage to indicate incoming close messages.

onClose

void onClose(WebSocketConnection webSocketConnection)

This lets the listener know when the connection closes. This method will be called only after the user is notified of a close message or an error message if one is available. It is also possible that this method is called without a close message or an error message. Also note that this method will be called only after the futures of connection closure methods return.

Parameters:

webSocketConnection - WebSocketConnection which gets closed.

onError

void onError(WebSocketConnection webSocketConnection,
             Throwable throwable)

Trigger any transport error.

Parameters:

webSocketConnection - WebSocketConnection which causes the error.

throwable - error received from transport.

onIdleTimeout

void onIdleTimeout(WebSocketControlMessage controlMessage)

This is triggered in a IdleTimeout for WebSocket.

Parameters:

controlMessage - message which indicates idle timeout.