network packets More...

#include <packet.h>

Inheritance diagram for ns3::Packet:

Collaboration diagram for ns3::Packet:

Public Member Functions
	Packet ()
	Create an empty packet with a new uid (as returned by getUid). More...

	Packet (const Packet &o)

	Packet (uint32_t size)
	Create a packet with a zero-filled payload. More...

	Packet (uint8_t const *buffer, uint32_t size, bool magic)
	Create a new packet from the serialized buffer. More...

	Packet (uint8_t const *buffer, uint32_t size)
	Create a packet with payload filled with the content of this buffer. More...

void	AddAtEnd (Ptr< const Packet > packet)
	Concatenate the input packet at the end of the current packet. More...

void	AddByteTag (const Tag &tag) const
	Tag each byte included in this packet with a new byte tag. More...

void	AddHeader (const Header &header)
	Add header to this packet. More...

void	AddPacketTag (const Tag &tag) const
	Add a packet tag. More...

void	AddPaddingAtEnd (uint32_t size)

void	AddTrailer (const Trailer &trailer)
	Add trailer to this packet. More...

PacketMetadata::ItemIterator	BeginItem (void) const

Ptr< Packet >	Copy (void) const

uint32_t	CopyData (uint8_t *buffer, uint32_t size) const
	Copy the packet contents to a byte buffer. More...

void	CopyData (std::ostream *os, uint32_t size) const
	Copy the packet contents to an output stream. More...

Ptr< Packet >	CreateFragment (uint32_t start, uint32_t length) const
	Create a new packet which contains a fragment of the original packet. More...

bool	FindFirstMatchingByteTag (Tag &tag) const

ByteTagIterator	GetByteTagIterator (void) const

Ptr< NixVector >	GetNixVector (void) const
	Get the packet nix-vector. More...

PacketTagIterator	GetPacketTagIterator (void) const

uint32_t	GetSerializedSize (void) const

uint32_t	GetSize (void) const

uint64_t	GetUid (void) const
	A packet is allocated a new uid when it is created empty or with zero-filled payload. More...

Packet &	operator= (const Packet &o)

uint8_t const *	PeekData (void) const NS_DEPRECATED

uint32_t	PeekHeader (Header &header) const
	Deserialize but does not remove the header from the internal buffer. More...

bool	PeekPacketTag (Tag &tag) const
	Search a matching tag and call Tag::Deserialize if it is found. More...

uint32_t	PeekTrailer (Trailer &trailer)
	Deserialize but does not remove a trailer from the internal buffer. More...

void	Print (std::ostream &os) const

void	PrintByteTags (std::ostream &os) const

void	PrintPacketTags (std::ostream &os) const
	Print the list of packet tags. More...

void	RemoveAllByteTags (void)
	Remove all byte tags stored in this packet. More...

void	RemoveAllPacketTags (void)
	Remove all packet tags. More...

void	RemoveAtEnd (uint32_t size)
	Remove size bytes from the end of the current packet It is safe to remove more bytes than are present in the packet. More...

void	RemoveAtStart (uint32_t size)
	Remove size bytes from the start of the current packet. More...

uint32_t	RemoveHeader (Header &header)
	Deserialize and remove the header from the internal buffer. More...

bool	RemovePacketTag (Tag &tag)
	Remove a packet tag. More...

uint32_t	RemoveTrailer (Trailer &trailer)
	Remove a deserialized trailer from the internal buffer. More...

bool	ReplacePacketTag (Tag &tag)
	Replace the value of a packet tag. More...

uint32_t	Serialize (uint8_t *buffer, uint32_t maxSize) const
	Serialize a packet, tags, and metadata into a byte buffer. More...

void	SetNixVector (Ptr< NixVector >)
	Set the packet nix-vector. More...

Public Member Functions inherited from ns3::SimpleRefCount< Packet >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Static Public Member Functions
static void	EnableChecking (void)
	The packet metadata is also used to perform extensive sanity checks at runtime when performing operations on a Packet. More...

static void	EnablePrinting (void)
	By default, packets do not keep around enough metadata to perform the operations requested by the Print methods. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Packet >
static void	Cleanup (void)
	Noop. More...

Private Member Functions
	Packet (const Buffer &buffer, const ByteTagList &byteTagList, const PacketTagList &packetTagList, const PacketMetadata &metadata)

uint32_t	Deserialize (uint8_t const *buffer, uint32_t size)

Private Attributes
Buffer	m_buffer

ByteTagList	m_byteTagList

PacketMetadata	m_metadata

Ptr< NixVector >	m_nixVector

PacketTagList	m_packetTagList

Static Private Attributes
static uint32_t	m_globalUid = 0

Detailed Description

network packets

Each network packet contains a byte buffer, a set of byte tags, a set of packet tags, and metadata.

