net.sf.jrtps.message

Class DataEncapsulation

java.lang.Object

net.sf.jrtps.message.DataEncapsulation

Direct Known Subclasses:

CDREncapsulation, ParameterListEncapsulation

public abstract class DataEncapsulation
extends Object

This abstract class is a base class for different encapsulation schemes. DataEncapsulation is used by Data submessage.

Author:

mcr70

See Also:

Data

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	CDR_BE_HEADER
static byte[]	CDR_LE_HEADER
static byte[]	PL_CDR_BE_HEADER
static byte[]	PL_CDR_LE_HEADER

Constructor Summary

Constructors

Constructor and Description
DataEncapsulation()

Method Summary

Modifier and Type	Method and Description
abstract boolean	containsData() Checks whether this encapsulation holds data
static DataEncapsulation	createInstance(byte[] serializedPayload) Creates an instance of DataEncapsulation.
abstract byte[]	getSerializedPayload() Gets the payload as a byte array.
static void	registerDataEncapsulation(DataEncapsulation dEnc) This method is not implemented at the moment.

Methods inherited from class java.lang.Object

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

Field Detail

CDR_BE_HEADER

public static final byte[] CDR_BE_HEADER

CDR_LE_HEADER

public static final byte[] CDR_LE_HEADER

PL_CDR_BE_HEADER

public static final byte[] PL_CDR_BE_HEADER

PL_CDR_LE_HEADER

public static final byte[] PL_CDR_LE_HEADER

Constructor Detail

DataEncapsulation

public DataEncapsulation()

Method Detail

registerDataEncapsulation

public static void registerDataEncapsulation(DataEncapsulation dEnc)

This method is not implemented at the moment. Currently, it is only possible to use predefined DataEncapsulations: CDREncapsulation and ParameterListEncapsulation

Parameters:

dEnc - DataEncapsulation to register

See Also:

CDREncapsulation, ParameterListEncapsulation

containsData

public abstract boolean containsData()

Checks whether this encapsulation holds data

Returns:

true, if this encapsulation holds data

getSerializedPayload

public abstract byte[] getSerializedPayload()

Gets the payload as a byte array. Payload must contain an encapsulation identifier as first 2 bytes.

Returns:

serialized payload

createInstance

public static DataEncapsulation createInstance(byte[] serializedPayload)

Creates an instance of DataEncapsulation. Encapsulation identified by reading first 2 bytes of serializedPayload.

Parameters:

serializedPayload - byte array that is converted into DataEncapsulation

Returns:

DataEncapsulation