ns3::PbbAddressTlvBlock Class Reference

A block of Address TLVs (PbbAddressTlv). More...

#include <packetbb.h>

Public Types
typedef std::list< Ptr < PbbAddressTlv > >::const_iterator	ConstIterator
typedef std::list< Ptr < PbbAddressTlv > >::iterator	Iterator

Public Member Functions
Ptr< PbbAddressTlv >	Back (void) const
Iterator	Begin (void)
ConstIterator	Begin (void) const
void	Clear (void)
	Removes all Address TLVs from this block.
void	Deserialize (Buffer::Iterator &start)
	Deserializes a block from the specified buffer. More...
bool	Empty (void) const
Iterator	End (void)
ConstIterator	End (void) const
Iterator	Erase (Iterator position)
	Removes the Address TLV at the specified position. More...
Iterator	Erase (Iterator first, Iterator last)
	Removes all Address TLVs from [first, last) (includes first, not includes last). More...
Ptr< PbbAddressTlv >	Front (void) const
uint32_t	GetSerializedSize (void) const
Iterator	Insert (Iterator position, const Ptr< PbbAddressTlv > tlv)
	Inserts an Address TLV at the specified position in this block. More...
bool	operator!= (const PbbAddressTlvBlock &other) const
bool	operator== (const PbbAddressTlvBlock &other) const
void	PopBack (void)
	Removes an Address TLV from the back of this block.
void	PopFront (void)
	Removes an AddressTLV from the front of this block.
void	Print (std::ostream &os) const
	Pretty-prints the contents of this block. More...
void	Print (std::ostream &os, int level) const
	Pretty-prints the contents of this block, with specified indentation. More...
void	PushBack (Ptr< PbbAddressTlv > tlv)
	Appends an Address TLV to the back of this block. More...
void	PushFront (Ptr< PbbAddressTlv > tlv)
	Prepends an Address TLV to the front of this block. More...
void	Serialize (Buffer::Iterator &start) const
	Serializes this block into the specified buffer. More...
int	Size (void) const

Private Attributes
std::list< Ptr< PbbAddressTlv > >	m_tlvList

Detailed Description

A block of Address TLVs (PbbAddressTlv).

Acts similar to a C++ STL container.

Definition at line 207 of file packetbb.h.

Member Function Documentation

Ptr< PbbAddressTlv > ns3::PbbAddressTlvBlock::Back

(

void

)

const

Returns

the last AddressTLV in this block.

Definition at line 366 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PbbAddressBlock::TlvBack().

PbbAddressTlvBlock::Iterator ns3::PbbAddressTlvBlock::Begin

(

void

)

Returns

an iterator to the first Address TLV in this block.

Definition at line 317 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by Clear(), GetSerializedSize(), Print(), Serialize(), and ns3::PbbAddressBlock::TlvBegin().

PbbAddressTlvBlock::ConstIterator ns3::PbbAddressTlvBlock::Begin

(

void

)

const

Returns

a const iterator to the first Address TLV in this block.

Definition at line 324 of file packetbb.cc.

References NS_LOG_FUNCTION.

void ns3::PbbAddressTlvBlock::Deserialize

(

Buffer::Iterator &

start

)

Deserializes a block from the specified buffer.

Parameters

start

a reference to the point in a buffer to begin deserializing.

Users should not need to call this. Blocks will be deserialized by their containing packet.

Definition at line 469 of file packetbb.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), NS_LOG_FUNCTION, PushBack(), and ns3::Buffer::Iterator::ReadNtohU16().

Referenced by ns3::PbbAddressBlock::Deserialize().

bool ns3::PbbAddressTlvBlock::Empty

(

void

)

const

Returns

true if there are no Address TLVs in this block, false otherwise.

Definition at line 352 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by Serialize(), and ns3::PbbAddressBlock::TlvEmpty().

PbbAddressTlvBlock::Iterator ns3::PbbAddressTlvBlock::End

(

void

)

Returns

an iterator to the past-the-end element in this block.

Definition at line 331 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by Clear(), GetSerializedSize(), Print(), Serialize(), and ns3::PbbAddressBlock::TlvEnd().

PbbAddressTlvBlock::ConstIterator ns3::PbbAddressTlvBlock::End

(

void

)

const

Returns

a const iterator to the past-the-end element in this block.

Definition at line 338 of file packetbb.cc.

References NS_LOG_FUNCTION.