The byte buffer stores the serialized content of the headers and trailers added to a packet. The serialized representation of these headers is expected to match that of real network packets bit for bit (although nothing forces you to do this) which means that the content of a packet buffer is expected to be that of a real packet.
The metadata describes the type of the headers and trailers which were serialized in the byte buffer. The maintenance of metadata is optional and disabled by default. To enable it, you must call Packet::EnablePrinting and this will allow you to get non-empty output from Packet::Print. If you wish to only enable checking of metadata, and do not need any printing capability, you can call Packet::EnableChecking: its runtime cost is lower than Packet::EnablePrinting.
The set of tags contain simulation-specific information which cannot be stored in the packet byte buffer because the protocol headers or trailers have no standard-conformant field for this information. So-called 'byte' tags are used to tag a subset of the bytes in the packet byte buffer while 'packet' tags are used to tag the packet itself. The main difference between these two kinds of tags is what happens when packets are copied, fragmented, and reassembled: 'byte' tags follow bytes while 'packet' tags follow packets. Another important difference between these two kinds of tags is that byte tags cannot be removed and are expected to be written once, and read many times, while packet tags are expected to be written once, read many times, and removed exactly once. An example of a 'byte' tag is a FlowIdTag which contains a flow id and is set by the application generating traffic. An example of a 'packet' tag is a cross-layer qos class id set by an application and processed by a lower-level MAC layer.

Implementing a new type of Header or Trailer for a new protocol is pretty easy and is a matter of creating a subclass of the ns3::Header or of the ns3::Trailer base class, and implementing the methods described in their respective API documentation.

Implementing a new type of Tag requires roughly the same amount of work and this work is described in the ns3::Tag API documentation.

The performance aspects copy-on-write semantics of the Packet API are discussed in Packet Performance

Definition at line 203 of file packet.h.

Constructor & Destructor Documentation

ns3::Packet::Packet ( )

Create an empty packet with a new uid (as returned by getUid).

Definition at line 130 of file packet.cc.

References m_globalUid.

Referenced by CreateFragment().

Here is the caller graph for this function:

ns3::Packet::Packet ( const Packet & o )

Definition at line 146 of file packet.cc.

References ns3::NixVector::Copy(), and m_nixVector.

Here is the call graph for this function:

ns3::Packet::Packet ( uint32_t size )

Create a packet with a zero-filled payload.

The memory necessary for the payload is not allocated: it will be allocated at any later point if you attempt to fragment this packet or to access the zero-filled bytes. The packet is allocated with a new uid (as returned by getUid).

Parameters

size	the size of the zero-filled payload

Definition at line 172 of file packet.cc.

References m_globalUid.

ns3::Packet::Packet	(	uint8_t const *	buffer,
		uint32_t	size,
		bool	magic
	)

Create a new packet from the serialized buffer.

This new packet is identical to the serialized packet contained in the buffer and is magically deserialized for you

Parameters

buffer	the serialized packet to be created
size	the size of the packet for deserialization
magic	allows packet deserialization; asserts when set to false

Definition at line 187 of file packet.cc.

References Deserialize(), and NS_ASSERT.

Here is the call graph for this function:

ns3::Packet::Packet	(	uint8_t const *	buffer,
		uint32_t	size
	)

Create a packet with payload filled with the content of this buffer.

The input data is copied: the input buffer is untouched.

Parameters

buffer	the data to store in the packet.
size	the size of the input buffer.

Definition at line 198 of file packet.cc.

References ns3::Buffer::AddAtStart(), ns3::Buffer::Begin(), m_buffer, m_globalUid, and ns3::Buffer::Iterator::Write().

Here is the call graph for this function:

ns3::Packet::Packet	(	const Buffer &	buffer,
		const ByteTagList &	byteTagList,
		const PacketTagList &	packetTagList,
		const PacketMetadata &	metadata
	)

private

Definition at line 217 of file packet.cc.

Member Function Documentation

void ns3::Packet::AddAtEnd ( Ptr< const Packet > packet )

Concatenate the input packet at the end of the current packet.

This does not alter the uid of either packet.

Parameters

packet packet to concatenate

Definition at line 317 of file packet.cc.

References ns3::ByteTagList::Add(), ns3::PacketMetadata::AddAtEnd(), ns3::ByteTagList::AddAtEnd(), ns3::Buffer::AddAtEnd(), ns3::ByteTagList::AddAtStart(), ns3::Buffer::GetCurrentEndOffset(), ns3::Buffer::GetCurrentStartOffset(), GetSize(), ns3::Buffer::GetSize(), m_buffer, m_byteTagList, m_metadata, and NS_LOG_FUNCTION.

Referenced by ns3::OriginatorRxStatus::AccumulateLastFragment(), ns3::CsmaNetDevice::AddHeader(), ns3::MsduStandardAggregator::Aggregate(), ns3::PendingData::CopyFromOffset(), ns3::TcpTxBuffer::CopyFromSequence(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::BaseStationNetDevice::DoReceive(), ns3::SubscriberStationNetDevice::DoReceive(), Ns3WimaxFragmentationTestCase::DoRun(), PacketTest::DoRun(), PacketMetadataTest::DoRun(), ns3::Ipv6ExtensionFragment::Fragments::GetPacket(), ns3::SixLowPanNetDevice::Fragments::GetPacket(), ns3::Ipv4L3Protocol::Fragments::GetPacket(), ns3::Ipv6ExtensionFragment::Fragments::GetPartialPacket(), ns3::Ipv4L3Protocol::Fragments::GetPartialPacket(), ns3::LteRlcUm::ReassembleAndDeliver(), ns3::LteRlcAm::ReassembleAndDeliver(), ns3::olsr::RoutingProtocol::SendQueuedMessages(), and ns3::Icmpv6L4Protocol::SendRedirection().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::AddByteTag ( const Tag & tag ) const

Tag each byte included in this packet with a new byte tag.

Parameters

tag	the new tag to add to this packet

Note that adding a tag is a const operation which is pretty un-intuitive. The rationale is that the content and behavior of a packet is not changed when a tag is added to a packet: any code which was not aware of the new tag is going to work just the same if the new tag is added. The real reason why adding a tag was made a const operation is to allow a trace sink which gets a packet to tag the packet, even if the packet is const (and most trace sources should use const packets because it would be totally evil to allow a trace sink to modify the content of a packet).

Definition at line 808 of file packet.cc.

References ns3::Buffer::GetCurrentEndOffset(), ns3::Buffer::GetCurrentStartOffset(), ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), ns3::Tag::GetSerializedSize(), list, m_buffer, m_byteTagList, NS_LOG_FUNCTION, and ns3::Tag::Serialize().

