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

Interface WebSocketConnectorFuture

All Known Subinterfaces:

ClientHandshakeFuture, ServerConnectorFuture

All Known Implementing Classes:

DefaultClientHandshakeFuture, DefaultWebSocketConnectorFuture, HttpWsServerConnectorFuture

public interface WebSocketConnectorFuture

Connector Future for WebSocket events.

Method Summary

Modifier and Type	Method and Description
void	notifyWebSocketIdleTimeout(WebSocketControlMessage controlMessage) Notify idle timeout of WebSocket connection.
void	notifyWebSocketListener(WebSocketBinaryMessage binaryMessage) Notify incoming WebSocket binary message for the listener.
void	notifyWebSocketListener(WebSocketCloseMessage closeMessage) Notify WebSocket close message to the user.
void	notifyWebSocketListener(WebSocketConnection webSocketConnection) Notify incoming WebSocket connection closure for the listener.
void	notifyWebSocketListener(WebSocketConnection webSocketConnection, Throwable throwable) Notify any error occurred in transport for the listener.
void	notifyWebSocketListener(WebSocketControlMessage controlMessage) Notify incoming WebSocket pong message for the listener.
void	notifyWebSocketListener(WebSocketHandshaker webSocketHandshaker) Notify WebSocket connection initialization for the listener.
void	notifyWebSocketListener(WebSocketTextMessage textMessage) Notify incoming WebSocket text message for the listener.
void	setWebSocketConnectorListener(WebSocketConnectorListener connectorListener) Set Connector listener for WebSocket.

Method Detail

setWebSocketConnectorListener

void setWebSocketConnectorListener(WebSocketConnectorListener connectorListener)

Set Connector listener for WebSocket.

Parameters:

connectorListener - Connector listener for WebSocket

notifyWebSocketListener

void notifyWebSocketListener(WebSocketHandshaker webSocketHandshaker)
                      throws WebSocketConnectorException

Notify WebSocket connection initialization for the listener.

Parameters:

webSocketHandshaker - WebSocketHandshaker to notify connection initialization

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

void notifyWebSocketListener(WebSocketTextMessage textMessage)
                      throws WebSocketConnectorException

Notify incoming WebSocket text message for the listener.

Parameters:

textMessage - WebSocketTextMessage to notify incoming WebSocket text message

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

void notifyWebSocketListener(WebSocketBinaryMessage binaryMessage)
                      throws WebSocketConnectorException

Notify incoming WebSocket binary message for the listener.

Parameters:

binaryMessage - WebSocketBinaryMessage to notify incoming WebSocket binary message

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

void notifyWebSocketListener(WebSocketControlMessage controlMessage)
                      throws WebSocketConnectorException

Notify incoming WebSocket pong message for the listener.

Parameters:

controlMessage - WebSocketControlMessage to Notify incoming WebSocket pong message

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

void notifyWebSocketListener(WebSocketCloseMessage closeMessage)
                      throws WebSocketConnectorException

Notify WebSocket close message to the user.

Parameters:

closeMessage - WebSocketCloseMessage to notify incoming WebSocket connection closure

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

void notifyWebSocketListener(WebSocketConnection webSocketConnection)
                      throws WebSocketConnectorException

Notify incoming WebSocket connection closure for the listener.

Parameters:

webSocketConnection - WebSocketConnection to notify incoming WebSocket connection closure

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

void notifyWebSocketListener(WebSocketConnection webSocketConnection,
                             Throwable throwable)
                      throws WebSocketConnectorException

Notify any error occurred in transport for the listener.

Parameters:

webSocketConnection - WebSocketConnection which causes the error

throwable - Throwable error occurred

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketIdleTimeout

void notifyWebSocketIdleTimeout(WebSocketControlMessage controlMessage)
                         throws WebSocketConnectorException

Notify idle timeout of WebSocket connection.

Parameters:

controlMessage - Indicate WebSocket connection timeout

Throws:

WebSocketConnectorException - if any error occurred during notification to the listener