PbbAddressTlvBlock::Iterator ns3::PbbAddressTlvBlock::Erase

(

PbbAddressTlvBlock::Iterator

position

)

Removes the Address TLV at the specified position.

Parameters

position

an Iterator pointing to the Address TLV to erase.

Returns

an iterator pointing to the next Address TLV in the block.

Definition at line 408 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PbbAddressBlock::TlvErase().

PbbAddressTlvBlock::Iterator ns3::PbbAddressTlvBlock::Erase	(	PbbAddressTlvBlock::Iterator	first,
		PbbAddressTlvBlock::Iterator	last
	)

Removes all Address TLVs from [first, last) (includes first, not includes last).

Parameters

first	an Iterator pointing to the first Address TLV to erase (inclusive).
last	an Iterator pointing to the element past the last Address TLV to erase.

Returns

an iterator pointing to the next Address TLV in the block.

Definition at line 415 of file packetbb.cc.

References NS_LOG_FUNCTION.

Ptr< PbbAddressTlv > ns3::PbbAddressTlvBlock::Front

(

void

)

const

Returns

the first Address TLV in this block.

Definition at line 359 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PbbAddressBlock::TlvFront().

uint32_t ns3::PbbAddressTlvBlock::GetSerializedSize

(

void

)

const

Returns

The size (in bytes) needed to serialize this block.

Definition at line 433 of file packetbb.cc.

References Begin(), End(), and NS_LOG_FUNCTION.

Referenced by ns3::PbbAddressBlock::GetSerializedSize().

PbbAddressTlvBlock::Iterator ns3::PbbAddressTlvBlock::Insert	(	PbbAddressTlvBlock::Iterator	position,
		const Ptr< PbbAddressTlv >	tlv
	)

Inserts an Address TLV at the specified position in this block.

Parameters

position	an Iterator pointing to the position in this block to insert the Address TLV.
tlv	a smart pointer to the Address TLV to insert.

Returns

An iterator pointing to the newly inserted Address TLV.

Definition at line 401 of file packetbb.cc.

References NS_LOG_FUNCTION.

void ns3::PbbAddressTlvBlock::Print

(

std::ostream &

os

)

const

Pretty-prints the contents of this block.

Parameters

os	a stream object to print to.

Definition at line 487 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PbbAddressBlock::Print().

void ns3::PbbAddressTlvBlock::Print	(	std::ostream &	os,
		int	level
	)		const

Pretty-prints the contents of this block, with specified indentation.

Parameters

os	a stream object to print to.
level	level of indentation.

This probably never needs to be called by users. This is used when recursively printing sub-objects.

Definition at line 494 of file packetbb.cc.

References Begin(), End(), NS_LOG_FUNCTION, and Size().

void ns3::PbbAddressTlvBlock::PushBack

(

Ptr< PbbAddressTlv >

tlv

)

Appends an Address TLV to the back of this block.

Parameters

tlv	a smart pointer to the Address TLV to append.

Definition at line 387 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by Deserialize(), and ns3::PbbAddressBlock::TlvPushBack().

void ns3::PbbAddressTlvBlock::PushFront

(

Ptr< PbbAddressTlv >

tlv

)

Prepends an Address TLV to the front of this block.

Parameters

tlv	a smart pointer to the Address TLV to prepend.

Definition at line 373 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::PbbAddressBlock::TlvPushFront().

void ns3::PbbAddressTlvBlock::Serialize

(

Buffer::Iterator &

start

)

const

Serializes this block into the specified buffer.

Parameters

start

a reference to the point in a buffer to begin serializing.

Users should not need to call this. Blocks will be serialized by their containing packet.

Definition at line 446 of file packetbb.cc.

References Begin(), Empty(), End(), ns3::Buffer::Iterator::GetDistanceFrom(), ns3::Buffer::Iterator::Next(), NS_LOG_FUNCTION, and ns3::Buffer::Iterator::WriteHtonU16().

Referenced by ns3::PbbAddressBlock::Serialize().

int ns3::PbbAddressTlvBlock::Size

(

void

)

const

Returns

the number of Address TLVs in this block.

Definition at line 345 of file packetbb.cc.

References NS_LOG_FUNCTION.

Referenced by Print(), and ns3::PbbAddressBlock::TlvSize().

---

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

• src/network/utils/packetbb.h
• src/network/utils/packetbb.cc