com.alipay.api.java_websocket.drafts

类 Draft

java.lang.Object

com.alipay.api.java_websocket.drafts.Draft

直接已知子类:

Draft_6455

public abstract class Draft
extends Object

Base class for everything of a websocket specification which is not common such as the way the handshake is read or frames are transfered.

字段概要

字段

限定符和类型	字段和说明
protected Opcode	continuousFrameType
protected Role	role In some cases the handshake will be parsed different depending on whether

构造器概要

构造器

构造器和说明
Draft()

方法概要

限定符和类型	方法和说明
abstract HandshakeState	acceptHandshakeAsClient(ClientHandshake request, ServerHandshake response)
abstract HandshakeState	acceptHandshakeAsServer(ClientHandshake handshakedata)
protected boolean	basicAccept(Handshakedata handshakedata)
int	checkAlloc(int bytecount)
List<Framedata>	continuousFrame(Opcode op, ByteBuffer buffer, boolean fin)
abstract Draft	copyInstance() Drafts must only be by one websocket at all.
abstract ByteBuffer	createBinaryFrame(Framedata framedata)
abstract List<Framedata>	createFrames(ByteBuffer binary, boolean mask)
abstract List<Framedata>	createFrames(String text, boolean mask)
List<ByteBuffer>	createHandshake(Handshakedata handshakedata, Role ownrole)
List<ByteBuffer>	createHandshake(Handshakedata handshakedata, Role ownrole, boolean withcontent)
String	getCharset() Getter method for property charset.
abstract CloseHandshakeType	getCloseHandshakeType()
Role	getRole()
abstract ClientHandshakeBuilder	postProcessHandshakeRequestAsClient(ClientHandshakeBuilder request)
abstract HandshakeBuilder	postProcessHandshakeResponseAsServer(ClientHandshake request, ServerHandshakeBuilder response)
abstract void	processFrame(WebSocketImpl webSocketImpl, Framedata frame) Handle the frame specific to the draft
static ByteBuffer	readLine(ByteBuffer buf)
static String	readStringLine(ByteBuffer buf)
abstract void	reset()
void	setCharset(String charset) Setter method for property charset.
void	setParseMode(Role role)
String	toString()
abstract List<Framedata>	translateFrame(ByteBuffer buffer)
Handshakedata	translateHandshake(ByteBuffer buf)
static HandshakeBuilder	translateHandshakeHttp(ByteBuffer buf, Role role)

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

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

字段详细资料

role

protected Role role

In some cases the handshake will be parsed different depending on whether

continuousFrameType

protected Opcode continuousFrameType

构造器详细资料

Draft

public Draft()

方法详细资料

readLine

public static ByteBuffer readLine(ByteBuffer buf)

readStringLine

public static String readStringLine(ByteBuffer buf)

translateHandshakeHttp

public static HandshakeBuilder translateHandshakeHttp(ByteBuffer buf,
                                                      Role role)
                                               throws InvalidHandshakeException,
                                                      IncompleteHandshakeException

抛出:

InvalidHandshakeException

IncompleteHandshakeException

acceptHandshakeAsClient

public abstract HandshakeState acceptHandshakeAsClient(ClientHandshake request,
                                                       ServerHandshake response)
                                                throws InvalidHandshakeException

抛出:

InvalidHandshakeException

acceptHandshakeAsServer

public abstract HandshakeState acceptHandshakeAsServer(ClientHandshake handshakedata)
                                                throws InvalidHandshakeException

抛出:

InvalidHandshakeException

basicAccept

protected boolean basicAccept(Handshakedata handshakedata)

createBinaryFrame

public abstract ByteBuffer createBinaryFrame(Framedata framedata)

createFrames

public abstract List<Framedata> createFrames(ByteBuffer binary,
                                             boolean mask)

createFrames

public abstract List<Framedata> createFrames(String text,
                                             boolean mask)

processFrame

public abstract void processFrame(WebSocketImpl webSocketImpl,
                                  Framedata frame)
                           throws InvalidDataException

Handle the frame specific to the draft

参数:

webSocketImpl - the websocketimpl used for this draft

frame - the frame which is supposed to be handled

抛出:

InvalidDataException - will be thrown on invalid data

continuousFrame

public List<Framedata> continuousFrame(Opcode op,
                                       ByteBuffer buffer,
                                       boolean fin)

reset

public abstract void reset()

createHandshake

public List<ByteBuffer> createHandshake(Handshakedata handshakedata,
                                        Role ownrole)

createHandshake

public List<ByteBuffer> createHandshake(Handshakedata handshakedata,
                                        Role ownrole,
                                        boolean withcontent)

postProcessHandshakeRequestAsClient

public abstract ClientHandshakeBuilder postProcessHandshakeRequestAsClient(ClientHandshakeBuilder request)
                                                                    throws InvalidHandshakeException

抛出:

InvalidHandshakeException

postProcessHandshakeResponseAsServer

public abstract HandshakeBuilder postProcessHandshakeResponseAsServer(ClientHandshake request,
                                                                      ServerHandshakeBuilder response)
                                                               throws InvalidHandshakeException

抛出:

InvalidHandshakeException

translateFrame

public abstract List<Framedata> translateFrame(ByteBuffer buffer)
                                        throws InvalidDataException

抛出:

InvalidDataException

getCloseHandshakeType

public abstract CloseHandshakeType getCloseHandshakeType()

copyInstance

public abstract Draft copyInstance()

Drafts must only be by one websocket at all. To prevent drafts to be used more than once the Websocket implementation should call this method in order to create a new usable version of a given draft instance.
The copy can be safely used in conjunction with a new websocket connection.

返回:

a copy of the draft

translateHandshake

public Handshakedata translateHandshake(ByteBuffer buf)
                                 throws InvalidHandshakeException

抛出:

InvalidHandshakeException

checkAlloc

public int checkAlloc(int bytecount)
               throws LimitExedeedException,
                      InvalidDataException

抛出:

LimitExedeedException

InvalidDataException

setParseMode

public void setParseMode(Role role)

getRole

public Role getRole()

getCharset

public String getCharset()

Getter method for property charset.

返回:

property value of charset

setCharset

public void setCharset(String charset)

Setter method for property charset.

参数:

charset - value to be assigned to property charset

toString

public String toString()

覆盖:

toString 在类中 Object