Top Description Fields Constructors Methods
io.netty5.handler.codec.http.websocketx

public abstract Class WebSocketServerHandshaker

extends Object
Class Inheritance
Known Direct Subclasses
io.netty5.handler.codec.http.websocketx.WebSocketServerHandshaker13
Imports
io.netty5.buffer.BufferAllocator, io.netty5.channel.Channel, .ChannelFutureListeners, .ChannelHandler, .ChannelHandlerAdapter, .ChannelHandlerContext, .ChannelOutboundInvoker, .ChannelPipeline, io.netty5.handler.codec.http.DefaultFullHttpRequest, .FullHttpRequest, .FullHttpResponse, .HttpContentCompressor, .HttpObject, .HttpObjectAggregator, .HttpRequest, .HttpRequestDecoder, .HttpResponseEncoder, .HttpServerCodec, .LastHttpContent, io.netty5.handler.codec.http.headers.HttpHeaders, io.netty5.util.ReferenceCountUtil, .Resource, io.netty5.util.concurrent.Future, .Promise, io.netty5.util.internal.EmptyArrays, io.netty5.util.internal.logging.InternalLogger, .InternalLoggerFactory, java.nio.channels.ClosedChannelException, java.util.Collections, .LinkedHashSet, .Set
Base class for server side web socket opening and closing handshakes

Field Summary

Modifier and TypeField and Description
private final WebSocketDecoderConfig
decoderConfig

protected static final InternalLogger
logger

private String
selectedSubprotocol

public static final String
SUB_PROTOCOL_WILDCARD

Use this as wildcard to support all requested sub-protocols

private final String[]
subprotocols

private final String
uri

private final WebSocketVersion
version

Constructor Summary

AccessConstructor and Description
protected
WebSocketServerHandshaker(WebSocketVersion
the protocol version
version, String
URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.
uri, String
CSV of supported protocols. Null if sub protocols not supported.
subprotocols, int
Maximum length of a frame's payload
maxFramePayloadLength)

Constructor specifying the destination web socket location

protected
WebSocketServerHandshaker(WebSocketVersion
the protocol version
version, String
URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.
uri, String
CSV of supported protocols. Null if sub protocols not supported.
subprotocols, WebSocketDecoderConfig
Frames decoder configuration.
decoderConfig)

Constructor specifying the destination web socket location

Method Summary

Modifier and TypeMethod and Description
public Future<Void>
close(Channel
the Channel to use.
channel, CloseWebSocketFrame
Closing Frame that was received.
frame)

Performs the closing handshake.

public Future<Void>
close(ChannelHandlerContext
the ChannelHandlerContext to use.
ctx, CloseWebSocketFrame
Closing Frame that was received.
frame)

Performs the closing handshake.

private static Future<Void>
close0(ChannelOutboundInvoker invoker, CloseWebSocketFrame frame)

public WebSocketDecoderConfig

Returns:

This decoder configuration.
decoderConfig()

Gets this decoder configuration.

public Future<Void>

Returns:

future The Future which is notified once the opening handshake completes
handshake(Channel
Channel
channel, FullHttpRequest
HTTP Request
req)

Performs the opening handshake.

public final Future<Void>

Returns:

future the Future which is notified when the opening handshake is done
handshake(Channel
Channel
channel, FullHttpRequest
HTTP Request
req, HttpHeaders
Extra headers to add to the handshake response or null if no extra headers should be added
responseHeaders)

Performs the opening handshake

Note that the ownership of the FullHttpRequest which is passed in belongs to the caller (ownership is not transferred to this method, and caller is responsible to close the request parameter).

public Future<Void>

Returns:

future The Future which is notified once the opening handshake completes
handshake(Channel
Channel
channel, HttpRequest
HTTP Request
req)

Performs the opening handshake.

public final Future<Void>

Returns:

future the Future which is notified when the opening handshake is done
handshake(final Channel
Channel
channel, HttpRequest
HTTP Request
req, final HttpHeaders
Extra headers to add to the handshake response or null if no extra headers should be added
responseHeaders)

Performs the opening handshake

Note that the ownership of the FullHttpRequest which is passed in belongs to the caller (ownership is not transferred to this method, and caller is responsible to close the request parameter).

public int

Returns:

The maximum length for a frame's payload
maxFramePayloadLength()

Gets the maximum length for any frame's payload.

