Class WebSocketServerHandshakerFactory
- java.lang.Object
-
- io.netty.handler.codec.http.websocketx.WebSocketServerHandshakerFactory
-
public class WebSocketServerHandshakerFactory extends java.lang.ObjectAuto-detects the version of the Web Socket protocol in use and creates a new properWebSocketServerHandshaker.
-
-
Field Summary
Fields Modifier and Type Field Description private WebSocketDecoderConfigdecoderConfigprivate java.lang.Stringsubprotocolsprivate java.lang.StringwebSocketURL
-
Constructor Summary
Constructors Constructor Description WebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.String subprotocols, boolean allowExtensions)Constructor specifying the destination web socket locationWebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.String subprotocols, boolean allowExtensions, int maxFramePayloadLength)Constructor specifying the destination web socket locationWebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.String subprotocols, boolean allowExtensions, int maxFramePayloadLength, boolean allowMaskMismatch)Constructor specifying the destination web socket locationWebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.String subprotocols, WebSocketDecoderConfig decoderConfig)Constructor specifying the destination web socket location
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description WebSocketServerHandshakernewHandshaker(HttpRequest req)Instances a new handshakerstatic ChannelFuturesendUnsupportedVersionResponse(Channel channel)Return that we need cannot not support the web socket versionstatic ChannelFuturesendUnsupportedVersionResponse(Channel channel, ChannelPromise promise)Return that we need cannot not support the web socket versionstatic voidsendUnsupportedWebSocketVersionResponse(Channel channel)Deprecated.
-
-
-
Field Detail
-
webSocketURL
private final java.lang.String webSocketURL
-
subprotocols
private final java.lang.String subprotocols
-
decoderConfig
private final WebSocketDecoderConfig decoderConfig
-
-
Constructor Detail
-
WebSocketServerHandshakerFactory
public WebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.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(java.lang.String webSocketURL, java.lang.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 framemaxFramePayloadLength- 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(java.lang.String webSocketURL, java.lang.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 framemaxFramePayloadLength- 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(java.lang.String webSocketURL, java.lang.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.
-
sendUnsupportedWebSocketVersionResponse
@Deprecated public static void sendUnsupportedWebSocketVersionResponse(Channel channel)
Deprecated.
-
sendUnsupportedVersionResponse
public static ChannelFuture sendUnsupportedVersionResponse(Channel channel)
Return that we need cannot not support the web socket version
-
sendUnsupportedVersionResponse
public static ChannelFuture sendUnsupportedVersionResponse(Channel channel, ChannelPromise promise)
Return that we need cannot not support the web socket version
-
-