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

类 WebSocketServerHandshaker13

java.lang.Object

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

org.jboss.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 version draft-ietf-hybi-thewebsocketprotocol- 17).

字段概要

字段

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

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

HANDSHAKE_LISTENER, SUB_PROTOCOL_WILDCARD

构造器概要

构造器

构造器和说明
WebSocketServerHandshaker13(java.lang.String webSocketURL, java.lang.String subprotocols, boolean allowExtensions) Constructor using defaults
WebSocketServerHandshaker13(java.lang.String webSocketURL, java.lang.String subprotocols, boolean allowExtensions, long maxFramePayloadLength) Constructor specifying the destination web socket location

方法概要

方法

限定符和类型	方法和说明
ChannelFuture	close(Channel channel, CloseWebSocketFrame frame) Echo back the closing frame and close the connection
ChannelFuture	handshake(Channel channel, HttpRequest req) Handle the web socket handshake for the web socket specification HyBi versions 13-17.

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

getMaxFramePayloadLength, getSelectedSubprotocol, getSubprotocols, getVersion, getWebSocketUrl, selectSubprotocol, setSelectedSubprotocol, writeHandshakeResponse

从类继承的方法 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)

Constructor using defaults

参数:

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

WebSocketServerHandshaker13

public WebSocketServerHandshaker13(java.lang.String webSocketURL,
                           java.lang.String subprotocols,
                           boolean allowExtensions,
                           long 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.

方法详细资料

handshake

public ChannelFuture handshake(Channel channel,
                      HttpRequest req)

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==
 Sec-WebSocket-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
 

指定者:

handshake 在类中 WebSocketServerHandshaker

参数:

channel - Channel

req - HTTP request

close

public ChannelFuture close(Channel channel,
                  CloseWebSocketFrame frame)

Echo back the closing frame and close the connection

指定者:

close 在类中 WebSocketServerHandshaker

参数:

channel - Channel

frame - Web Socket frame that was received