protected abstract FullHttpResponse
newHandshakeResponse(BufferAllocator allocator, 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.

public String
selectedSubprotocol()

Returns the selected subprotocol.

protected String

Returns:

First matching supported sub protocol. Null if not found.
selectSubprotocol(String
CSV of protocols to be supported. e.g. "chat, superchat"
requestedSubprotocols)

Selects the first matching supported sub protocol

public Set<String>
subprotocols()

Returns the CSV of supported sub protocols

public String
uri()

Returns the URL of the web socket

public WebSocketVersion
version()

Returns the version of the specification being supported

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

decoderConfigback to summary
private final WebSocketDecoderConfig decoderConfig
loggerback to summary
protected static final InternalLogger logger
selectedSubprotocolback to summary
private String selectedSubprotocol
SUB_PROTOCOL_WILDCARDback to summary
public static final String SUB_PROTOCOL_WILDCARD

Use this as wildcard to support all requested sub-protocols

subprotocolsback to summary
private final String[] subprotocols
uriback to summary
private final String uri
versionback to summary
private final WebSocketVersion version

Constructor Detail

WebSocketServerHandshakerback to summary
protected WebSocketServerHandshaker(WebSocketVersion version, String uri, String subprotocols, int maxFramePayloadLength)

Constructor specifying the destination web socket location

Parameters
version:WebSocketVersion

the protocol version

uri:String

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

subprotocols:String

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

maxFramePayloadLength:int

Maximum length of a frame's payload

WebSocketServerHandshakerback to summary
protected WebSocketServerHandshaker(WebSocketVersion version, String uri, String subprotocols, WebSocketDecoderConfig decoderConfig)

Constructor specifying the destination web socket location

Parameters
version:WebSocketVersion

the protocol version

uri:String

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

subprotocols:String

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

decoderConfig:WebSocketDecoderConfig

Frames decoder configuration.

Method Detail

closeback to summary
public Future<Void> 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:Channel

the Channel to use.

frame:CloseWebSocketFrame

Closing Frame that was received.

closeback to summary
public Future<Void> close(ChannelHandlerContext ctx, CloseWebSocketFrame frame)

Performs the closing handshake.

Parameters
ctx:ChannelHandlerContext

the ChannelHandlerContext to use.

frame:CloseWebSocketFrame

Closing Frame that was received.

close0back to summary
private static Future<Void> close0(ChannelOutboundInvoker invoker, CloseWebSocketFrame frame)
decoderConfigback to summary
public WebSocketDecoderConfig decoderConfig()

Gets this decoder configuration.

Returns:WebSocketDecoderConfig

This decoder configuration.

handshakeback to summary
public Future<Void> handshake(Channel channel, FullHttpRequest req)

Performs the opening handshake. Note that the ownership of the FullHttpRequest which is passed in belongs to the caller (ownership is not transferred to this method, and caller is responsible to close the request parameter).

Parameters
channel:Channel

Channel

req:FullHttpRequest

HTTP Request

Returns:Future<Void>

future The Future which is notified once the opening handshake completes

handshakeback to summary
public final Future<Void> handshake(Channel channel, FullHttpRequest req, HttpHeaders responseHeaders)

Performs the opening handshake

Note that the ownership of the FullHttpRequest which is passed in belongs to the caller (ownership is not transferred to this method, and caller is responsible to close the request parameter).

Parameters
channel:Channel

Channel

req:FullHttpRequest

HTTP Request

responseHeaders:HttpHeaders

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

Returns:Future<Void>

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

handshakeback to summary
public Future<Void> handshake(Channel channel, HttpRequest req)

Performs the opening handshake. Note that the ownership of the FullHttpRequest which is passed in belongs to the caller (ownership is not transferred to this method, and caller is responsible to close the request parameter).

Parameters
channel:Channel

Channel

req:HttpRequest

HTTP Request

Returns:Future<Void>

future The Future which is notified once the opening handshake completes

handshakeback to summary
public final Future<Void> handshake(final Channel channel, HttpRequest req, final HttpHeaders responseHeaders)

Performs the opening handshake

Note that the ownership of the FullHttpRequest which is passed in belongs to the caller (ownership is not transferred to this method, and caller is responsible to close the request parameter).

Parameters
channel:Channel

Channel

req:HttpRequest

HTTP Request

responseHeaders:HttpHeaders

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

Returns:Future<Void>

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

maxFramePayloadLengthback to summary
public int maxFramePayloadLength()

Gets the maximum length for any frame's payload.

Returns:int

The maximum length for a frame's payload

newHandshakeResponseback to summary
protected abstract FullHttpResponse newHandshakeResponse(BufferAllocator allocator, FullHttpRequest req, HttpHeaders responseHeaders)

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

newWebsocketDecoderback to summary
protected abstract WebSocketFrameDecoder newWebsocketDecoder()

Returns the decoder to use after handshake is complete.

newWebSocketEncoderback to summary
protected abstract WebSocketFrameEncoder newWebSocketEncoder()

Returns the encoder to use after the handshake is complete.

selectedSubprotocolback to summary
public String selectedSubprotocol()

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

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

selectSubprotocolback to summary
protected String selectSubprotocol(String requestedSubprotocols)

Selects the first matching supported sub protocol

Parameters
requestedSubprotocols:String

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

Returns:String

First matching supported sub protocol. Null if not found.

subprotocolsback to summary
public Set<String> subprotocols()

Returns the CSV of supported sub protocols

uriback to summary
public String uri()

Returns the URL of the web socket

versionback to summary
public WebSocketVersion version()

Returns the version of the specification being supported