ns3::Tag Class Reference
[Packet]

tag a set of bytes in a packet More...

#include <tag.h>

Inheritance diagram for ns3::Tag:

Inheritance graph
[legend]
Collaboration diagram for ns3::Tag:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual uint32_t GetSerializedSize (void) const =0
virtual void Serialize (TagBuffer i) const =0
virtual void Deserialize (TagBuffer i)=0
virtual void Print (std::ostream &os) const =0

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::ObjectBase.


Detailed Description

tag a set of bytes in a packet

New kinds of tags can be created by subclassing this base class.


Member Function Documentation

virtual void ns3::Tag::Deserialize ( TagBuffer  i  )  [pure virtual]

Parameters:
i the buffer to read data from.
Read the content of the tag from the provided tag buffer. DO NOT attempt to read more bytes than you wrote with Tag::Serialize.

Implemented in ns3::SocketAddressTag, ns3::SocketIpTtlTag, and ns3::SocketSetDontFragmentTag.

virtual uint32_t ns3::Tag::GetSerializedSize ( void   )  const [pure virtual]

Returns:
the number of bytes required to serialize the data of the tag.
This method is typically invoked by Packet::AddPacketTag or Packet::AddByteTag just prior to calling Tag::Serialize.

Implemented in ns3::SocketAddressTag, ns3::SocketIpTtlTag, and ns3::SocketSetDontFragmentTag.

static TypeId ns3::Tag::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::ObjectBase.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::ObjectBase.

Reimplemented in ns3::SocketAddressTag, ns3::SocketIpTtlTag, and ns3::SocketSetDontFragmentTag.

virtual void ns3::Tag::Print ( std::ostream &  os  )  const [pure virtual]

Parameters:
os the stream to print to
This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implemented in ns3::SocketAddressTag, ns3::SocketIpTtlTag, and ns3::SocketSetDontFragmentTag.

virtual void ns3::Tag::Serialize ( TagBuffer  i  )  const [pure virtual]

Parameters:
i the buffer to write data into.
Write the content of the tag in the provided tag buffer. DO NOT attempt to write more bytes than you requested with Tag::GetSerializedSize.

Implemented in ns3::SocketAddressTag, ns3::SocketIpTtlTag, and ns3::SocketSetDontFragmentTag.


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

Generated on Fri Apr 9 15:01:08 2010 for NS-3 by  doxygen 1.5.8