dtn::data::Block Class Reference

#include <Block.h>

Inheritance diagram for dtn::data::Block:

Collaboration diagram for dtn::data::Block:

Public Types
enum	ProcFlags {   REPLICATE_IN_EVERY_FRAGMENT = 1, TRANSMIT_STATUSREPORT_IF_NOT_PROCESSED = 1 << 0x01, DELETE_BUNDLE_IF_NOT_PROCESSED = 1 << 0x02, LAST_BLOCK = 1 << 0x03,   DISCARD_IF_NOT_PROCESSED = 1 << 0x04, FORWARDED_WITHOUT_PROCESSED = 1 << 0x05, BLOCK_CONTAINS_EIDS = 1 << 0x06 }
typedef std::list< dtn::data::EID >	eid_list

Public Member Functions
virtual	~Block ()
Block &	operator= (const Block &block)
bool	operator== (const block_t &id) const
virtual void	addEID (const dtn::data::EID &eid)
virtual void	clearEIDs ()
virtual const eid_list &	getEIDList () const
const block_t &	getType () const
void	set (ProcFlags flag, const bool &value)
bool	get (ProcFlags flag) const
const Bitset< ProcFlags > &	getProcessingFlags () const
virtual std::ostream &	serialize (std::ostream &stream, Length &length) const =0
virtual std::istream &	deserialize (std::istream &stream, const Length &length)=0
virtual Length	getLength () const =0
virtual Length	getLength_strict () const
virtual std::ostream &	serialize_strict (std::ostream &stream, Length &length) const

Protected Member Functions
	Block (block_t blocktype)

Protected Attributes
block_t	_blocktype
eid_list	_eids

Friends
class	BundleBuilder

Detailed Description

Definition at line 39 of file Block.h.

Member Typedef Documentation

typedef std::list<dtn::data::EID> dtn::data::Block::eid_list

Definition at line 55 of file Block.h.

Member Enumeration Documentation

enum dtn::data::Block::ProcFlags

Enumerator
REPLICATE_IN_EVERY_FRAGMENT
TRANSMIT_STATUSREPORT_IF_NOT_PROCESSED
DELETE_BUNDLE_IF_NOT_PROCESSED
LAST_BLOCK
DISCARD_IF_NOT_PROCESSED
FORWARDED_WITHOUT_PROCESSED
BLOCK_CONTAINS_EIDS

Definition at line 44 of file Block.h.

Constructor & Destructor Documentation

dtn::data::Block::~Block ( )

virtual

Definition at line 37 of file Block.cpp.

dtn::data::Block::Block ( block_t  blocktype )

protected

The constructor of this class is protected to prevent instantiation of this abstract class.

Parameters

blocktype

The type of the block.

Definition at line 32 of file Block.cpp.

Member Function Documentation

void dtn::data::Block::addEID ( const dtn::data::EID &  eid )

virtual

Definition at line 56 of file Block.cpp.

References _eids, BLOCK_CONTAINS_EIDS, and dtn::data::Bitset< E >::setBit().

Referenced by dtn::api::PlainDeserializer::operator>>(), dtn::data::DefaultDeserializer::operator>>(), dtn::data::DefaultDeserializer::read(), and dtn::data::SeparateDeserializer::readBlock().

Here is the call graph for this function:

void dtn::data::Block::clearEIDs ( )

virtual

Definition at line 64 of file Block.cpp.

References _eids, BLOCK_CONTAINS_EIDS, and dtn::data::Bitset< E >::setBit().

Referenced by dtn::security::SecurityBlock::decryptBlock().

Here is the call graph for this function:

virtual std::istream& dtn::data::Block::deserialize ( std::istream &  stream, const Length &  length  )

pure virtual

Deserialize the derived block payload.

Parameters

stream

A input stream to deserialize from.

Returns

The same reference as given with the stream parameter.

Implemented in dtn::security::SecurityBlock, dtn::security::PayloadIntegrityBlock, dtn::data::ExtensionBlock, dtn::data::CompressedPayloadBlock, dtn::data::StreamBlock, dtn::data::SchedulingBlock, dtn::data::ScopeControlHopLimitBlock, dtn::data::AgeBlock, dtn::data::PayloadBlock, and dtn::data::TrackingBlock.

