samples/main-packet-header.cc
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Wed, 29 Aug 2007 16:42:55 +0200
changeset 1396 105d16b9bf04
parent 1245 7b50f733a6b1
child 2189 036cf935e7cf
permissions -rw-r--r--
add iterator to go through available list
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
14
6dd7d31c6fc3 replace yans include with ns3 include
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 12
diff changeset
     2
#include "ns3/packet.h"
104
3006f1b350ae add header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 102
diff changeset
     3
#include "ns3/header.h"
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     4
#include <iostream>
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     5
16
99e833adbb46 change yans namespace to ns3
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 14
diff changeset
     6
using namespace ns3;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     7
126
2bd1d886a97d remove reference to Chunk class
Tom Henderson <tomh@tomh.org>
parents: 122
diff changeset
     8
/* A sample Header implementation
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     9
 */
1127
df45b772d989 make sure we return the right integer uid if the header of trailer was already registered.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 795
diff changeset
    10
class MyHeader : public Header 
df45b772d989 make sure we return the right integer uid if the header of trailer was already registered.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 795
diff changeset
    11
{
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    12
public:
1151
527d7b7e25af force users to register their header/trailer uid strings by hand rather than do lazy uid allocation.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1135
diff changeset
    13
  static uint32_t GetUid (void);
1127
df45b772d989 make sure we return the right integer uid if the header of trailer was already registered.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 795
diff changeset
    14
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    15
  MyHeader ();
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    16
  virtual ~MyHeader ();
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    17
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    18
  void SetData (uint16_t data);
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    19
  uint16_t GetData (void) const;
1232
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    20
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    21
  std::string GetName (void) const;
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    22
  void Print (std::ostream &os) const;
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    23
  void Serialize (Buffer::Iterator start) const;
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    24
  uint32_t Deserialize (Buffer::Iterator start);
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    25
  uint32_t GetSerializedSize (void) const;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    26
private:
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    27
  uint16_t m_data;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    28
};
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    29
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    30
MyHeader::MyHeader ()
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    31
{
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    32
  // we must provide a public default constructor, 
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    33
  // implicit or explicit, but never private.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    34
}
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    35
MyHeader::~MyHeader ()
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    36
{}
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    37
1151
527d7b7e25af force users to register their header/trailer uid strings by hand rather than do lazy uid allocation.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1135
diff changeset
    38
uint32_t
1127
df45b772d989 make sure we return the right integer uid if the header of trailer was already registered.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 795
diff changeset
    39
MyHeader::GetUid (void)
df45b772d989 make sure we return the right integer uid if the header of trailer was already registered.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 795
diff changeset
    40
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    41
  // This string is used by the internals of the packet
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    42
  // code to keep track of the packet metadata.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    43
  // You need to make sure that this string is absolutely
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    44
  // unique. The code will detect any duplicate string.
1234
ca195a6a7e1e Trailer::Register -> Trailer::AllocateUid and Header::Register -> Header::AllocateUid
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1232
diff changeset
    45
  static uint32_t uid = AllocateUid<MyHeader> ("MyHeader.test.nsnam.org");
1151
527d7b7e25af force users to register their header/trailer uid strings by hand rather than do lazy uid allocation.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1135
diff changeset
    46
  return uid;
1127
df45b772d989 make sure we return the right integer uid if the header of trailer was already registered.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 795
diff changeset
    47
}
df45b772d989 make sure we return the right integer uid if the header of trailer was already registered.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 795
diff changeset
    48
795
cd108c9817d0 add Chunk::GetName and implement it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 463
diff changeset
    49
std::string 
1232
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    50
MyHeader::GetName (void) const
795
cd108c9817d0 add Chunk::GetName and implement it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 463
diff changeset
    51
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    52
  // This string is used to identify the type of 
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    53
  // my header by the packet printing routines.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    54
  return "MYHEADER";
795
cd108c9817d0 add Chunk::GetName and implement it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 463
diff changeset
    55
}
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    56
void 
1232
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    57
MyHeader::Print (std::ostream &os) const
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    58
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    59
  // This method is invoked by the packet printing
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    60
  // routines to print the content of my header.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    61
  os << "data=" << m_data << std::endl;
104
3006f1b350ae add header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 102
diff changeset
    62
}
3006f1b350ae add header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 102
diff changeset
    63
uint32_t
122
6b8f1eda5c57 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 111
diff changeset
    64
MyHeader::GetSerializedSize (void) const
104
3006f1b350ae add header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 102
diff changeset
    65
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    66
  // we reserve 2 bytes for our header.
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    67
  return 2;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    68
}
463
c2082308e01a merge Packet API changes needed for Packet pretty printing.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 150
diff changeset
    69
void
1232
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    70
MyHeader::Serialize (Buffer::Iterator start) const
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    71
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    72
  // we can serialize two bytes at the start of the buffer.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    73
  // we write them in network byte order.
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    74
  start.WriteHtonU16 (m_data);
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    75
}
463
c2082308e01a merge Packet API changes needed for Packet pretty printing.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 150
diff changeset
    76
uint32_t
1232
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    77
MyHeader::Deserialize (Buffer::Iterator start)
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    78
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    79
  // we can deserialize two bytes from the start of the buffer.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    80
  // we read them in network byte order and store them
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    81
  // in host byte order.
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    82
  m_data = start.ReadNtohU16 ();
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    83
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    84
  // we return the number of bytes effectively read.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    85
  return 2;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    86
}
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    87
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    88
void 
122
6b8f1eda5c57 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 111
diff changeset
    89
MyHeader::SetData (uint16_t data)
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    90
{
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    91
  m_data = data;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    92
}
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    93
uint16_t 
122
6b8f1eda5c57 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 111
diff changeset
    94
MyHeader::GetData (void) const
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    95
{
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    96
  return m_data;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    97
}
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    98
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    99
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   100
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   101
int main (int argc, char *argv[])
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   102
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   103
  // instantiate a header.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   104
  MyHeader sourceHeader;
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   105
  sourceHeader.SetData (2);
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   106
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   107
  // instantiate a packet
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
   108
  Packet p;
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   109
  // and store my header into the packet.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   110
  p.AddHeader (sourceHeader);
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   111
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   112
  // print the content of my packet on the standard output.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   113
  p.Print (std::cout);
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   114
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   115
  // you can now remove the header from the packet:
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   116
  MyHeader destinationHeader;
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   117
  p.RemoveHeader (destinationHeader);
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   118
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   119
  // and check that the destination and source
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   120
  // headers contain the same values.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   121
  NS_ASSERT (sourceHeader.GetData () == destinationHeader.GetData ());
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   122
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
   123
  return 0;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   124
}