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

Interface WebSocketHandshaker

All Superinterfaces:

WebSocketMessage

All Known Implementing Classes:

DefaultWebSocketHandshaker

public interface WebSocketHandshaker
extends WebSocketMessage

This Message is used to handle WebSocket handshake.

Method Summary

Modifier and Type	Method and Description
io.netty.channel.ChannelFuture	cancelHandshake(int closeCode, String closeReason) Cancel the handshake with HTTP response.
String	getChannelId() Retrieve the Channel ID of the connection.
HttpCarbonRequest	getHttpCarbonRequest() Get the HttpCarbonRequest received from the client to perform the handshake.
ServerHandshakeFuture	handshake() Complete the handshake of a given request.
ServerHandshakeFuture	handshake(String[] subProtocols) Complete the handshake of a given request.
ServerHandshakeFuture	handshake(String[] subProtocols, int idleTimeout) Complete the handshake of a given request.
ServerHandshakeFuture	handshake(String[] subProtocols, int idleTimeout, io.netty.handler.codec.http.HttpHeaders responseHeaders) Complete the handshake of a given request.
ServerHandshakeFuture	handshake(String[] subProtocols, int idleTimeout, io.netty.handler.codec.http.HttpHeaders responseHeaders, int maxFramePayloadLength) Complete the handshake of a given request.
boolean	isCancelled() Check whether the handshake is cancelled in someplace or not.
boolean	isHandshakeStarted() Check whether the handshake has been started or not.
boolean	isSecure() Check whether the connection is secure or not.

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

getTarget, getWebSocketConnection, isServerMessage

Method Detail

handshake

ServerHandshakeFuture handshake()

Complete the handshake of a given request. There will not be a idle timeout for the connection if this method is used.

Returns:

the Server session for the newly created WebSocket connection.

handshake

ServerHandshakeFuture handshake(String[] subProtocols)

Complete the handshake of a given request. There will not be a idle timeout for the connection if this method is used.

Parameters:

subProtocols - Sub-Protocols which are allowed by the service.

Returns:

the Server session for the newly created WebSocket connection.

handshake

ServerHandshakeFuture handshake(String[] subProtocols,
                                int idleTimeout)

Complete the handshake of a given request. The connection will be timed out if the connection is idle for given time period.

Parameters:

subProtocols - Sub-Protocols which are allowed by the service.

idleTimeout - Idle timeout in milli-seconds for WebSocket connection.

Returns:

the handshake future.

handshake

ServerHandshakeFuture handshake(String[] subProtocols,
                                int idleTimeout,
                                io.netty.handler.codec.http.HttpHeaders responseHeaders)

Complete the handshake of a given request. The connection will be timed out if the connection is idle for given time period.

Parameters:

subProtocols - Sub-Protocols which are allowed by the service.

idleTimeout - Idle timeout in milli-seconds for WebSocket connection.

responseHeaders - Extra headers to add to the handshake response or null if no extra headers should be added

Returns:

the handshake future.

handshake

ServerHandshakeFuture handshake(String[] subProtocols,
                                int idleTimeout,
                                io.netty.handler.codec.http.HttpHeaders responseHeaders,
                                int maxFramePayloadLength)

Complete the handshake of a given request. The connection will be timed out if the connection is idle for given time period.

Parameters:

subProtocols - Sub-Protocols which are allowed by the service.

idleTimeout - Idle timeout in milli-seconds for WebSocket connection.

responseHeaders - Extra headers to add to the handshake response or null if no extra headers should be added.

maxFramePayloadLength - Maximum allowable frame payload length. Setting this value to your application's requirement may reduce denial of service attacks using long data frames.

Returns:

the handshake future.

getHttpCarbonRequest

HttpCarbonRequest getHttpCarbonRequest()

Get the HttpCarbonRequest received from the client to perform the handshake.

Returns:

the carbon request received to perform the handshake

cancelHandshake

io.netty.channel.ChannelFuture cancelHandshake(int closeCode,
                                               String closeReason)

Cancel the handshake with HTTP response.

Parameters:

closeCode - close code for cancelling the handshake.

closeReason - reason for canceling the handshake.

Returns:

the ChannelPromise created after submitting response

isCancelled

boolean isCancelled()

Check whether the handshake is cancelled in someplace or not.

Returns:

true if the handshake is cancelled.

isHandshakeStarted

boolean isHandshakeStarted()

Check whether the handshake has been started or not.

Returns:

true if the handshake has been started.

isSecure

boolean isSecure()

Check whether the connection is secure or not.

Returns:

true if the connection is secure.

getChannelId

String getChannelId()

Retrieve the Channel ID of the connection.

Returns:

the channel ID of the connection.