Referenced by ns3::AnimationInterface::CsmaPhyTxBeginTrace(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcTm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::LteRlcSm::DoNotifyTxOpportunity(), PacketTest::DoRun(), ns3::LtePdcp::DoTransmitPdcpSdu(), ns3::AnimationInterface::LteSpectrumPhyTxStart(), ns3::AnimationInterface::LteTxTrace(), ns3::DelayJitterEstimation::PrepareTx(), CollisionExperiment::SendA(), CollisionExperiment::SendB(), Sender::SendPacket(), ns3::PyViz::TraceNetDevTxCommon(), ns3::AnimationInterface::UanPhyGenTxTrace(), ns3::AnimationInterface::WifiPhyTxBeginTrace(), and ns3::AnimationInterface::WimaxTxTrace().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::AddHeader ( const Header & header )

Add header to this packet.

This method invokes the Header::GetSerializedSize and Header::Serialize methods to reserve space in the buffer and request the header to serialize itself in the packet buffer.

Parameters

header a reference to the header to add to this packet.

Definition at line 253 of file packet.cc.

References ns3::ByteTagList::AddAtStart(), ns3::Buffer::AddAtStart(), ns3::PacketMetadata::AddHeader(), ns3::Buffer::Begin(), ns3::Buffer::GetCurrentStartOffset(), ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), ns3::Header::GetSerializedSize(), m_buffer, m_byteTagList, m_metadata, NS_LOG_FUNCTION, and ns3::Header::Serialize().

Here is the call graph for this function:

void ns3::Packet::AddPacketTag ( const Tag & tag ) const

Add a packet tag.

Parameters

tag	the packet tag type to add.

Note that this method is const, that is, it does not modify the state of this packet, which is fairly un-intuitive. See AddByteTag"()" discussion.

Definition at line 841 of file packet.cc.

References ns3::PacketTagList::Add(), ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), ns3::Tag::GetSerializedSize(), m_packetTagList, and NS_LOG_FUNCTION.

Referenced by benchD(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::UeManager::DoReceivePdcpSdu(), PacketTest::DoRun(), ns3::UdpSocketImpl::DoSendTo(), ns3::LteRlcTm::DoTransmitPdcpPdu(), ns3::LteRlcUm::DoTransmitPdcpPdu(), ns3::LteRlcAm::DoTransmitPdcpPdu(), ns3::LteUeMac::DoTransmitPdu(), ns3::LteEnbMac::DoTransmitPdu(), ns3::dot11s::HwmpProtocol::ForwardUnicast(), ns3::Ipv4RawSocketImpl::ForwardUp(), ns3::PacketSocket::ForwardUp(), ns3::Ipv6RawSocketImpl::ForwardUp(), ns3::UdpSocketImpl::ForwardUp(), ns3::UdpSocketImpl::ForwardUp6(), main(), ns3::WifiRemoteStationManager::PrepareForQueue(), ns3::dot11s::HwmpProtocol::ProactivePathResolved(), ns3::dsr::DsrOptionRreq::Process(), ns3::dot11s::HwmpProtocol::ReactivePathResolved(), ns3::NscTcpSocketImpl::ReadPendingData(), ns3::flame::FlameProtocolMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), ns3::dot11s::HwmpProtocolMac::ReceiveData(), ns3::TcpSocketBase::Recv(), ns3::dot11s::HwmpProtocol::RequestRoute(), ns3::flame::FlameProtocol::RequestRoute(), ns3::aodv::RoutingProtocol::RouteOutput(), ns3::dsdv::RoutingProtocol::RouteOutput(), ns3::dsr::DsrRouting::RouteRequestTimerExpire(), ns3::EpsBearerTagUdpClient::Send(), ns3::Radvd::Send(), ns3::MacLow::SendAckAfterData(), ns3::MacLow::SendCtsAfterRts(), ns3::TcpSocketBase::SendDataPacket(), ns3::TcpSocketBase::SendEmptyPacket(), ns3::dsr::DsrRouting::SendErrorRequest(), ns3::dsr::DsrRouting::SendInitialRequest(), ns3::Icmpv6L4Protocol::SendMessage(), ns3::Ipv4FlowProbe::SendOutgoingLogger(), ns3::UdpSocketImpl::SendTo(), and ns3::EpcEnbApplication::SendToLteSocket().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::AddPaddingAtEnd ( uint32_t size )

Parameters

size	number of padding bytes to add.

Definition at line 333 of file packet.cc.

References ns3::ByteTagList::AddAtEnd(), ns3::Buffer::AddAtEnd(), ns3::PacketMetadata::AddPaddingAtEnd(), ns3::Buffer::GetCurrentEndOffset(), m_buffer, m_byteTagList, m_metadata, and NS_LOG_FUNCTION.

Referenced by SendStuff().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::AddTrailer ( const Trailer & trailer )

Add trailer to this packet.

