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

类 WebSocketServerHandshaker

java.lang.Object

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

直接已知子类:

WebSocketServerHandshaker00, WebSocketServerHandshaker07, WebSocketServerHandshaker08, WebSocketServerHandshaker13

public abstract class WebSocketServerHandshaker
extends java.lang.Object

Base class for server side web socket opening and closing handshakes

字段概要

字段

限定符和类型	字段和说明
static ChannelFutureListener	HANDSHAKE_LISTENER ChannelFutureListener which will call Channels.fireExceptionCaught(ChannelHandlerContext, Throwable) if the ChannelFuture was not successful.
static java.lang.String	SUB_PROTOCOL_WILDCARD Use this as wildcard to support all requested sub-protocols

构造器概要

构造器

限定符	构造器和说明
protected	WebSocketServerHandshaker(WebSocketVersion version, java.lang.String webSocketUrl, java.lang.String subprotocols) Constructor using default values
protected	WebSocketServerHandshaker(WebSocketVersion version, java.lang.String webSocketUrl, java.lang.String subprotocols, long maxFramePayloadLength) Constructor specifying the destination web socket location

方法概要

方法

限定符和类型	方法和说明
abstract ChannelFuture	close(Channel channel, CloseWebSocketFrame frame) Performs the closing handshake
long	getMaxFramePayloadLength() Returns the max length for any frame's payload
java.lang.String	getSelectedSubprotocol() Returns the selected subprotocol.
java.util.Set<java.lang.String>	getSubprotocols() Returns the CSV of supported sub protocols
WebSocketVersion	getVersion() Returns the version of the specification being supported
java.lang.String	getWebSocketUrl() Returns the URL of the web socket
abstract ChannelFuture	handshake(Channel channel, HttpRequest req) Performs the opening handshake
protected java.lang.String	selectSubprotocol(java.lang.String requestedSubprotocols) Selects the first matching supported sub protocol
protected void	setSelectedSubprotocol(java.lang.String value)
protected ChannelFuture	writeHandshakeResponse(Channel channel, HttpResponse res, ChannelHandler encoder, ChannelHandler decoder) Upgrades the connection and send the handshake response.

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

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

字段详细资料

SUB_PROTOCOL_WILDCARD

public static final java.lang.String SUB_PROTOCOL_WILDCARD

Use this as wildcard to support all requested sub-protocols

另请参阅:

常量字段值

HANDSHAKE_LISTENER

public static final ChannelFutureListener HANDSHAKE_LISTENER

ChannelFutureListener which will call Channels.fireExceptionCaught(ChannelHandlerContext, Throwable) if the ChannelFuture was not successful.

构造器详细资料

WebSocketServerHandshaker

protected WebSocketServerHandshaker(WebSocketVersion version,
                         java.lang.String webSocketUrl,
                         java.lang.String subprotocols)

Constructor using default values

参数:

version - the protocol version

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. Null if sub protocols not supported.

WebSocketServerHandshaker

protected WebSocketServerHandshaker(WebSocketVersion version,
                         java.lang.String webSocketUrl,
                         java.lang.String subprotocols,
                         long maxFramePayloadLength)

Constructor specifying the destination web socket location

参数:

version - the protocol version

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. Null if sub protocols not supported.

maxFramePayloadLength - Maximum length of a frame's payload

方法详细资料

getWebSocketUrl

public java.lang.String getWebSocketUrl()

Returns the URL of the web socket

getSubprotocols

public java.util.Set<java.lang.String> getSubprotocols()

Returns the CSV of supported sub protocols

getVersion

public WebSocketVersion getVersion()

Returns the version of the specification being supported

getMaxFramePayloadLength

public long getMaxFramePayloadLength()

Returns the max length for any frame's payload

handshake

public abstract ChannelFuture handshake(Channel channel,
                      HttpRequest req)

Performs the opening handshake

参数:

channel - Channel

req - HTTP Request

writeHandshakeResponse

protected ChannelFuture writeHandshakeResponse(Channel channel,
                                   HttpResponse res,
                                   ChannelHandler encoder,
                                   ChannelHandler decoder)

Upgrades the connection and send the handshake response.

close

public abstract ChannelFuture close(Channel channel,
                  CloseWebSocketFrame frame)

Performs the closing handshake

参数:

channel - Channel

frame - Closing Frame that was received

selectSubprotocol

protected java.lang.String selectSubprotocol(java.lang.String requestedSubprotocols)

Selects the first matching supported sub protocol

参数:

requestedSubprotocols - CSV of protocols to be supported. e.g. "chat, superchat"

返回:

First matching supported sub protocol. Null if not found.

getSelectedSubprotocol

public java.lang.String getSelectedSubprotocol()

Returns the selected subprotocol. Null if no subprotocol has been selected.

This is only available AFTER handshake() has been called.

setSelectedSubprotocol

protected void setSelectedSubprotocol(java.lang.String value)