io.netty.handler.codec.http.websocketx

类 WebSocketServerHandshakerFactory

java.lang.Object

io.netty.handler.codec.http.websocketx.WebSocketServerHandshakerFactory

public class WebSocketServerHandshakerFactory
extends java.lang.Object

Auto-detects the version of the Web Socket protocol in use and creates a new proper WebSocketServerHandshaker.

构造器概要

构造器

构造器和说明
WebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.String subprotocols, boolean allowExtensions) Constructor specifying the destination web socket location
WebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.String subprotocols, boolean allowExtensions, int maxFramePayloadLength) Constructor specifying the destination web socket location
WebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.String subprotocols, boolean allowExtensions, int maxFramePayloadLength, boolean allowMaskMismatch) Constructor specifying the destination web socket location
WebSocketServerHandshakerFactory(java.lang.String webSocketURL, java.lang.String subprotocols, WebSocketDecoderConfig decoderConfig) Constructor specifying the destination web socket location

方法概要

限定符和类型	方法和说明
WebSocketServerHandshaker	newHandshaker(HttpRequest req) Instances a new handshaker
static ChannelFuture	sendUnsupportedVersionResponse(Channel channel) Return that we need cannot support the web socket version
static ChannelFuture	sendUnsupportedVersionResponse(Channel channel, ChannelPromise promise) Return that we need cannot support the web socket version
static void	sendUnsupportedWebSocketVersionResponse(Channel channel) 已过时。 use sendUnsupportedVersionResponse(Channel)

从类继承的方法 java.lang.Object

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

构造器详细资料

WebSocketServerHandshakerFactory

public WebSocketServerHandshakerFactory(java.lang.String webSocketURL,
                                        java.lang.String subprotocols,
                                        boolean allowExtensions)

Constructor specifying the destination web socket location

参数:

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

参数:

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(java.lang.String webSocketURL,
                                        java.lang.String subprotocols,
                                        boolean allowExtensions,
                                        int maxFramePayloadLength,
                                        boolean allowMaskMismatch)

Constructor specifying the destination web socket location

参数:

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(java.lang.String webSocketURL,
                                        java.lang.String subprotocols,
                                        WebSocketDecoderConfig decoderConfig)

Constructor specifying the destination web socket location

参数:

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.

方法详细资料

newHandshaker

public WebSocketServerHandshaker newHandshaker(HttpRequest req)

Instances a new handshaker

返回:

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)

已过时。 use sendUnsupportedVersionResponse(Channel)

sendUnsupportedVersionResponse

public static ChannelFuture sendUnsupportedVersionResponse(Channel channel)

Return that we need cannot support the web socket version

sendUnsupportedVersionResponse

public static ChannelFuture sendUnsupportedVersionResponse(Channel channel,
                                                           ChannelPromise promise)

Return that we need cannot support the web socket version