org.jwebsocket.kit

Class WebSocketProtocolAbstraction

java.lang.Object

org.jwebsocket.kit.WebSocketProtocolAbstraction

public class WebSocketProtocolAbstraction
extends Object

Utility class for packetizing WebSocketPacket into web socket protocol packet or packets (with fragmentation) and vice versa.

Web socket protocol packet specification (see: http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-03):

  0                   1                   2                   3
  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 +-+-+-+-+-------+-+-------------+-------------------------------+
 |M|R|R|R| opcode|R| Payload len |    Extended payload length    |
 |O|S|S|S|  (4)  |S|     (7)     |             (16/63)           |
 |R|V|V|V|       |V|             |   (if payload len==126/127)   |
 |E|1|2|3|       |4|             |                               |
 +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
 |     Extended payload length continued, if payload len == 127  |
 + - - - - - - - - - - - - - - - +-------------------------------+
 |                               |         Extension data        |
 +-------------------------------+ - - - - - - - - - - - - - - - +
 :                                                               :
 +---------------------------------------------------------------+
 :                       Application data                        :
 +---------------------------------------------------------------+
 

Author:

jang, aschulze

Constructor Summary

Constructors

Constructor and Description
WebSocketProtocolAbstraction()

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	calcCloseData(int aReasonCode, String aReasonString)
static byte[]	calcClosePayload(int aReasonCode, byte[] aReason)
static WebSocketFrameType	encodingToFrameType(WebSocketEncoding aEncoding)
static int	frameTypeToOpcode(int aVersion, WebSocketFrameType aFrameType)
static boolean	isHixieDraft(String aDraft)
static boolean	isHixieVersion(int aVersion)
static boolean	isHybiDraft(String aDraft)
static boolean	isHybiVersion(int aVersion)
static boolean	isValidDraft(String aDraft)
static boolean	isValidVersion(int aVersion)
static WebSocketFrameType	opcodeToFrameType(int aVersion, int aOpcode) converts a WebSocket protocol opcode to an abstract jWebSocket frame type
static WebSocketPacket	protocolToRawPacket(int aVersion, InputStream aIS)
static byte[]	rawToProtocolPacket(int aVersion, WebSocketPacket aDataPacket) converts an abstract data packet into a protocol specific frame according to the correct version.
static int	read(InputStream aIS)
static List<byte[]>	toProtocolPacketFragmented(WebSocketPacket aSrc, int aFragmentSize)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketProtocolAbstraction

public WebSocketProtocolAbstraction()

Method Detail

isHixieVersion

public static boolean isHixieVersion(int aVersion)

Parameters:

aVersion -

Returns:

isHybiVersion

public static boolean isHybiVersion(int aVersion)

Parameters:

aVersion -

Returns:

isValidVersion

public static boolean isValidVersion(int aVersion)

Parameters:

aVersion -

Returns:

isHixieDraft

public static boolean isHixieDraft(String aDraft)

Parameters:

aDraft -

Returns:

isHybiDraft

public static boolean isHybiDraft(String aDraft)

Parameters:

aDraft -

Returns:

isValidDraft

public static boolean isValidDraft(String aDraft)

Parameters:

aDraft -

Returns:

calcClosePayload

public static byte[] calcClosePayload(int aReasonCode,
                      byte[] aReason)

calcCloseData

public static byte[] calcCloseData(int aReasonCode,
                   String aReasonString)

rawToProtocolPacket

public static byte[] rawToProtocolPacket(int aVersion,
                         WebSocketPacket aDataPacket)

converts an abstract data packet into a protocol specific frame according to the correct version.

Parameters:

aVersion -

aDataPacket -

Returns:

read

public static int read(InputStream aIS)
                throws Exception

Throws:

Exception

protocolToRawPacket

public static WebSocketPacket protocolToRawPacket(int aVersion,
                                  InputStream aIS)
                                           throws Exception

Parameters:

aVersion -

aIS -

Returns:

Throws:

Exception

toProtocolPacketFragmented

public static List<byte[]> toProtocolPacketFragmented(WebSocketPacket aSrc,
                                      int aFragmentSize)

Parameters:

aSrc -

aFragmentSize -

Returns:

opcodeToFrameType

public static WebSocketFrameType opcodeToFrameType(int aVersion,
                                   int aOpcode)

converts a WebSocket protocol opcode to an abstract jWebSocket frame type

Parameters:

aVersion -

aOpcode -

Returns:

frameTypeToOpcode

public static int frameTypeToOpcode(int aVersion,
                    WebSocketFrameType aFrameType)

Parameters:

aVersion -

aFrameType -

Returns:

encodingToFrameType

public static WebSocketFrameType encodingToFrameType(WebSocketEncoding aEncoding)

Parameters:

aEncoding -

Returns: