io.netty.handler.codec.http.websocketx

类 WebSocketClientHandshaker07

java.lang.Object

io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker

io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker07

public class WebSocketClientHandshaker07
extends WebSocketClientHandshaker

Performs client side opening and closing handshakes for web socket specification version draft-ietf-hybi-thewebsocketprotocol- 10

字段概要

字段

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

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

customHeaders, DEFAULT_FORCE_CLOSE_TIMEOUT_MILLIS, generateOriginHeader

构造器概要

构造器

构造器和说明
WebSocketClientHandshaker07(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength) Creates a new instance.
WebSocketClientHandshaker07(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean performMasking, boolean allowMaskMismatch) Creates a new instance.
WebSocketClientHandshaker07(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, HttpHeaders customHeaders, int maxFramePayloadLength, boolean performMasking, boolean allowMaskMismatch, long forceCloseTimeoutMillis) Creates a new instance.

方法概要

限定符和类型	方法和说明
protected FullHttpRequest	newHandshakeRequest() /** Sends the opening request to the server: GET /chat HTTP/1.1 Host: server.example.com Upgrade: websocket Connection: Upgrade Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ== Sec-WebSocket-Origin: http://example.com Sec-WebSocket-Protocol: chat, superchat Sec-WebSocket-Version: 7
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.
WebSocketClientHandshaker07	setForceCloseTimeoutMillis(long forceCloseTimeoutMillis) Sets timeout to close the connection if it was not closed by the server.
protected void	verify(FullHttpResponse response) Process server response: HTTP/1.1 101 Switching Protocols Upgrade: websocket Connection: Upgrade Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo= Sec-WebSocket-Protocol: chat

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

actualSubprotocol, close, close, close, close, expectedSubprotocol, finishHandshake, forceCloseTimeoutMillis, handshake, handshake, isForceCloseComplete, isHandshakeComplete, maxFramePayloadLength, processHandshake, processHandshake, upgradeUrl, uri, version

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

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

字段详细资料

MAGIC_GUID

public static final java.lang.String MAGIC_GUID

另请参阅:

常量字段值

构造器详细资料

WebSocketClientHandshaker07

public WebSocketClientHandshaker07(java.net.URI webSocketURL,
                                   WebSocketVersion version,
                                   java.lang.String subprotocol,
                                   boolean allowExtensions,
                                   HttpHeaders customHeaders,
                                   int maxFramePayloadLength)

Creates a new instance.

参数:

webSocketURL - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

version - Version of web socket specification to use to connect to the server

subprotocol - Sub protocol request sent to the server.

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

customHeaders - Map of custom headers to add to the client request

maxFramePayloadLength - Maximum length of a frame's payload

WebSocketClientHandshaker07

public WebSocketClientHandshaker07(java.net.URI webSocketURL,
                                   WebSocketVersion version,
                                   java.lang.String subprotocol,
                                   boolean allowExtensions,
                                   HttpHeaders customHeaders,
                                   int maxFramePayloadLength,
                                   boolean performMasking,
                                   boolean allowMaskMismatch)

Creates a new instance.

参数:

webSocketURL - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

version - Version of web socket specification to use to connect to the server

subprotocol - Sub protocol request sent to the server.

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

customHeaders - Map of custom headers to add to the client request

maxFramePayloadLength - Maximum length of a frame's payload

performMasking - Whether to mask all written websocket frames. This must be set to true in order to be fully compatible with the websocket specifications. Client applications that communicate with a non-standard server which doesn't require masking might set this to false to achieve a higher performance.

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

WebSocketClientHandshaker07

public WebSocketClientHandshaker07(java.net.URI webSocketURL,
                                   WebSocketVersion version,
                                   java.lang.String subprotocol,
                                   boolean allowExtensions,
                                   HttpHeaders customHeaders,
                                   int maxFramePayloadLength,
                                   boolean performMasking,
                                   boolean allowMaskMismatch,
                                   long forceCloseTimeoutMillis)

Creates a new instance.

参数:

webSocketURL - URL for web socket communications. e.g "ws://myhost.com/mypath". Subsequent web socket frames will be sent to this URL.

version - Version of web socket specification to use to connect to the server

subprotocol - Sub protocol request sent to the server.

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

customHeaders - Map of custom headers to add to the client request

maxFramePayloadLength - Maximum length of a frame's payload

performMasking - Whether to mask all written websocket frames. This must be set to true in order to be fully compatible with the websocket specifications. Client applications that communicate with a non-standard server which doesn't require masking might set this to false to achieve a higher performance.

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

forceCloseTimeoutMillis - Close the connection if it was not closed by the server after timeout specified.

方法详细资料

newHandshakeRequest

protected FullHttpRequest newHandshakeRequest()

/**

Sends the opening request to the server:

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

指定者:

newHandshakeRequest 在类中 WebSocketClientHandshaker

verify

protected void verify(FullHttpResponse response)

Process server response:

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

指定者:

verify 在类中 WebSocketClientHandshaker

参数:

response - HTTP response returned from the server for the request sent by beginOpeningHandshake00().

抛出:

WebSocketHandshakeException

newWebsocketDecoder

protected WebSocketFrameDecoder newWebsocketDecoder()

从类复制的说明: WebSocketClientHandshaker

Returns the decoder to use after handshake is complete.

指定者:

newWebsocketDecoder 在类中 WebSocketClientHandshaker

newWebSocketEncoder

protected WebSocketFrameEncoder newWebSocketEncoder()

从类复制的说明: WebSocketClientHandshaker

Returns the encoder to use after the handshake is complete.

指定者:

newWebSocketEncoder 在类中 WebSocketClientHandshaker

setForceCloseTimeoutMillis

public WebSocketClientHandshaker07 setForceCloseTimeoutMillis(long forceCloseTimeoutMillis)

从类复制的说明: WebSocketClientHandshaker

Sets timeout to close the connection if it was not closed by the server.

覆盖:

setForceCloseTimeoutMillis 在类中 WebSocketClientHandshaker

参数:

forceCloseTimeoutMillis - Close the connection if it was not closed by the server after timeout specified