This method invokes the Trailer::GetSerializedSize and Trailer::Serialize methods to reserve space in the buffer and request the trailer to serialize itself in the packet buffer.

Parameters

trailer a reference to the trailer to add to this packet.

Definition at line 284 of file packet.cc.

References ns3::ByteTagList::AddAtEnd(), ns3::Buffer::AddAtEnd(), ns3::PacketMetadata::AddTrailer(), ns3::Buffer::End(), ns3::Buffer::GetCurrentEndOffset(), ns3::Buffer::GetCurrentStartOffset(), ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), ns3::Trailer::GetSerializedSize(), m_buffer, m_byteTagList, m_metadata, NS_LOG_FUNCTION, and ns3::Trailer::Serialize().

Referenced by ns3::CsmaNetDevice::AddHeader(), PacketTest::DoRun(), ns3::MacLow::SendAckAfterData(), ns3::MacLow::SendBlockAckResponse(), ns3::MacLow::SendCtsAfterRts(), ns3::MacLow::SendCtsToSelf(), ns3::MacLow::SendDataAfterCts(), ns3::MacLow::SendDataPacket(), and ns3::MacLow::SendRtsForPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

PacketMetadata::ItemIterator ns3::Packet::BeginItem ( void ) const

Returns: an iterator which points to the first 'item' stored in this buffer. Note that this iterator will point to an empty array of items if you don't call EnablePrinting or EnableChecking before.

See also: EnablePrinting EnableChecking

Definition at line 546 of file packet.cc.

References ns3::PacketMetadata::BeginItem(), m_buffer, and m_metadata.

Referenced by PacketMetadataTest::CheckHistory(), and ns3::PyViz::FilterPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< Packet > ns3::Packet::Copy ( void ) const

Returns: a COW copy of the packet.

The returns packet will behave like an independent copy of the original packet, even though they both share the same datasets internally.

Definition at line 122 of file packet.cc.

References ns3::PacketTagIterator::Packet.

uint32_t ns3::Packet::CopyData	(	uint8_t *	buffer,
		uint32_t	size
	)		const

Copy the packet contents to a byte buffer.

Parameters

buffer	a pointer to a byte buffer where the packet data should be copied.
size	the size of the byte buffer.

Returns: the number of bytes read from the packet

No more than size bytes will be copied by this function.

Definition at line 381 of file packet.cc.

References ns3::Buffer::CopyData(), and m_buffer.

Here is the call graph for this function:

void ns3::Packet::CopyData	(	std::ostream *	os,
		uint32_t	size
	)		const

Copy the packet contents to an output stream.

Parameters

os	pointer to output stream in which we want to write the packet data.
size	the maximum number of bytes we want to write in the output stream.

Definition at line 387 of file packet.cc.

References ns3::Buffer::CopyData(), and m_buffer.

Here is the call graph for this function:

Ptr< Packet > ns3::Packet::CreateFragment	(	uint32_t	start,
		uint32_t	length
	)		const

Create a new packet which contains a fragment of the original packet.

The returned packet shares the same uid as this packet.

Parameters

start	offset from start of packet to start of fragment to create
length	length of fragment to create

Returns: a fragment of the original packet

Definition at line 228 of file packet.cc.

References ns3::PacketMetadata::CreateFragment(), ns3::Buffer::CreateFragment(), ns3::Buffer::GetSize(), m_buffer, m_byteTagList, m_metadata, m_packetTagList, NS_ASSERT, NS_LOG_FUNCTION, and Packet().

Referenced by ns3::TcpRxBuffer::Add(), ns3::PendingData::CopyFromOffset(), ns3::TcpTxBuffer::CopyFromSequence(), ns3::MsduAggregator::Deaggregate(), ns3::WimaxMacQueue::Dequeue(), ns3::Ipv4L3Protocol::DoFragmentation(), ns3::SixLowPanNetDevice::DoFragmentation(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), PacketTest::DoRun(), PacketMetadataTest::DoRun(), ns3::DcaTxop::GetFragmentPacket(), ns3::EdcaTxopN::GetFragmentPacket(), ns3::Ipv6ExtensionFragment::GetFragments(), ns3::LteRlcUm::ReassembleAndDeliver(), ns3::LteRlcAm::ReassembleAndDeliver(), ns3::Ipv4RawSocketImpl::RecvFrom(), ns3::Ipv6RawSocketImpl::RecvFrom(), ns3::Icmpv6L4Protocol::SendErrorDestinationUnreachable(), ns3::Icmpv6L4Protocol::SendErrorParameterError(), ns3::Icmpv6L4Protocol::SendErrorTimeExceeded(), ns3::Icmpv6L4Protocol::SendErrorTooBig(), and ns3::Icmpv6L4Protocol::SendRedirection().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Packet::Deserialize	(	uint8_t const *	buffer,
		uint32_t	size
	)

private

Todo:: Deserialize Tags

Definition at line 726 of file packet.cc.

References ns3::NixVector::Deserialize(), ns3::PacketMetadata::Deserialize(), ns3::Buffer::Deserialize(), m_buffer, m_metadata, m_nixVector, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by Packet().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::EnableChecking ( void )

static

The packet metadata is also used to perform extensive sanity checks at runtime when performing operations on a Packet.

For example, this metadata is used to verify that when you remove a header from a packet, this same header was actually present at the front of the packet. These errors will be detected and will abort the program.

Definition at line 559 of file packet.cc.

