Package org.yamcs.cfdp.pdu

Class CfdpPacket

java.lang.Object

org.yamcs.cfdp.pdu.CfdpPacket

Direct Known Subclasses:

AckPacket, EofPacket, FileDataPacket, FinishedPacket, KeepAlivePacket, MetadataPacket, NakPacket, PromptPacket

public abstract class CfdpPacket
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteBuffer	buffer
static TupleDefinition	CFDP
protected CfdpHeader	header

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfdpPacket()
protected	CfdpPacket(ByteBuffer buffer, CfdpHeader header)
protected	CfdpPacket(CfdpHeader header)

Method Summary

Modifier and Type	Method	Description
static CfdpPacket	fromTuple(Tuple tuple)
static CfdpPacket	getCFDPPacket(ByteBuffer bb)	Reads a CFDP PDU from the ByteBuffer which has to have the position set to 0.
abstract int	getDataFieldLength()
CfdpHeader	getHeader()
CfdpTransactionId	getTransactionId()
byte[]	toByteArray()
Tuple	toTuple(CfdpTransactionId id, long startTime)
Tuple	toTuple(OngoingCfdpTransfer trans)
protected abstract void	writeCFDPPacket(ByteBuffer buffer)
void	writeToBuffer(ByteBuffer buffer)

Methods inherited from class java.lang.Object

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

Field Detail

buffer

protected ByteBuffer buffer

header

protected CfdpHeader header

CFDP

public static final TupleDefinition CFDP

Constructor Detail

CfdpPacket

protected CfdpPacket()

CfdpPacket

protected CfdpPacket(CfdpHeader header)

CfdpPacket

protected CfdpPacket(ByteBuffer buffer,
                     CfdpHeader header)

Method Detail

getHeader

public CfdpHeader getHeader()

getDataFieldLength

public abstract int getDataFieldLength()

getCFDPPacket

public static CfdpPacket getCFDPPacket(ByteBuffer bb)
                                throws PduDecodingException

Reads a CFDP PDU from the ByteBuffer which has to have the position set to 0.

The buffer can contain more data than one PDU, at the end of the call the position will be set to the end of the PDU.

In case of error (e.g. cannot decode header) a PduDecodingException is thrown and the position is undetermined.

Throws:

PduDecodingException

toByteArray

public byte[] toByteArray()

writeToBuffer

public void writeToBuffer(ByteBuffer buffer)

toTuple

public Tuple toTuple(OngoingCfdpTransfer trans)

toTuple

public Tuple toTuple(CfdpTransactionId id,
                     long startTime)

fromTuple

public static CfdpPacket fromTuple(Tuple tuple)

getTransactionId

public CfdpTransactionId getTransactionId()

writeCFDPPacket

protected abstract void writeCFDPPacket(ByteBuffer buffer)