org.jwebsocket.api

Interface WebSocketPacket

All Known Implementing Classes:

RawPacket

public interface WebSocketPacket

Specifies the API for low level data packets which are interchanged between client and server. Data packets do not have a special format at this communication level.

Author:

aschulze

Method Summary

Methods

Modifier and Type	Method and Description
String	getASCII() Interprets the data packet as a US-ASCII string and returns the string in US-ASCII encoding.
byte[]	getByteArray() Returns the content of the data packet as an array of bytes.
Date	getCreationDate()
WebSocketFrameType	getFrameType()
String	getString() Returns the content of the data packet as a string using default encoding.
String	getString(String aEncoding) Returns the content of the data packet as a string using the passed encoding.
String	getUTF8() Interprets the data packet as a UTF8 string and returns the string in UTF-8 encoding.
void	initFragmented(int aTotal)
boolean	isComplete()
boolean	isFragmented()
boolean	isTimedOut()
void	packFragments()
void	setASCII(String aString) Sets the value of the data packet to the given string by using 7 bit US-ASCII encoding.
void	setByteArray(byte[] aByteArray) Sets the value of the data packet to the given array of bytes.
void	setCreationDate(Date aDate)
void	setFragment(String aString, int aIdx)
void	setFrameType(WebSocketFrameType aFrameType)
void	setString(String aString) Sets the value of the data packet to the given string by using default encoding.
void	setString(String aString, String aEncoding) Sets the value of the data packet to the given string by using the passed encoding.
void	setTimeout(long aMilliseconds)
void	setUTF8(String aString) Sets the value of the data packet to the given string by using UTF-8 encoding.

Method Detail

setByteArray

void setByteArray(byte[] aByteArray)

Sets the value of the data packet to the given array of bytes.

Parameters:

aByteArray -

isFragmented

boolean isFragmented()

Returns:

isComplete

boolean isComplete()

Returns:

setFragment

void setFragment(String aString,
               int aIdx)

Parameters:

aString -

aStart -

packFragments

void packFragments()

setCreationDate

void setCreationDate(Date aDate)

Parameters:

aDate -

getCreationDate

Date getCreationDate()

Returns:

setTimeout

void setTimeout(long aMilliseconds)

Parameters:

aMilliseconds -

isTimedOut

boolean isTimedOut()

Returns:

initFragmented

void initFragmented(int aTotal)

Parameters:

aTotal -

setString

void setString(String aString)

Sets the value of the data packet to the given string by using default encoding.

Parameters:

aString -

setString

void setString(String aString,
             String aEncoding)
               throws UnsupportedEncodingException

Sets the value of the data packet to the given string by using the passed encoding.

Parameters:

aString -

aEncoding -

Throws:

UnsupportedEncodingException

setUTF8

void setUTF8(String aString)

Sets the value of the data packet to the given string by using UTF-8 encoding.

Parameters:

aString -

setASCII

void setASCII(String aString)

Sets the value of the data packet to the given string by using 7 bit US-ASCII encoding.

Parameters:

aString -

getByteArray

byte[] getByteArray()

Returns the content of the data packet as an array of bytes.

Returns:

Data packet as array of bytes.

getString

String getString()

Returns the content of the data packet as a string using default encoding.

Returns:

Raw Data packet as string with default encoding.

getString

String getString(String aEncoding)
                 throws UnsupportedEncodingException

Returns the content of the data packet as a string using the passed encoding.

Parameters:

aEncoding -

Returns:

String using the passed encoding.

Throws:

UnsupportedEncodingException

getUTF8

String getUTF8()

Interprets the data packet as a UTF8 string and returns the string in UTF-8 encoding. If an exception occurs "null" is returned.

Returns:

Data packet as UTF-8 string or null if not convertible.

getASCII

String getASCII()

Interprets the data packet as a US-ASCII string and returns the string in US-ASCII encoding. If an exception occurs "null" is returned.

Returns:

Data packet as US-ASCII string or null if not convertible.

getFrameType

WebSocketFrameType getFrameType()

Returns:

setFrameType

void setFrameType(WebSocketFrameType aFrameType)

Parameters:

aFrameType -