Package io.netty.handler.codec.http.websocketx

Class WebSocketServerHandshaker

java.lang.Object

io.netty.handler.codec.http.websocketx.WebSocketServerHandshaker

Direct Known Subclasses:

WebSocketServerHandshaker00, WebSocketServerHandshaker07, WebSocketServerHandshaker08, WebSocketServerHandshaker13

public abstract class WebSocketServerHandshaker
extends java.lang.Object

Base class for server side web socket opening and closing handshakes

Field Summary

Fields

Modifier and Type	Field	Description
protected static InternalLogger	logger
static java.lang.String	SUB_PROTOCOL_WILDCARD	Use this as wildcard to support all requested sub-protocols

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebSocketServerHandshaker(WebSocketVersion version, java.lang.String uri, java.lang.String subprotocols, int maxFramePayloadLength)	Constructor specifying the destination web socket location
protected	WebSocketServerHandshaker(WebSocketVersion version, java.lang.String uri, java.lang.String subprotocols, WebSocketDecoderConfig decoderConfig)	Constructor specifying the destination web socket location

Method Summary

Modifier and Type	Method	Description
ChannelFuture	close(ChannelHandlerContext ctx, CloseWebSocketFrame frame)	Performs the closing handshake.
ChannelFuture	close(ChannelHandlerContext ctx, CloseWebSocketFrame frame, ChannelPromise promise)	Performs the closing handshake.
ChannelFuture	close(Channel channel, CloseWebSocketFrame frame)	Performs the closing handshake.
ChannelFuture	close(Channel channel, CloseWebSocketFrame frame, ChannelPromise promise)	Performs the closing handshake.
WebSocketDecoderConfig	decoderConfig()	Gets this decoder configuration.
ChannelFuture	handshake(ChannelHandlerContext ctx, FullHttpRequest req)	Performs the opening handshake.
ChannelFuture	handshake(ChannelHandlerContext ctx, FullHttpRequest req, HttpHeaders responseHeaders, ChannelPromise promise)	Performs the opening handshake When call this method you MUST NOT retain the FullHttpRequest which is passed in.
ChannelFuture	handshake(ChannelHandlerContext ctx, HttpRequest req)	Performs the opening handshake.
ChannelFuture	handshake(ChannelHandlerContext ctx, HttpRequest req, HttpHeaders responseHeaders, ChannelPromise promise)	Performs the opening handshake When call this method you MUST NOT retain the HttpRequest which is passed in.
ChannelFuture	handshake(Channel channel, FullHttpRequest req)	Performs the opening handshake.
ChannelFuture	handshake(Channel channel, FullHttpRequest req, HttpHeaders responseHeaders, ChannelPromise promise)	Performs the opening handshake When call this method you MUST NOT retain the FullHttpRequest which is passed in.
ChannelFuture	handshake(Channel channel, HttpRequest req)	Performs the opening handshake.
ChannelFuture	handshake(Channel channel, HttpRequest req, HttpHeaders responseHeaders, ChannelPromise promise)	Performs the opening handshake When call this method you MUST NOT retain the HttpRequest which is passed in.
int	maxFramePayloadLength()	Gets the maximum length for any frame's payload.
protected abstract FullHttpResponse	newHandshakeResponse(FullHttpRequest req, HttpHeaders responseHeaders)	Returns a new {@link FullHttpResponse) which will be used for as response to the handshake request.
protected abstract WebSocketFrameDecoder	newWebsocketDecoder()	Returns the decoder to use after handshake is complete.
protected abstract WebSocketFrameEncoder	newWebSocketEncoder()	Returns the encoder to use after the handshake is complete.
java.lang.String	selectedSubprotocol()	Returns the selected subprotocol.
protected java.lang.String	selectSubprotocol(java.lang.String requestedSubprotocols)	Selects the first matching supported sub protocol
java.util.Set<java.lang.String>	subprotocols()	Returns the CSV of supported sub protocols
java.lang.String	uri()	Deprecated.
WebSocketVersion	version()	Returns the version of the specification being supported

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final InternalLogger logger

SUB_PROTOCOL_WILDCARD

public static final java.lang.String SUB_PROTOCOL_WILDCARD

Use this as wildcard to support all requested sub-protocols

