org.java_websocket.drafts

类 Draft

java.lang.Object

org.java_websocket.drafts.Draft

直接已知子类:

Draft_10, Draft_75

public abstract class Draft
extends java.lang.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.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Draft.CloseHandshakeType Enum which represents type of handshake is required for a close
static class	Draft.HandshakeState Enum which represents the states a handshake may be in

字段概要

字段

限定符和类型	字段和说明
static byte[]	FLASH_POLICY_REQUEST
static int	INITIAL_FAMESIZE
static int	MAX_FAME_SIZE

构造器概要

构造器

构造器和说明
Draft()

方法概要

限定符和类型	方法和说明
abstract Draft.HandshakeState	acceptHandshakeAsClient(ClientHandshake request, ServerHandshake response)
abstract Draft.HandshakeState	acceptHandshakeAsServer(ClientHandshake handshakedata)
int	checkAlloc(int bytecount)
java.util.List<Framedata>	continuousFrame(Framedata.Opcode op, java.nio.ByteBuffer buffer, boolean fin)
abstract Draft	copyInstance() Drafts must only be by one websocket at all.
abstract java.nio.ByteBuffer	createBinaryFrame(Framedata framedata)
abstract java.util.List<Framedata>	createFrames(java.nio.ByteBuffer binary, boolean mask)
abstract java.util.List<Framedata>	createFrames(java.lang.String text, boolean mask)
java.util.List<java.nio.ByteBuffer>	createHandshake(Handshakedata handshakedata, WebSocket.Role ownrole)
java.util.List<java.nio.ByteBuffer>	createHandshake(Handshakedata handshakedata, WebSocket.Role ownrole, boolean withcontent)
abstract Draft.CloseHandshakeType	getCloseHandshakeType()
WebSocket.Role	getRole()
abstract ClientHandshakeBuilder	postProcessHandshakeRequestAsClient(ClientHandshakeBuilder request)
abstract HandshakeBuilder	postProcessHandshakeResponseAsServer(ClientHandshake request, ServerHandshakeBuilder response)
static java.nio.ByteBuffer	readLine(java.nio.ByteBuffer buf)
static java.lang.String	readStringLine(java.nio.ByteBuffer buf)
abstract void	reset()
void	setParseMode(WebSocket.Role role)
abstract java.util.List<Framedata>	translateFrame(java.nio.ByteBuffer buffer)
Handshakedata	translateHandshake(java.nio.ByteBuffer buf)
static HandshakeBuilder	translateHandshakeHttp(java.nio.ByteBuffer buf, WebSocket.Role role)

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

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

字段详细资料

MAX_FAME_SIZE

public static int MAX_FAME_SIZE

INITIAL_FAMESIZE

public static int INITIAL_FAMESIZE

FLASH_POLICY_REQUEST

public static final byte[] FLASH_POLICY_REQUEST

构造器详细资料

Draft

public Draft()

方法详细资料

readLine

public static java.nio.ByteBuffer readLine(java.nio.ByteBuffer buf)

readStringLine

public static java.lang.String readStringLine(java.nio.ByteBuffer buf)

translateHandshakeHttp

public static HandshakeBuilder translateHandshakeHttp(java.nio.ByteBuffer buf,
                                                      WebSocket.Role role)
                                               throws InvalidHandshakeException,
                                                      IncompleteHandshakeException

抛出:

InvalidHandshakeException

IncompleteHandshakeException

acceptHandshakeAsClient

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

抛出:

InvalidHandshakeException

acceptHandshakeAsServer

public abstract Draft.HandshakeState acceptHandshakeAsServer(ClientHandshake handshakedata)
                                                      throws InvalidHandshakeException

抛出:

InvalidHandshakeException

createBinaryFrame

public abstract java.nio.ByteBuffer createBinaryFrame(Framedata framedata)

createFrames

public abstract java.util.List<Framedata> createFrames(java.nio.ByteBuffer binary,
                                                       boolean mask)

createFrames

public abstract java.util.List<Framedata> createFrames(java.lang.String text,
                                                       boolean mask)

continuousFrame

public java.util.List<Framedata> continuousFrame(Framedata.Opcode op,
                                                 java.nio.ByteBuffer buffer,
                                                 boolean fin)

reset

public abstract void reset()

createHandshake

public java.util.List<java.nio.ByteBuffer> createHandshake(Handshakedata handshakedata,
                                                           WebSocket.Role ownrole)

createHandshake

public java.util.List<java.nio.ByteBuffer> createHandshake(Handshakedata handshakedata,
                                                           WebSocket.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 java.util.List<Framedata> translateFrame(java.nio.ByteBuffer buffer)
                                                  throws InvalidDataException

抛出:

InvalidDataException

getCloseHandshakeType

public abstract Draft.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(java.nio.ByteBuffer buf)
                                 throws InvalidHandshakeException

抛出:

InvalidHandshakeException

checkAlloc

public int checkAlloc(int bytecount)
               throws LimitExedeedException,
                      InvalidDataException

抛出:

LimitExedeedException

InvalidDataException

setParseMode

public void setParseMode(WebSocket.Role role)

getRole

public WebSocket.Role getRole()