org.snf4j.websocket.frame

Class AggregatedBinaryFrame

java.lang.Object

org.snf4j.websocket.frame.Frame

org.snf4j.websocket.frame.DataFrame

org.snf4j.websocket.frame.BinaryFrame

org.snf4j.websocket.frame.AggregatedBinaryFrame

All Implemented Interfaces:

IAggregatedFrame

public class AggregatedBinaryFrame
extends BinaryFrame
implements IAggregatedFrame

Aggregated Web Socket binary frame.

Author:

SNF4J.ORG

Field Summary

Fields inherited from class org.snf4j.websocket.frame.Frame

payload, RSV1, RSV2, RSV3

Constructor Summary

Constructors

Constructor and Description
AggregatedBinaryFrame(boolean finalFragment, int rsvBits, byte[] payload) Constructs an aggregated Web Socket binary frame.

Method Summary

Modifier and Type	Method and Description
void	addFragment(byte[] data) Adds a new payload data fragment for future aggregation.
List<byte[]>	getFragments() Returns all payload data fragments already stored in this frame.
byte[]	getPayload() Returns the payload data in this frame.
int	getPayloadLength() Return the length of the payload data in this frame.

Methods inherited from class org.snf4j.websocket.frame.Frame

getOpcode, getRsvBits, isFinalFragment, isRsvBit1, isRsvBit2, isRsvBit3

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatedBinaryFrame

public AggregatedBinaryFrame(boolean finalFragment,
                             int rsvBits,
                             byte[] payload)

Constructs an aggregated Web Socket binary frame.

Parameters:

finalFragment - determines if the created frame is the final fragment in a message

rsvBits - reserved bits for extensions or future versions

payload - payload data

Method Detail

addFragment

public void addFragment(byte[] data)

Description copied from interface: IAggregatedFrame

Adds a new payload data fragment for future aggregation.

Specified by:

addFragment in interface IAggregatedFrame

Parameters:

data - the new payload data fragment

getFragments

public List<byte[]> getFragments()

Description copied from interface: IAggregatedFrame

Returns all payload data fragments already stored in this frame.

NOTE: It is expected that, due to possible optimizations, the number of return fragments may change after executing of the IAggregatedFrame.getPayload() method. However, in such a case, the aggregated payload data should still be the same.

Specified by:

getFragments in interface IAggregatedFrame

Returns:

the payload data fragments

getPayloadLength

public int getPayloadLength()

Description copied from class: Frame

Return the length of the payload data in this frame.

Specified by:

getPayloadLength in interface IAggregatedFrame

Overrides:

getPayloadLength in class Frame

Returns:

the lenght of the payload data

getPayload

public byte[] getPayload()

Description copied from class: Frame

Returns the payload data in this frame.

Specified by:

getPayload in interface IAggregatedFrame

Overrides:

getPayload in class Frame

Returns:

the payload data