References ns3::PacketMetadata::EnableChecking(), and NS_LOG_FUNCTION_NOARGS.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::EnablePrinting ( void )

static

By default, packets do not keep around enough metadata to perform the operations requested by the Print methods.

If you want to be able the Packet::Print method, you need to invoke this method at least once during the simulation setup and before any packet is created.

Definition at line 552 of file packet.cc.

References ns3::PacketMetadata::Enable(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::LteRlcAmTransmitterTestCase::DoRun(), ns3::LteRlcUmTransmitterTestCase::DoRun(), ns3::UanHelper::EnableAscii(), ns3::FdNetDeviceHelper::EnableAsciiInternal(), ns3::EmuHelper::EnableAsciiInternal(), ns3::PointToPointHelper::EnableAsciiInternal(), ns3::CsmaHelper::EnableAsciiInternal(), ns3::YansWifiPhyHelper::EnableAsciiInternal(), ns3::WimaxHelper::EnableAsciiInternal(), ns3::InternetStackHelper::EnableAsciiIpv4Internal(), ns3::InternetStackHelper::EnableAsciiIpv6Internal(), ns3::AnimationInterface::EnablePacketMetadata(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Packet::FindFirstMatchingByteTag ( Tag & tag ) const

Parameters

tag	the byte tag type to search in this packet

Returns: true if the requested tag type was found, false otherwise.

If the requested tag type is found, it is copied in the user's provided tag instance.

Definition at line 824 of file packet.cc.

References GetByteTagIterator(), ns3::ObjectBase::GetInstanceTypeId(), ns3::ByteTagIterator::Item::GetTag(), ns3::ByteTagIterator::Item::GetTypeId(), ns3::ByteTagIterator::HasNext(), and ns3::ByteTagIterator::Next().

Referenced by ns3::LteRlcTm::DoReceivePdu(), ns3::LteRlcUm::DoReceivePdu(), ns3::LteRlcAm::DoReceivePdu(), ns3::LtePdcp::DoReceivePdu(), ns3::LteRlcSm::DoReceivePdu(), Receiver::Receive(), CollisionExperiment::Receive(), ns3::DelayJitterEstimation::RecordRx(), and ns3::PyViz::TraceNetDevRxCommon().

Here is the call graph for this function:

Here is the caller graph for this function:

ByteTagIterator ns3::Packet::GetByteTagIterator ( void ) const

Returns: an iterator over the set of byte tags included in this packet.

Definition at line 818 of file packet.cc.

References ns3::ByteTagList::Begin(), ns3::Buffer::GetCurrentEndOffset(), ns3::Buffer::GetCurrentStartOffset(), m_buffer, and m_byteTagList.

Referenced by PacketTest::DoCheck(), FindFirstMatchingByteTag(), ns3::AnimationInterface::GetAnimUidFromPacket(), and PrintByteTags().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< NixVector > ns3::Packet::GetNixVector ( void ) const

Get the packet nix-vector.

See the comment on SetNixVector

Definition at line 247 of file packet.cc.

References m_nixVector.

Referenced by ns3::Ipv4NixVectorRouting::RouteInput().

Here is the caller graph for this function:

PacketTagIterator ns3::Packet::GetPacketTagIterator ( void ) const

Returns: an object which can be used to iterate over the list of packet tags.

Definition at line 899 of file packet.cc.

References ns3::PacketTagList::Head(), and m_packetTagList.

Referenced by PrintPacketTags().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Packet::GetSerializedSize ( void ) const

Returns: number of bytes required for packet serialization

For packet serialization, the total size is checked in order to determine the size of the buffer required for serialization

Todo:: Serialze Tags size

Definition at line 565 of file packet.cc.

References ns3::NixVector::GetSerializedSize(), ns3::PacketMetadata::GetSerializedSize(), ns3::Buffer::GetSerializedSize(), m_buffer, m_metadata, and m_nixVector.

Referenced by ns3::Icmpv6L4Protocol::HandleDestinationUnreachable(), ns3::GrantedTimeWindowMpiInterface::SendPacket(), and ns3::NullMessageMpiInterface::SendPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Packet::GetSize ( void ) const

inline

Returns: the size in bytes of the packet (including the zero-filled initial payload)

Definition at line 650 of file packet.h.

References ns3::Buffer::GetSize(), and m_buffer.

Here is the call graph for this function:

uint64_t ns3::Packet::GetUid ( void ) const

A packet is allocated a new uid when it is created empty or with zero-filled payload.

Note: This uid is an internal uid and cannot be counted on to provide an accurate counter of how many "simulated packets" of a particular protocol are in the system. It is not trivial to make this uid into such a counter, because of questions such as what should the uid be when the packet is sent over broadcast media, or when fragmentation occurs. If a user wants to trace actual packet counts, he or she should look at e.g. the IP ID field or transport sequence numbers, or other packet or frame counters at other protocol layers.

Returns: an integer identifier which uniquely identifies this packet.

Definition at line 393 of file packet.cc.

References ns3::PacketMetadata::GetUid(), and m_metadata.

Here is the call graph for this function:

Packet & ns3::Packet::operator= ( const Packet & o )

Definition at line 157 of file packet.cc.

References ns3::NixVector::Copy(), m_buffer, m_byteTagList, m_metadata, m_nixVector, and m_packetTagList.

Here is the call graph for this function:

uint8_t const * ns3::Packet::PeekData ( void ) const

Returns: a pointer to the internal buffer of the packet.

If you try to change the content of the buffer returned by this method, you will die.

Deprecated:: Note that this method is now deprecated and will be removed in a future version of ns-3. To get access to the content of the byte buffer of a packet, call CopyData"()" to perform an explicit copy.

Definition at line 368 of file packet.cc.

References data, ns3::Buffer::GetCurrentStartOffset(), m_buffer, m_byteTagList, NS_LOG_FUNCTION, and ns3::Buffer::PeekData().

Referenced by PacketTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Packet::PeekHeader ( Header & header ) const

Deserialize but does not remove the header from the internal buffer.

This method invokes Header::Deserialize.

Parameters

header a reference to the header to read from the internal buffer.

Returns: the number of bytes read from the packet.

Definition at line 277 of file packet.cc.

References ns3::Buffer::Begin(), ns3::Header::Deserialize(), ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), m_buffer, and NS_LOG_FUNCTION.

Referenced by ns3::UanPhyCalcSinrDual::CalcSinrDb(), ns3::SixLowPanNetDevice::CompressLowPanHc1(), ns3::SixLowPanNetDevice::CompressLowPanIphc(), ns3::SixLowPanNetDevice::CompressLowPanNhc(), ns3::SixLowPanNetDevice::CompressLowPanUdpNhc(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::LteUeRrcProtocolReal::DoReceivePdcpPdu(), ns3::LteEnbRrcProtocolReal::DoReceivePdcpPdu(), ns3::LteUeRrcProtocolReal::DoReceivePdcpSdu(), ns3::LteEnbRrcProtocolReal::DoReceivePdcpSdu(), ns3::LteRlcUm::DoReceivePdu(), ns3::LteRlcAm::DoReceivePdu(), ns3::Ipv4RawSocketImpl::ForwardUp(), ns3::Ipv6RawSocketImpl::ForwardUp(), ns3::EdcaTxopN::GotAck(), ns3::Icmpv4L4Protocol::HandleDestUnreach(), ns3::Icmpv4L4Protocol::HandleTimeExceeded(), ns3::UanMacRc::IsPhy1Ok(), ns3::dsr::DsrRouting::NotifyDataReceipt(), OcbWifiMacTestCase::PhyTxTrace(), ns3::OcbWifiMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), ns3::TcpL4Protocol::Receive(), ns3::UdpL4Protocol::Receive(), ns3::UanMacRcGw::ReceivePacket(), ns3::UanMacRcGw::SendPacket(), ns3::UanMacRc::SendPacket(), SinkRx(), ns3::PyViz::TraceNetDevPromiscRxCsma(), ns3::PyViz::TraceNetDevRxCsma(), ns3::PyViz::TraceNetDevRxWifi(), ns3::PyViz::TraceNetDevTxCsma(), ns3::PyViz::TraceNetDevTxWifi(), ns3::dot11s::PeerManagementProtocolMac::UpdateOutcomingFrame(), and ns3::AnimationInterface::WifiPhyRxBeginTrace().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Packet::PeekPacketTag ( Tag & tag ) const

Search a matching tag and call Tag::Deserialize if it is found.

Parameters

tag	the tag to search in this packet

Returns: true if the requested tag is found, false otherwise.

Definition at line 863 of file packet.cc.

References m_packetTagList, and ns3::PacketTagList::Peek().

Referenced by PacketTest::DoRun(), DynamicGlobalRoutingTestCase::HandleRead(), main(), PrintReceivedPacket(), ns3::QosUtilsGetTidForPacket(), ns3::flame::FlameProtocolMac::Receive(), ns3::dot11s::HwmpProtocolMac::ReceiveData(), ns3::UdpSocketImpl::RecvFrom(), ns3::NscTcpSocketImpl::RecvFrom(), ns3::PacketSocket::RecvFrom(), ns3::dot11s::HwmpProtocol::RequestRoute(), ns3::flame::FlameProtocol::RequestRoute(), ns3::aodv::RoutingProtocol::RouteInput(), ns3::dsdv::RoutingProtocol::RouteInput(), ns3::aodv::RoutingProtocol::RouteOutput(), ns3::dsdv::RoutingProtocol::RouteOutput(), and DynamicGlobalRoutingTestCase::SinkRx().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Packet::PeekTrailer ( Trailer & trailer )

Deserialize but does not remove a trailer from the internal buffer.

This method invokes the Trailer::Deserialize method.

Parameters

trailer a reference to the trailer to read from the internal buffer.

Returns: the number of bytes read from the end of the packet.

Definition at line 309 of file packet.cc.

References ns3::Trailer::Deserialize(), ns3::Buffer::End(), ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), m_buffer, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::Packet::Print ( std::ostream & os ) const

