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

Class WebSocketServerHandshakerFactory

  • public class WebSocketServerHandshakerFactory
extends Object
    Auto-detects the version of the Web Socket protocol in use and creates a new proper WebSocketServerHandshaker.

    • Constructor Detail

      • WebSocketServerHandshakerFactory

        public WebSocketServerHandshakerFactory​(String webSocketURL,
                                        String subprotocols,
                                        boolean allowExtensions)
        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. Null if sub protocols not supported.
        allowExtensions - Allow extensions to be used in the reserved bits of the web socket frame

      • WebSocketServerHandshakerFactory

        public WebSocketServerHandshakerFactory​(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. Null if sub protocols not supported.
        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.

      • WebSocketServerHandshakerFactory

        public WebSocketServerHandshakerFactory​(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. Null if sub protocols not supported.
        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.

      • WebSocketServerHandshakerFactory

        public WebSocketServerHandshakerFactory​(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. Null if sub protocols not supported.
        decoderConfig - Frames decoder options.

    • Method Detail

      • newHandshaker

        public WebSocketServerHandshaker newHandshaker​(HttpRequest req)
        Instances a new handshaker
        Returns:
        A new WebSocketServerHandshaker for the requested web socket version. Null if web socket version is not supported.

      • sendUnsupportedVersionResponse

        public static Future<Void> sendUnsupportedVersionResponse​(Channel channel)
        Return that we need cannot not support the web socket version