io.netty.handler.codec.http.websocketx

类 WebSocketServerHandshaker13

java.lang.Object

io.netty.handler.codec.http.websocketx.WebSocketServerHandshaker

io.netty.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).

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	WEBSOCKET_13_ACCEPT_GUID

从类继承的字段 io.netty.handler.codec.http.websocketx.WebSocketServerHandshaker

logger, SUB_PROTOCOL_WILDCARD

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
protected FullHttpResponse	newHandshakeResponse(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.

从类继承的方法 io.netty.handler.codec.http.websocketx.WebSocketServerHandshaker

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

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

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

字段详细资料

WEBSOCKET_13_ACCEPT_GUID

public static final java.lang.String WEBSOCKET_13_ACCEPT_GUID

另请参阅:

常量字段值

构造器详细资料

WebSocketServerHandshaker13

public WebSocketServerHandshaker13(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

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

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

decoderConfig - Frames decoder configuration.

方法详细资料

newHandshakeResponse

protected FullHttpResponse newHandshakeResponse(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
 

指定者:

newHandshakeResponse 在类中 WebSocketServerHandshaker

newWebsocketDecoder

protected WebSocketFrameDecoder newWebsocketDecoder()

从类复制的说明: WebSocketServerHandshaker

Returns the decoder to use after handshake is complete.

指定者:

newWebsocketDecoder 在类中 WebSocketServerHandshaker

newWebSocketEncoder

protected WebSocketFrameEncoder newWebSocketEncoder()

从类复制的说明: WebSocketServerHandshaker

Returns the encoder to use after the handshake is complete.

指定者:

newWebSocketEncoder 在类中 WebSocketServerHandshaker