See Also:

Constant Field Values

Constructor Detail

WebSocketServerHandshaker

protected WebSocketServerHandshaker(WebSocketVersion version,
                                    java.lang.String uri,
                                    java.lang.String subprotocols,
                                    int maxFramePayloadLength)

Constructor specifying the destination web socket location

Parameters:

version - the protocol version

uri - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

subprotocols - CSV of supported protocols. Null if sub protocols not supported.

maxFramePayloadLength - Maximum length of a frame's payload

WebSocketServerHandshaker

protected WebSocketServerHandshaker(WebSocketVersion version,
                                    java.lang.String uri,
                                    java.lang.String subprotocols,
                                    WebSocketDecoderConfig decoderConfig)

Constructor specifying the destination web socket location

Parameters:

version - the protocol version

uri - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

subprotocols - CSV of supported protocols. Null if sub protocols not supported.

decoderConfig - Frames decoder configuration.

Method Detail

uri

@Deprecated
public java.lang.String uri()

Deprecated.

Returns the URL of the web socket

subprotocols

public java.util.Set<java.lang.String> subprotocols()

Returns the CSV of supported sub protocols

version

public WebSocketVersion version()

Returns the version of the specification being supported

maxFramePayloadLength

public int maxFramePayloadLength()

Gets the maximum length for any frame's payload.

Returns:

The maximum length for a frame's payload

decoderConfig

public WebSocketDecoderConfig decoderConfig()

Gets this decoder configuration.

Returns:

This decoder configuration.

handshake

public ChannelFuture handshake(Channel channel,
                               FullHttpRequest req)

Performs the opening handshake. When call this method you MUST NOT retain the FullHttpRequest which is passed in. When called from within a ChannelHandler you most likely want to use handshake(ChannelHandlerContext, FullHttpRequest).

Parameters:

channel - Channel

req - HTTP Request

Returns:

future The ChannelFuture which is notified once the opening handshake completes

handshake

public final ChannelFuture handshake(Channel channel,
                                     FullHttpRequest req,
                                     HttpHeaders responseHeaders,
                                     ChannelPromise promise)

Performs the opening handshake When call this method you MUST NOT retain the FullHttpRequest which is passed in. When called from within a ChannelHandler you most likely want to use handshake(ChannelHandlerContext, FullHttpRequest, HttpHeaders, ChannelPromise).

Parameters:

channel - Channel

req - HTTP Request

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

promise - the ChannelPromise to be notified when the opening handshake is done

Returns:

future the ChannelFuture which is notified when the opening handshake is done

handshake

public ChannelFuture handshake(ChannelHandlerContext ctx,
                               FullHttpRequest req)

Performs the opening handshake. When call this method you MUST NOT retain the FullHttpRequest which is passed in. The handshake response is written to the given ChannelHandlerContext, so handlers placed after the ChannelHandler the context belongs to will not see the response. The handler the context belongs to must be placed after the HTTP encoder as the response still needs to be encoded.

Parameters:

ctx - the ChannelHandlerContext to use.

req - HTTP Request

Returns:

future The ChannelFuture which is notified once the opening handshake completes

handshake

public ChannelFuture handshake(ChannelHandlerContext ctx,
                               FullHttpRequest req,
                               HttpHeaders responseHeaders,
                               ChannelPromise promise)

Performs the opening handshake When call this method you MUST NOT retain the FullHttpRequest which is passed in. The handshake response is written to the given ChannelHandlerContext, so handlers placed after the ChannelHandler the context belongs to will not see the response. The handler the context belongs to must be placed after the HTTP encoder as the response still needs to be encoded.

Parameters:

ctx - the ChannelHandlerContext to use.

req - HTTP Request

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

promise - the ChannelPromise to be notified when the opening handshake is done

Returns:

future the ChannelFuture which is notified when the opening handshake is done

handshake

public ChannelFuture handshake(Channel channel,
                               HttpRequest req)

Performs the opening handshake. When call this method you MUST NOT retain the FullHttpRequest which is passed in. When called from within a ChannelHandler you most likely want to use handshake(ChannelHandlerContext, HttpRequest).

Parameters:

channel - Channel

req - HTTP Request

Returns:

