io.netty.handler.codec.http.websocketx

类 WebSocketServerHandshaker00

java.lang.Object

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

io.netty.handler.codec.http.websocketx.WebSocketServerHandshaker00

public class WebSocketServerHandshaker00
extends WebSocketServerHandshaker

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

A very large portion of this code was taken from the Netty 3.2 HTTP example.

字段概要

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

logger, SUB_PROTOCOL_WILDCARD

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
ChannelFuture	close(Channel channel, CloseWebSocketFrame frame, ChannelPromise promise) Echo back the closing frame
ChannelFuture	close(ChannelHandlerContext ctx, CloseWebSocketFrame frame, ChannelPromise promise) Echo back the closing frame
protected FullHttpResponse	newHandshakeResponse(FullHttpRequest req, HttpHeaders headers) Handle the web socket handshake for the web socket specification HyBi version 0 and lower.
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, 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

构造器详细资料

WebSocketServerHandshaker00

public WebSocketServerHandshaker00(java.lang.String webSocketURL,
                                   java.lang.String subprotocols,
                                   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

maxFramePayloadLength - Maximum allowable frame payload length. Setting this value to your application's requirement may reduce denial of service attacks using long data frames.

WebSocketServerHandshaker00

public WebSocketServerHandshaker00(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 version 0 and lower. This standard is really a rehash of hixie-76 and hixie-75.

Browser request to the server:

 GET /demo HTTP/1.1
 Upgrade: WebSocket
 Connection: Upgrade
 Host: example.com
 Origin: http://example.com
 Sec-WebSocket-Protocol: chat, sample
 Sec-WebSocket-Key1: 4 @1  46546xW%0l 1 5
 Sec-WebSocket-Key2: 12998 5 Y3 1  .P00

 ^n:ds[4U
 

Server response:

 HTTP/1.1 101 WebSocket Protocol Handshake
 Upgrade: WebSocket
 Connection: Upgrade
 Sec-WebSocket-Origin: http://example.com
 Sec-WebSocket-Location: ws://example.com/demo
 Sec-WebSocket-Protocol: sample

 8jKS'y:G*Co,Wxa-
 

指定者:

newHandshakeResponse 在类中 WebSocketServerHandshaker

close

public ChannelFuture close(Channel channel,
                           CloseWebSocketFrame frame,
                           ChannelPromise promise)

Echo back the closing frame

覆盖:

close 在类中 WebSocketServerHandshaker

参数:

channel - the Channel to use.

frame - Web Socket frame that was received.

promise - the ChannelPromise to be notified when the closing handshake is done.

close

public ChannelFuture close(ChannelHandlerContext ctx,
                           CloseWebSocketFrame frame,
                           ChannelPromise promise)

Echo back the closing frame

覆盖:

close 在类中 WebSocketServerHandshaker

参数:

ctx - the ChannelHandlerContext to use.

frame - Closing Frame that was received.

promise - the ChannelPromise to be notified when the closing handshake is done.

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