Module io.netty5.codec.http

Package io.netty5.handler.codec.http.websocketx

Class WebSocketServerHandshaker13

java.lang.Object

io.netty5.handler.codec.http.websocketx.WebSocketServerHandshaker

io.netty5.handler.codec.http.websocketx.WebSocketServerHandshaker13

public class WebSocketServerHandshaker13
extends WebSocketServerHandshaker

Performs server side opening and closing handshakes for RFC 6455 (originally web socket specification draft-ietf-hybi-thewebsocketprotocol-17).

Field Summary

Fields inherited from class io.netty5.handler.codec.http.websocketx.WebSocketServerHandshaker

logger, SUB_PROTOCOL_WILDCARD

Constructor Summary

Constructors

Constructor	Description
WebSocketServerHandshaker13(String webSocketURL, String subprotocols, boolean allowExtensions, int maxFramePayloadLength)	Constructor specifying the destination web socket location
WebSocketServerHandshaker13(String webSocketURL, String subprotocols, boolean allowExtensions, int maxFramePayloadLength, boolean allowMaskMismatch)	Constructor specifying the destination web socket location
WebSocketServerHandshaker13(String webSocketURL, String subprotocols, WebSocketDecoderConfig decoderConfig)	Constructor specifying the destination web socket location

Method Summary

Modifier and Type	Method	Description
protected FullHttpResponse	newHandshakeResponse(BufferAllocator allocator, FullHttpRequest req, HttpHeaders headers)	Handle the web socket handshake for the web socket specification HyBi versions 13-17.
protected WebSocketFrameDecoder	newWebsocketDecoder()	Returns the decoder to use after handshake is complete.
protected WebSocketFrameEncoder	newWebSocketEncoder()	Returns the encoder to use after the handshake is complete.

Methods inherited from class io.netty5.handler.codec.http.websocketx.WebSocketServerHandshaker

close, close, decoderConfig, handshake, handshake, handshake, handshake, maxFramePayloadLength, selectedSubprotocol, selectSubprotocol, subprotocols, uri, version

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketServerHandshaker13

public WebSocketServerHandshaker13(String webSocketURL,
                                   String subprotocols,
                                   boolean allowExtensions,
                                   int maxFramePayloadLength)

Constructor specifying the destination web socket location

Parameters:

webSocketURL - 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

allowExtensions - Allow extensions to be used in the reserved bits of the web socket frame

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

WebSocketServerHandshaker13

public WebSocketServerHandshaker13(String webSocketURL,
                                   String subprotocols,
                                   boolean allowExtensions,
                                   int maxFramePayloadLength,
                                   boolean allowMaskMismatch)

Constructor specifying the destination web socket location

Parameters:

webSocketURL - 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

allowExtensions - Allow extensions to be used in the reserved bits of the web socket frame

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

allowMaskMismatch - When set to true, frames which are not masked properly according to the standard will still be accepted.

WebSocketServerHandshaker13

public WebSocketServerHandshaker13(String webSocketURL,
                                   String subprotocols,
                                   WebSocketDecoderConfig decoderConfig)

Constructor specifying the destination web socket location

Parameters:

webSocketURL - 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

decoderConfig - Frames decoder configuration.

Method Detail

newHandshakeResponse

protected FullHttpResponse newHandshakeResponse(BufferAllocator allocator,
                                                FullHttpRequest req,
                                                HttpHeaders headers)

Handle the web socket handshake for the web socket specification HyBi versions 13-17. Versions 13-17 share the same wire protocol.

Browser request to the server:

 GET /chat HTTP/1.1
 Host: server.example.com
 Upgrade: websocket
 Connection: Upgrade
 Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
 Origin: http://example.com
 Sec-WebSocket-Protocol: chat, superchat
 Sec-WebSocket-Version: 13
 

Server response:

 HTTP/1.1 101 Switching Protocols
 Upgrade: websocket
 Connection: Upgrade
 Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
 Sec-WebSocket-Protocol: chat
 

Specified by:

newHandshakeResponse in class WebSocketServerHandshaker

newWebsocketDecoder

protected WebSocketFrameDecoder newWebsocketDecoder()

Description copied from class: WebSocketServerHandshaker

Returns the decoder to use after handshake is complete.

Specified by:

newWebsocketDecoder in class WebSocketServerHandshaker

newWebSocketEncoder

protected WebSocketFrameEncoder newWebSocketEncoder()

Description copied from class: WebSocketServerHandshaker

Returns the encoder to use after the handshake is complete.

Specified by:

newWebSocketEncoder in class WebSocketServerHandshaker