Parameters

os	output stream in which the data should be printed.

Iterate over the headers and trailers present in this packet, from the first header to the last trailer and invoke, for each of them, the user-provided method Header::DoPrint or Trailer::DoPrint methods.

Definition at line 429 of file packet.cc.

Referenced by ns3::Ipv4L3Protocol::DoFragmentation(), ns3::Ipv6ExtensionFragment::GetFragments(), ns3::AnimationInterface::GetPacketMetadata(), main(), and ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::PrintByteTags ( std::ostream & os ) const

Parameters

os	output stream in which the data should be printed.

Iterate over the byte tags present in this packet, and invoke the Print method of each tag stored in the packet.

Definition at line 399 of file packet.cc.

References GetByteTagIterator(), ns3::TypeId::GetConstructor(), ns3::ByteTagIterator::Item::GetEnd(), ns3::TypeId::GetName(), ns3::ByteTagIterator::Item::GetStart(), ns3::ByteTagIterator::Item::GetTag(), ns3::ByteTagIterator::Item::GetTypeId(), ns3::ByteTagIterator::HasNext(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), ns3::ByteTagIterator::Next(), NS_ASSERT, and ns3::Tag::Print().

Here is the call graph for this function:

void ns3::Packet::PrintPacketTags ( std::ostream & os ) const