Referenced by dtn::api::PlainDeserializer::operator>>(), dtn::data::DefaultDeserializer::operator>>(), dtn::data::DefaultDeserializer::read(), and dtn::data::SeparateDeserializer::readBlock().

bool dtn::data::Block::get

(

ProcFlags

flag

)

const

Definition at line 82 of file Block.cpp.

References dtn::data::Bitset< E >::getBit().

Referenced by dtn::security::MutualSerializer::getLength(), dtn::data::DefaultSerializer::getLength(), dtn::data::SeparateSerializer::getLength(), dtn::data::BundleBuilder::insert(), dtn::api::PlainSerializer::operator<<(), dtn::security::StrictSerializer::operator<<(), dtn::security::MutualSerializer::operator<<(), dtn::data::DefaultSerializer::operator<<(), dtn::data::SeparateSerializer::operator<<(), dtn::data::DefaultDeserializer::operator>>(), dtn::data::DefaultDeserializer::read(), dtn::data::SeparateDeserializer::readBlock(), dtn::data::DefaultSerializer::serialize(), and dtn::core::BundleCore::validate().

Here is the call graph for this function:

const Block::eid_list & dtn::data::Block::getEIDList ( ) const

virtual

Definition at line 72 of file Block.cpp.

References _eids.

Referenced by dtn::data::Dictionary::add(), dtn::security::MutualSerializer::getLength(), dtn::data::DefaultSerializer::getLength(), dtn::data::SeparateSerializer::getLength(), dtn::data::DefaultSerializer::isCompressable(), dtn::api::PlainSerializer::operator<<(), dtn::security::StrictSerializer::operator<<(), dtn::security::MutualSerializer::operator<<(), dtn::data::DefaultSerializer::operator<<(), dtn::data::SeparateSerializer::operator<<(), and dtn::data::DefaultSerializer::serialize().

virtual Length dtn::data::Block::getLength ( ) const

pure virtual

Return the length of the payload, if this were an abstract block. It is the length put in the third field, after block type and processing flags.

Implemented in dtn::security::SecurityBlock, dtn::data::ExtensionBlock, dtn::data::CompressedPayloadBlock, dtn::data::StreamBlock, dtn::data::SchedulingBlock, dtn::data::ScopeControlHopLimitBlock, dtn::data::AgeBlock, dtn::data::PayloadBlock, and dtn::data::TrackingBlock.

Referenced by dtn::security::MutualSerializer::getLength(), dtn::data::DefaultSerializer::getLength(), dtn::data::SeparateSerializer::getLength(), getLength_strict(), dtn::api::PlainSerializer::operator<<(), dtn::api::NativeSerializer::operator<<(), dtn::security::MutualSerializer::operator<<(), dtn::data::DefaultSerializer::operator<<(), dtn::data::SeparateSerializer::operator<<(), dtn::data::DefaultDeserializer::operator>>(), dtn::api::ExtendedApiHandler::run(), and dtn::api::PlainSerializer::writeData().

Length dtn::data::Block::getLength_strict ( ) const

virtual

Return the length of the payload in strict format

Reimplemented in dtn::data::AgeBlock, and dtn::data::TrackingBlock.

Definition at line 92 of file Block.cpp.

References getLength().

Referenced by dtn::security::StrictSerializer::operator<<().

Here is the call graph for this function:

const Bitset< Block::ProcFlags > & dtn::data::Block::getProcessingFlags

(

)

const

Definition at line 87 of file Block.cpp.

Referenced by dtn::data::DefaultSerializer::getLength(), dtn::data::SeparateSerializer::getLength(), dtn::security::StrictSerializer::operator<<(), dtn::security::MutualSerializer::operator<<(), dtn::data::DefaultSerializer::operator<<(), dtn::data::SeparateSerializer::operator<<(), and dtn::data::DefaultSerializer::serialize().

