org.jboss.netty.handler.codec.http.websocketx

类 WebSocketClientHandshaker13

java.lang.Object

org.jboss.netty.handler.codec.http.websocketx.WebSocketClientHandshaker

org.jboss.netty.handler.codec.http.websocketx.WebSocketClientHandshaker13

public class WebSocketClientHandshaker13
extends WebSocketClientHandshaker

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

字段概要

字段

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

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

customHeaders

构造器概要

构造器

构造器和说明
WebSocketClientHandshaker13(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, java.util.Map<java.lang.String,java.lang.String> customHeaders) Constructor with default values
WebSocketClientHandshaker13(java.net.URI webSocketURL, WebSocketVersion version, java.lang.String subprotocol, boolean allowExtensions, java.util.Map<java.lang.String,java.lang.String> customHeaders, long maxFramePayloadLength) Constructor

方法概要

方法

限定符和类型	方法和说明
void	finishHandshake(Channel channel, HttpResponse response) Process server response: HTTP/1.1 101 Switching Protocols Upgrade: websocket Connection: Upgrade Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo= Sec-WebSocket-Protocol: chat
ChannelFuture	handshake(Channel channel) /** 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: 13

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

getActualSubprotocol, getExpectedSubprotocol, getMaxFramePayloadLength, getVersion, getWebSocketUrl, isHandshakeComplete, setActualSubprotocol, setHandshakeComplete

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

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

字段详细资料

MAGIC_GUID

public static final java.lang.String MAGIC_GUID

另请参阅:

常量字段值

构造器详细资料

WebSocketClientHandshaker13

public WebSocketClientHandshaker13(java.net.URI webSocketURL,
                           WebSocketVersion version,
                           java.lang.String subprotocol,
                           boolean allowExtensions,
                           java.util.Map<java.lang.String,java.lang.String> customHeaders)

Constructor with default values

参数:

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

WebSocketClientHandshaker13

public WebSocketClientHandshaker13(java.net.URI webSocketURL,
                           WebSocketVersion version,
                           java.lang.String subprotocol,
                           boolean allowExtensions,
                           java.util.Map<java.lang.String,java.lang.String> customHeaders,
                           long maxFramePayloadLength)

Constructor

参数:

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

方法详细资料

handshake

public ChannelFuture handshake(Channel channel)
                        throws java.lang.Exception

/**

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: 13
 

指定者:

handshake 在类中 WebSocketClientHandshaker

参数:

channel - Channel into which we can write our request

抛出:

java.lang.Exception

finishHandshake

public void finishHandshake(Channel channel,
                   HttpResponse response)

Process server response:

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

指定者:

finishHandshake 在类中 WebSocketClientHandshaker

参数:

channel - Channel

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

抛出:

WebSocketHandshakeException