org.wso2.transport.http.netty.contractimpl.websocket

Class DefaultWebSocketConnectorFuture

java.lang.Object

org.wso2.transport.http.netty.contractimpl.websocket.DefaultWebSocketConnectorFuture

All Implemented Interfaces:

WebSocketConnectorFuture

Direct Known Subclasses:

DefaultClientHandshakeFuture, HttpWsServerConnectorFuture

public class DefaultWebSocketConnectorFuture
extends Object
implements WebSocketConnectorFuture

Default implementation of WebSocketConnectorFuture.

Constructor Summary

Constructors

Constructor and Description
DefaultWebSocketConnectorFuture()

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 wsConnectorListener) Set Connector listener for WebSocket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultWebSocketConnectorFuture

public DefaultWebSocketConnectorFuture()

Method Detail

setWebSocketConnectorListener

public void setWebSocketConnectorListener(WebSocketConnectorListener wsConnectorListener)

Description copied from interface: WebSocketConnectorFuture

Set Connector listener for WebSocket.

Specified by:

setWebSocketConnectorListener in interface WebSocketConnectorFuture

Parameters:

wsConnectorListener - Connector listener for WebSocket

notifyWebSocketListener

public void notifyWebSocketListener(WebSocketHandshaker webSocketHandshaker)
                             throws WebSocketConnectorException

Description copied from interface: WebSocketConnectorFuture

Notify WebSocket connection initialization for the listener.

Specified by:

notifyWebSocketListener in interface WebSocketConnectorFuture

Parameters:

webSocketHandshaker - WebSocketHandshaker to notify connection initialization

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

public void notifyWebSocketListener(WebSocketTextMessage textMessage)
                             throws WebSocketConnectorException

Description copied from interface: WebSocketConnectorFuture

Notify incoming WebSocket text message for the listener.

Specified by:

notifyWebSocketListener in interface WebSocketConnectorFuture

Parameters:

textMessage - WebSocketTextMessage to notify incoming WebSocket text message

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

public void notifyWebSocketListener(WebSocketBinaryMessage binaryMessage)
                             throws WebSocketConnectorException

Description copied from interface: WebSocketConnectorFuture

Notify incoming WebSocket binary message for the listener.

Specified by:

notifyWebSocketListener in interface WebSocketConnectorFuture

Parameters:

binaryMessage - WebSocketBinaryMessage to notify incoming WebSocket binary message

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

public void notifyWebSocketListener(WebSocketControlMessage controlMessage)
                             throws WebSocketConnectorException

Description copied from interface: WebSocketConnectorFuture

Notify incoming WebSocket pong message for the listener.

Specified by:

notifyWebSocketListener in interface WebSocketConnectorFuture

Parameters:

controlMessage - WebSocketControlMessage to Notify incoming WebSocket pong message

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

public void notifyWebSocketListener(WebSocketCloseMessage closeMessage)
                             throws WebSocketConnectorException

Description copied from interface: WebSocketConnectorFuture

Notify WebSocket close message to the user.

Specified by:

notifyWebSocketListener in interface WebSocketConnectorFuture

Parameters:

closeMessage - WebSocketCloseMessage to notify incoming WebSocket connection closure

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketListener

public void notifyWebSocketListener(WebSocketConnection webSocketConnection,
                                    Throwable throwable)
                             throws WebSocketConnectorException

Description copied from interface: WebSocketConnectorFuture

Notify any error occurred in transport for the listener.

Specified by:

notifyWebSocketListener in interface WebSocketConnectorFuture

Parameters:

webSocketConnection - WebSocketConnection which causes the error

throwable - Throwable error occurred

Throws:

WebSocketConnectorException - if any error occurred during the notification

notifyWebSocketIdleTimeout

public void notifyWebSocketIdleTimeout(WebSocketControlMessage controlMessage)
                                throws WebSocketConnectorException

Description copied from interface: WebSocketConnectorFuture

Notify idle timeout of WebSocket connection.

Specified by:

notifyWebSocketIdleTimeout in interface WebSocketConnectorFuture

Parameters:

controlMessage - Indicate WebSocket connection timeout

Throws:

WebSocketConnectorException - if any error occurred during notification to the listener

notifyWebSocketListener

public void notifyWebSocketListener(WebSocketConnection webSocketConnection)
                             throws WebSocketConnectorException

Description copied from interface: WebSocketConnectorFuture

Notify incoming WebSocket connection closure for the listener.

Specified by:

notifyWebSocketListener in interface WebSocketConnectorFuture

Parameters:

webSocketConnection - WebSocketConnection to notify incoming WebSocket connection closure

Throws:

WebSocketConnectorException - if any error occurred during the notification