future The ChannelFuture which is notified once the opening handshake completes

handshake

public final ChannelFuture handshake(Channel channel,
                                     HttpRequest req,
                                     HttpHeaders responseHeaders,
                                     ChannelPromise promise)

Performs the opening handshake When call this method you MUST NOT retain the HttpRequest which is passed in. When called from within a ChannelHandler you most likely want to use handshake(ChannelHandlerContext, HttpRequest, HttpHeaders, ChannelPromise).

Parameters:

channel - Channel

req - HTTP Request

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

promise - the ChannelPromise to be notified when the opening handshake is done

Returns:

future the ChannelFuture which is notified when the opening handshake is done

handshake

public ChannelFuture handshake(ChannelHandlerContext ctx,
                               HttpRequest req)

Performs the opening handshake. When call this method you MUST NOT retain the HttpRequest which is passed in. The handshake response is written to the given ChannelHandlerContext, so handlers placed after the ChannelHandler the context belongs to will not see the response. The handler the context belongs to must be placed after the HTTP encoder as the response still needs to be encoded.

Parameters:

ctx - the ChannelHandlerContext to use.

req - HTTP Request

Returns:

future The ChannelFuture which is notified once the opening handshake completes

handshake

public ChannelFuture handshake(ChannelHandlerContext ctx,
                               HttpRequest req,
                               HttpHeaders responseHeaders,
                               ChannelPromise promise)

Performs the opening handshake When call this method you MUST NOT retain the HttpRequest which is passed in. The handshake response is written to the given ChannelHandlerContext, so handlers placed after the ChannelHandler the context belongs to will not see the response. The handler the context belongs to must be placed after the HTTP encoder as the response still needs to be encoded.

Parameters:

ctx - the ChannelHandlerContext to use.

req - HTTP Request

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

promise - the ChannelPromise to be notified when the opening handshake is done

Returns:

future the ChannelFuture which is notified when the opening handshake is done

newHandshakeResponse

protected abstract FullHttpResponse newHandshakeResponse(FullHttpRequest req,
                                                         HttpHeaders responseHeaders)

Returns a new {@link FullHttpResponse) which will be used for as response to the handshake request.

close

public ChannelFuture close(Channel channel,
                           CloseWebSocketFrame frame)

Performs the closing handshake. When called from within a ChannelHandler you most likely want to use close(ChannelHandlerContext, CloseWebSocketFrame).

Parameters:

channel - the Channel to use.

frame - Closing Frame that was received.

close

public ChannelFuture close(Channel channel,
                           CloseWebSocketFrame frame,
                           ChannelPromise promise)

Performs the closing handshake. When called from within a ChannelHandler you most likely want to use close(ChannelHandlerContext, CloseWebSocketFrame, ChannelPromise).

Parameters:

channel - the Channel to use.

frame - Closing Frame that was received.

promise - the ChannelPromise to be notified when the closing handshake is done

close

public ChannelFuture close(ChannelHandlerContext ctx,
                           CloseWebSocketFrame frame)

Performs the closing handshake.

Parameters:

ctx - the ChannelHandlerContext to use.

frame - Closing Frame that was received.

close

public ChannelFuture close(ChannelHandlerContext ctx,
                           CloseWebSocketFrame frame,
                           ChannelPromise promise)

Performs the closing handshake.

Parameters:

ctx - the ChannelHandlerContext to use.

frame - Closing Frame that was received.

promise - the ChannelPromise to be notified when the closing handshake is done.

selectSubprotocol

protected java.lang.String selectSubprotocol(java.lang.String requestedSubprotocols)

Selects the first matching supported sub protocol

Parameters:

requestedSubprotocols - CSV of protocols to be supported. e.g. "chat, superchat"

Returns:

First matching supported sub protocol. Null if not found.

selectedSubprotocol

public java.lang.String selectedSubprotocol()

Returns the selected subprotocol. Null if no subprotocol has been selected.

This is only available AFTER handshake() has been called.

newWebsocketDecoder

protected abstract WebSocketFrameDecoder newWebsocketDecoder()

Returns the decoder to use after handshake is complete.

newWebSocketEncoder

protected abstract WebSocketFrameEncoder newWebSocketEncoder()

Returns the encoder to use after the handshake is complete.