ns3::Header Class Reference
[Packet]

Protocol header serialization and deserialization. More...

#include <header.h>

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

List of all members.

Public Member Functions

virtual ~Header ()
virtual uint32_t GetSerializedSize (void) const =0
virtual void Serialize (Buffer::Iterator start) const =0
virtual uint32_t Deserialize (Buffer::Iterator start)=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::Header.

Detailed Description

Protocol header serialization and deserialization.

Every Protocol header which needs to be inserted or removed from a Packet instance must derive from this base class and implement the pure virtual methods defined here.

Sample code which shows how to create a new type of Header, and how to use it, is shown in the sample file samples/main-packet-header.cc

Definition at line 42 of file header.h.


Constructor & Destructor Documentation

ns3::Header::~Header (  )  [virtual]

Definition at line 6 of file header.cc.


Member Function Documentation

virtual uint32_t ns3::Header::Deserialize ( Buffer::Iterator  start  )  [pure virtual]
Parameters:
start an iterator which points to where the header should written.
Returns:
the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Implements ns3::Chunk.

Implemented in anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >, anonymous_namespace{packet.cc}::ATestHeader< N >, ns3::PppHeader, ns3::MgtAssocRequestHeader, ns3::MgtAssocResponseHeader, ns3::MgtProbeRequestHeader, ns3::MgtProbeResponseHeader, ns3::WifiMacHeader, ns3::ArpHeader, ns3::Icmpv4Header, ns3::Icmpv4Echo, ns3::Icmpv4DestinationUnreachable, ns3::Icmpv4TimeExceeded, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, ns3::Ipv6Header, ns3::LlcSnapHeader, ns3::olsr::PacketHeader, and ns3::olsr::MessageHeader.

Referenced by ns3::Packet::PeekHeader(), and ns3::Packet::RemoveHeader().

virtual uint32_t ns3::Header::GetSerializedSize ( void   )  const [pure virtual]
TypeId ns3::Header::GetTypeId ( void   )  [static]
virtual void ns3::Header::Print ( std::ostream &  os  )  const [pure virtual]

This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Chunk.

Implemented in anonymous_namespace{packet-metadata-test.cc}::HistoryHeader< N >, anonymous_namespace{packet.cc}::ATestHeader< N >, ns3::PppHeader, ns3::MgtAssocRequestHeader, ns3::MgtAssocResponseHeader, ns3::MgtProbeRequestHeader, ns3::MgtProbeResponseHeader, ns3::WifiMacHeader, ns3::ArpHeader, ns3::Icmpv4Header, ns3::Icmpv4Echo, ns3::Icmpv4DestinationUnreachable, ns3::Icmpv4TimeExceeded, ns3::TcpHeader, ns3::UdpHeader, ns3::EthernetHeader, ns3::Ipv4Header, ns3::Ipv6Header, ns3::LlcSnapHeader, ns3::olsr::PacketHeader, and ns3::olsr::MessageHeader.

virtual void ns3::Header::Serialize ( Buffer::Iterator  start  )  const [pure virtual]

The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:09:58 2009 for NS-3 by  doxygen 1.6.3