Print the list of packet tags.

Parameters

os	the stream on which to print the tags.

See also: Packet::AddPacketTag, Packet::RemovePacketTag, Packet::PeekPacketTag, Packet::RemoveAllPacketTags

Definition at line 876 of file packet.cc.

References ns3::TypeId::GetConstructor(), GetPacketTagIterator(), ns3::PacketTagIterator::Item::GetTag(), ns3::PacketTagIterator::Item::GetTypeId(), ns3::TypeId::HasConstructor(), ns3::PacketTagIterator::HasNext(), ns3::PacketTagIterator::Next(), NS_ASSERT, and ns3::Tag::Print().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::RemoveAllByteTags ( void )

Remove all byte tags stored in this packet.

Definition at line 361 of file packet.cc.

References m_byteTagList, NS_LOG_FUNCTION, and ns3::ByteTagList::RemoveAll().

Referenced by Ipv4ForwardingTest::DoRun(), Ipv6ForwardingTest::DoRun(), SixlowpanHc1ImplTest::DoRun(), SixlowpanIphcImplTest::DoRun(), Ipv6RawSocketImplTest::DoRun(), Ipv4HeaderTest::DoRun(), Ipv4RawSocketImplTest::DoRun(), UdpSocketImplTest::DoRun(), Udp6SocketImplTest::DoRun(), dstSocketRecv(), ns3::UdpEchoServer::HandleRead(), Ipv4FragmentationTest::HandleReadServer(), SixlowpanFragmentationTest::HandleReadServer(), Ipv6FragmentationTest::HandleReadServer(), and srcSocketRecv().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::RemoveAllPacketTags ( void )

Remove all packet tags.

Definition at line 869 of file packet.cc.

References m_packetTagList, NS_LOG_FUNCTION, and ns3::PacketTagList::RemoveAll().

Referenced by PacketTest::DoRun(), dstSocketRecv(), ns3::UdpEchoServer::HandleRead(), Ipv4FragmentationTest::HandleReadServer(), SixlowpanFragmentationTest::HandleReadServer(), Ipv6FragmentationTest::HandleReadServer(), and srcSocketRecv().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::RemoveAtEnd ( uint32_t size )

Remove size bytes from the end of the current packet It is safe to remove more bytes than are present in the packet.

Parameters

size	number of bytes from remove

Definition at line 346 of file packet.cc.

References m_buffer, m_metadata, NS_LOG_FUNCTION, ns3::PacketMetadata::RemoveAtEnd(), and ns3::Buffer::RemoveAtEnd().

Referenced by ns3::Ipv6ExtensionFragment::Process(), and ns3::CsmaNetDevice::Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::RemoveAtStart ( uint32_t size )

Remove size bytes from the start of the current packet.

It is safe to remove more bytes than are present in the packet.

Parameters

size	number of bytes from remove

Definition at line 353 of file packet.cc.

References m_buffer, m_metadata, NS_LOG_FUNCTION, ns3::PacketMetadata::RemoveAtStart(), and ns3::Buffer::RemoveAtStart().

Referenced by ns3::dsr::DsrRouting::AddAckReqHeader(), ns3::dsr::DsrRouting::CheckSendBuffer(), ns3::MsduAggregator::Deaggregate(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), PacketTest::DoRun(), ns3::dsr::DsrRouting::LinkScheduleTimerExpire(), ns3::Ipv6L3Protocol::LocalDeliver(), ns3::dsr::DsrRouting::NetworkScheduleTimerExpire(), ns3::Ipv6OptionPad1::Process(), ns3::Ipv6OptionPadn::Process(), ns3::Ipv6ExtensionHopByHop::Process(), ns3::Ipv6OptionJumbogram::Process(), ns3::Ipv6ExtensionDestination::Process(), ns3::Ipv6OptionRouterAlert::Process(), ns3::Ipv6ExtensionFragment::Process(), ns3::Ipv6ExtensionRouting::Process(), ns3::Ipv6ExtensionLooseRouting::Process(), ns3::Ipv6Extension::ProcessOptions(), ns3::dsr::DsrRouting::PromiscReceive(), ns3::LteRlcUm::ReassembleAndDeliver(), ns3::LteRlcAm::ReassembleAndDeliver(), ns3::dsr::DsrRouting::Receive(), ns3::Ipv4RawSocketImpl::RecvFrom(), ns3::Ipv6RawSocketImpl::RecvFrom(), ns3::dsr::DsrRouting::SalvagePacket(), and ns3::dsr::DsrRouting::SendPacketFromBuffer().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Packet::RemoveHeader ( Header & header )

Deserialize and remove the header from the internal buffer.

This method invokes Header::Deserialize.

Parameters

header a reference to the header to remove from the internal buffer.

Returns: the number of bytes removed from the packet.

Definition at line 268 of file packet.cc.