const block_t& dtn::data::Block::getType ( ) const

inline

Definition at line 73 of file Block.h.

References _blocktype.

Referenced by dtn::security::MutualSerializer::getLength(), dtn::data::DefaultSerializer::getLength(), dtn::data::SeparateSerializer::getLength(), dtn::security::SecurityBlock::isCorrelatorPresent(), dtn::api::PlainSerializer::operator<<(), dtn::security::StrictSerializer::operator<<(), dtn::security::MutualSerializer::operator<<(), dtn::data::operator<<(), dtn::data::DefaultSerializer::operator<<(), dtn::data::SeparateSerializer::operator<<(), dtn::core::BundleCore::processBlocks(), dtn::data::DefaultSerializer::serialize(), and dtn::storage::SQLiteBundleStorage::store().

Block & dtn::data::Block::operator=

(

const Block &

block

)

assignment operator

Definition at line 41 of file Block.cpp.

References _eids, dtn::data::Bitset< E >::getBit(), LAST_BLOCK, and dtn::data::Bitset< E >::setBit().

Here is the call graph for this function:

bool dtn::data::Block::operator==

(

const block_t &

id

)

const

allow comparison with the block type only

Definition at line 51 of file Block.cpp.

References _blocktype.

virtual std::ostream& dtn::data::Block::serialize ( std::ostream &  stream, Length &  length  ) const

pure virtual

Serialize the derived block payload.

Parameters

stream

A output stream to serialize into.

Returns

The same reference as given with the stream parameter.

Implemented in dtn::security::SecurityBlock, dtn::data::ExtensionBlock, dtn::data::CompressedPayloadBlock, dtn::data::StreamBlock, dtn::data::SchedulingBlock, dtn::data::ScopeControlHopLimitBlock, dtn::data::AgeBlock, dtn::data::PayloadBlock, and dtn::data::TrackingBlock.

Referenced by dtn::api::PlainSerializer::operator<<(), dtn::api::NativeSerializer::operator<<(), dtn::security::MutualSerializer::operator<<(), dtn::data::DefaultSerializer::operator<<(), dtn::data::SeparateSerializer::operator<<(), serialize_strict(), and dtn::api::PlainSerializer::writeData().

std::ostream & dtn::data::Block::serialize_strict ( std::ostream &  stream, Length &  length  ) const

virtual

Serialize the block in a strict way. Dynamic fields are set to the last deserialized value.

Parameters

stream

the stream to be written into

Returns

the same stream as the parameter for chaining

Reimplemented in dtn::security::SecurityBlock, dtn::data::AgeBlock, and dtn::data::TrackingBlock.

Definition at line 97 of file Block.cpp.

References serialize().

Referenced by dtn::security::StrictSerializer::operator<<().

Here is the call graph for this function:

void dtn::data::Block::set	(	ProcFlags	flag,
		const bool &	value
	)

Definition at line 77 of file Block.cpp.

References dtn::data::Bitset< E >::setBit().

Referenced by dtn::security::BundleAuthenticationBlock::auth(), dtn::security::PayloadConfidentialBlock::encrypt(), dtn::data::BundleBuilder::insert(), dtn::api::PlainDeserializer::operator>>(), dtn::api::ExtendedApiHandler::run(), and dtn::security::PayloadIntegrityBlock::sign().

Here is the call graph for this function:

Friends And Related Function Documentation

friend class BundleBuilder

friend

Definition at line 41 of file Block.h.

Member Data Documentation

block_t dtn::data::Block::_blocktype

protected

Definition at line 119 of file Block.h.

Referenced by dtn::security::SecurityBlock::deserialize(), getType(), operator==(), and dtn::data::ExtensionBlock::setType().

eid_list dtn::data::Block::_eids

protected

Definition at line 122 of file Block.h.

Referenced by addEID(), clearEIDs(), dtn::security::SecurityBlock::deserialize(), getEIDList(), operator=(), and dtn::security::SecurityBlock::store_security_references().

---

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

• ibrdtn/ibrdtn/data/Block.h
• ibrdtn/ibrdtn/data/Block.cpp