dtn::data::PayloadBlock Class Reference

#include <PayloadBlock.h>

Inheritance diagram for dtn::data::PayloadBlock:

List of all members.

Public Member Functions
	PayloadBlock (NetworkFrame *frame)
	PayloadBlock (Block *block)
virtual	~PayloadBlock ()
unsigned char *	getPayload () const
void	setPayload (const unsigned char *data, unsigned int size)
pair< unsigned int, unsigned int >	getPayloadRange () const
unsigned int	getLength () const
Static Public Attributes
static const unsigned char	BLOCK_TYPE = 1

---

Detailed Description

A PayloadBlock can be attached to a bundle and carry application payload. Additional this class is used as base for custody signals and status reports.

---

Constructor & Destructor Documentation

dtn::data::PayloadBlock::PayloadBlock

(

NetworkFrame *

frame

)

References dtn::data::Block::m_processed.

dtn::data::PayloadBlock::PayloadBlock

(

Block *

block

)

References dtn::data::Block::m_processed.

dtn::data::PayloadBlock::~PayloadBlock

(

)

[virtual]

destructor

---

Member Function Documentation

unsigned char * dtn::data::PayloadBlock::getPayload

(

)

const

Return a pointer to the payload of this block.

Returns:

A pointer to the payload.

References dtn::data::NetworkFrame::get(), dtn::data::Block::getBodyIndex(), and dtn::data::Block::getFrame().

Referenced by dtn::daemon::EchoWorker::callbackBundleReceived(), dtn::data::CustodySignalBlock::CustodySignalBlock(), dtn::data::BundleFactory::cut(), dtn::data::AdministrativeBlock::identify(), dtn::data::PayloadBlockFactory::merge(), dtn::data::BundleFactory::slice(), and dtn::data::StatusReportBlock::StatusReportBlock().

void dtn::data::PayloadBlock::setPayload	(	const unsigned char *	data,
		unsigned int	size
	)

Set the payload of this PayloadBlock. It copy the given data to the existing data array of the bundle.

References dtn::data::Block::getBodyIndex(), dtn::data::Block::getFrame(), and dtn::data::NetworkFrame::set().

Referenced by dtn::data::PayloadBlockFactory::newPayloadBlock().

pair< unsigned int, unsigned int > dtn::data::PayloadBlock::getPayloadRange

(

)

const

Get the range of the payload in the data array. e.g. if the payload data begins at 15th byte and has a size of 64 byte, then the pair <15, 79> is returned.

Returns:

a pair of two unsigned integer

References dtn::data::Block::getBodyIndex(), dtn::data::Block::getFrame(), and dtn::data::NetworkFrame::getSize().

Referenced by dtn::data::BundleFactory::cutAt().

unsigned int dtn::data::PayloadBlock::getLength

(

)

const

Return the length of the payload.

Returns:

The length of the payload.

References dtn::data::Block::getBodyIndex(), dtn::data::Block::getFrame(), and dtn::data::NetworkFrame::getSDNV().

Referenced by dtn::daemon::EchoWorker::callbackBundleReceived(), dtn::data::BundleFactory::cut(), dtn::data::PayloadBlockFactory::merge(), dtn::data::BundleFactory::merge(), and dtn::data::BundleFactory::slice().

---

Member Data Documentation

const unsigned char dtn::data::PayloadBlock::BLOCK_TYPE = 1 [static]

Reimplemented from dtn::data::Block.

Referenced by dtn::data::PayloadBlockFactory::getBlockType(), dtn::data::PayloadBlockFactory::newCustodySignalBlock(), dtn::data::PayloadBlockFactory::newPayloadBlock(), dtn::data::PayloadBlockFactory::newStatusReportBlock(), and dtn::data::BundleFactory::~BundleFactory().

---

The documentation for this class was generated from the following files:

• include/data/PayloadBlock.h
• src/data/PayloadBlock.cpp