org.jwebsocket.kit

Class RawPacket

java.lang.Object

org.jwebsocket.kit.RawPacket

All Implemented Interfaces:

WebSocketPacket

public class RawPacket
extends Object
implements WebSocketPacket

Implements the 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

Constructor Summary

Constructors

Constructor and Description
RawPacket(byte[] aByteArray) Instantiates a new data packet and initializes its value to the passed array of bytes.
RawPacket(int aInitialSize)
RawPacket(String aString) Instantiates a new data packet and initializes its value to the passed string using the default encoding.
RawPacket(String aString, String aEncoding) Instantiates a new data packet and initializes its value to the passed string using the passed encoding (should always be "UTF-8").
RawPacket(WebSocketFrameType aFrameType, byte[] aByteArray) Instantiates a new data packet and initializes its value to the passed array of bytes.
RawPacket(WebSocketFrameType aFrameType, String aString) Instantiates a new data packet and initializes its value to the passed string using the default encoding.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RawPacket

public RawPacket(int aInitialSize)

RawPacket

public RawPacket(byte[] aByteArray)

Instantiates a new data packet and initializes its value to the passed array of bytes.

Parameters:

aByteArray - byte array to be used as value for the data packet.

RawPacket

public RawPacket(WebSocketFrameType aFrameType,
         byte[] aByteArray)

Instantiates a new data packet and initializes its value to the passed array of bytes.

Parameters:

aByteArray - byte array to be used as value for the data packet.

RawPacket

public RawPacket(String aString)

Instantiates a new data packet and initializes its value to the passed string using the default encoding.

Parameters:

aString - string to be used as value for the data packet.

RawPacket

public RawPacket(WebSocketFrameType aFrameType,
         String aString)

Instantiates a new data packet and initializes its value to the passed string using the default encoding.

Parameters:

aString - string to be used as value for the data packet.

RawPacket

public RawPacket(String aString,
         String aEncoding)
          throws UnsupportedEncodingException

Instantiates a new data packet and initializes its value to the passed string using the passed encoding (should always be "UTF-8").

Parameters:

aString - string to be used as value for the data packet.

aEncoding - should always be "UTF-8"

Throws:

UnsupportedEncodingException

Method Detail

setByteArray

public final void setByteArray(byte[] aByteArray)

Description copied from interface: WebSocketPacket

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

Specified by:

setByteArray in interface WebSocketPacket

setString

public final void setString(String aString)

Description copied from interface: WebSocketPacket

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

Specified by:

setString in interface WebSocketPacket

setString

public final void setString(String aString,
             String aEncoding)
                     throws UnsupportedEncodingException

Description copied from interface: WebSocketPacket

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

Specified by:

setString in interface WebSocketPacket

Throws:

UnsupportedEncodingException

setUTF8

public final void setUTF8(String aString)

Description copied from interface: WebSocketPacket

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

Specified by:

setUTF8 in interface WebSocketPacket

setASCII

public final void setASCII(String aString)

Description copied from interface: WebSocketPacket

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

Specified by:

setASCII in interface WebSocketPacket

getByteArray

public final byte[] getByteArray()

Description copied from interface: WebSocketPacket

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

Specified by:

getByteArray in interface WebSocketPacket

Returns:

Data packet as array of bytes.

getString

public final String getString()

Description copied from interface: WebSocketPacket

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

Specified by:

getString in interface WebSocketPacket

Returns:

Raw Data packet as string with default encoding.

getString

public final String getString(String aEncoding)
                       throws UnsupportedEncodingException

Description copied from interface: WebSocketPacket

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

Specified by:

getString in interface WebSocketPacket

Returns:

String using the passed encoding.

Throws:

UnsupportedEncodingException

getUTF8

public final String getUTF8()

Description copied from interface: WebSocketPacket

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

Specified by:

getUTF8 in interface WebSocketPacket

Returns:

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

getASCII

public final String getASCII()

Description copied from interface: WebSocketPacket

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

Specified by:

getASCII in interface WebSocketPacket

Returns:

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

getFrameType

public final WebSocketFrameType getFrameType()

Specified by:

getFrameType in interface WebSocketPacket

Returns:

the frameType

setFrameType

public final void setFrameType(WebSocketFrameType aFrameType)

Specified by:

setFrameType in interface WebSocketPacket

Parameters:

aFrameType - the frameType to set

isFragmented

public final boolean isFragmented()

Specified by:

isFragmented in interface WebSocketPacket

Returns:

isComplete

public final boolean isComplete()

Specified by:

isComplete in interface WebSocketPacket

Returns:

setFragment

public final void setFragment(String aString,
               int aIdx)

Specified by:

setFragment in interface WebSocketPacket

packFragments

public void packFragments()

Specified by:

packFragments in interface WebSocketPacket

initFragmented

public final void initFragmented(int aTotal)

Specified by:

initFragmented in interface WebSocketPacket

setCreationDate

public final void setCreationDate(Date aDate)

Specified by:

setCreationDate in interface WebSocketPacket

getCreationDate

public final Date getCreationDate()

Specified by:

getCreationDate in interface WebSocketPacket

Returns:

setTimeout

public final void setTimeout(long aMilliseconds)

Specified by:

setTimeout in interface WebSocketPacket

isTimedOut

public final boolean isTimedOut()

Specified by:

isTimedOut in interface WebSocketPacket

Returns: