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

Interface ClientHandshakeFuture

All Superinterfaces:

WebSocketConnectorFuture

All Known Implementing Classes:

DefaultClientHandshakeFuture

public interface ClientHandshakeFuture
extends WebSocketConnectorFuture

Future for WebSocket handshake.

Method Summary

Modifier and Type	Method and Description
void	notifyError(Throwable throwable, HttpCarbonResponse response) Notify any error occurred during the handshake.
void	notifySuccess(WebSocketConnection webSocketConnection, HttpCarbonResponse response) Notify the success of the WebSocket handshake.
void	setClientHandshakeListener(ClientHandshakeListener serverHandshakeListener) Set the listener for WebSocket handshake.

Methods inherited from interface org.wso2.transport.http.netty.contract.websocket.WebSocketConnectorFuture

notifyWebSocketIdleTimeout, notifyWebSocketListener, notifyWebSocketListener, notifyWebSocketListener, notifyWebSocketListener, notifyWebSocketListener, notifyWebSocketListener, notifyWebSocketListener, setWebSocketConnectorListener

Method Detail

setClientHandshakeListener

void setClientHandshakeListener(ClientHandshakeListener serverHandshakeListener)

Set the listener for WebSocket handshake.

Parameters:

serverHandshakeListener - Listener for WebSocket handshake.

notifySuccess

void notifySuccess(WebSocketConnection webSocketConnection,
                   HttpCarbonResponse response)

Notify the success of the WebSocket handshake.

Parameters:

webSocketConnection - WebSocketConnection for the successful connection.

response - HttpCarbonResponse received from server.

notifyError

void notifyError(Throwable throwable,
                 HttpCarbonResponse response)

Notify any error occurred during the handshake.

Parameters:

throwable - error occurred during handshake.

response - HttpCarbonResponse received from server or null if error occurred before response is received.