References ns3::Buffer::Begin(), ns3::Header::Deserialize(), ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), m_buffer, m_metadata, NS_LOG_FUNCTION, ns3::Buffer::RemoveAtStart(), and ns3::PacketMetadata::RemoveHeader().

Here is the call graph for this function:

bool ns3::Packet::RemovePacketTag ( Tag & tag )

Remove a packet tag.

Parameters

tag	the packet tag type to remove from this packet. The tag parameter is set to the value of the tag found.

Returns: true if the requested tag is found, false otherwise.

Definition at line 848 of file packet.cc.

References ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), ns3::Tag::GetSerializedSize(), m_packetTagList, NS_LOG_FUNCTION, and ns3::PacketTagList::Remove().

Referenced by benchD(), ns3::LteRlcUm::DoNotifyTxOpportunity(), ns3::LteRlcAm::DoNotifyTxOpportunity(), ns3::LteUeMac::DoReceivePhyPdu(), ns3::LteEnbMac::DoReceivePhyPdu(), PacketTest::DoRun(), ns3::UdpSocketImpl::DoSendTo(), ns3::MeshWifiInterfaceMac::ForwardDown(), ns3::Ipv4RawSocketImpl::ForwardUp(), ns3::Ipv6RawSocketImpl::ForwardUp(), ns3::UdpSocketImpl::ForwardUp(), ns3::UdpSocketImpl::ForwardUp6(), Tunnel::N0SocketRecv(), Tunnel::N1SocketRecv(), Tunnel::N3SocketRecv(), ns3::dot11s::HwmpProtocol::ProactivePathResolved(), ns3::dot11s::HwmpProtocol::ReactivePathResolved(), ns3::MacLow::ReceiveOk(), ReceivePacket(), ns3::EpcEnbApplication::RecvFromLteSocket(), ns3::EpcSgwPgwApplication::RecvFromS1uSocket(), ns3::EpcEnbApplication::RecvFromS1uSocket(), ns3::dot11s::HwmpProtocol::RemoveRoutingStuff(), ns3::flame::FlameProtocol::RemoveRoutingStuff(), ns3::dot11s::HwmpProtocol::RequestRoute(), ns3::flame::FlameProtocol::RequestRoute(), Ipv6PacketInfoTagTest::RxCb(), Ipv4PacketInfoTagTest::RxCb(), ns3::Ipv6L3Protocol::Send(), ns3::Ipv4L3Protocol::Send(), ns3::LteEnbRrc::SendData(), ns3::dsdv::RoutingProtocol::SendPacketFromQueue(), ns3::aodv::RoutingProtocol::SendPacketFromQueue(), ns3::flame::FlameProtocolMac::UpdateOutcomingFrame(), and ns3::dot11s::HwmpProtocolMac::UpdateOutcomingFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::Packet::RemoveTrailer ( Trailer & trailer )

Remove a deserialized trailer from the internal buffer.

This method invokes the Deserialize method.

Parameters

trailer a reference to the trailer to remove from the internal buffer.

Returns: the number of bytes removed from the end of the packet.

Definition at line 300 of file packet.cc.

References ns3::Trailer::Deserialize(), ns3::Buffer::End(), ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), m_buffer, m_metadata, NS_LOG_FUNCTION, ns3::Buffer::RemoveAtEnd(), and ns3::PacketMetadata::RemoveTrailer().

Referenced by PacketTest::DoRun(), ns3::CsmaNetDevice::Receive(), ns3::MacLow::ReceiveOk(), and ns3::MacLow::StoreMpduIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::Packet::ReplacePacketTag ( Tag & tag )

Replace the value of a packet tag.

Parameters

tag	the packet tag type to replace. To get the old value of the tag, use PeekPacketTag first.

Returns: true if the requested tag is found, false otherwise. If the tag isn't found, Add is performed instead (so the packet is guaranteed to have the new tag value either way).

Definition at line 855 of file packet.cc.

References ns3::ObjectBase::GetInstanceTypeId(), ns3::TypeId::GetName(), ns3::Tag::GetSerializedSize(), m_packetTagList, NS_LOG_FUNCTION, and ns3::PacketTagList::Replace().

Here is the call graph for this function:

uint32_t ns3::Packet::Serialize	(	uint8_t *	buffer,
		uint32_t	maxSize
	)		const

Serialize a packet, tags, and metadata into a byte buffer.

Parameters

buffer	a raw byte buffer to which the packet will be serialized
maxSize	the max size of the buffer for bounds checking

Returns: one if all data were serialized, zero if buffer size was too small.

Todo:: Serialize Tags

Definition at line 608 of file packet.cc.

References ns3::NixVector::GetSerializedSize(), ns3::PacketMetadata::GetSerializedSize(), ns3::Buffer::GetSerializedSize(), m_buffer, m_metadata, m_nixVector, ns3::NixVector::Serialize(), ns3::PacketMetadata::Serialize(), and ns3::Buffer::Serialize().

Referenced by ns3::GrantedTimeWindowMpiInterface::SendPacket(), and ns3::NullMessageMpiInterface::SendPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::Packet::SetNixVector ( Ptr< NixVector > nixVector )

Set the packet nix-vector.

Note: This function supports a temporary solution to a specific problem in this generic class, i.e. how to associate something specific like nix-vector with a packet. This design methodology should not be followed, and is only here as an impetus to fix this general issue.

Definition at line 241 of file packet.cc.

References m_nixVector.

Referenced by ns3::Ipv4NixVectorRouting::RouteOutput().

Here is the caller graph for this function: