samples/main-packet-header.cc
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 23 Mar 2009 09:56:27 +0100
changeset 4359 8d689bf4405f
parent 2646 c1fef7686472
permissions -rw-r--r--
remove dead files
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; -*- */
2189
036cf935e7cf packet pointer police patrolled product preventing presence of prior pattern proactively
Craig Dowell <craigdo@ee.washington.edu>
parents: 1245
diff changeset
     2
#include "ns3/ptr.h"
14
6dd7d31c6fc3 replace yans include with ns3 include
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 12
diff changeset
     3
#include "ns3/packet.h"
104
3006f1b350ae add header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 102
diff changeset
     4
#include "ns3/header.h"
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     5
#include <iostream>
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     6
16
99e833adbb46 change yans namespace to ns3
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 14
diff changeset
     7
using namespace ns3;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     8
126
2bd1d886a97d remove reference to Chunk class
Tom Henderson <tomh@tomh.org>
parents: 122
diff changeset
     9
/* A sample Header implementation
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    10
 */
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
    11
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
    12
{
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    13
public:
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
2643
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    21
  static TypeId GetTypeId (void);
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    22
  virtual TypeId GetInstanceTypeId (void) const;
2646
c1fef7686472 remove dead code.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2643
diff changeset
    23
  virtual void Print (std::ostream &os) const;
2643
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    24
  virtual void Serialize (Buffer::Iterator start) const;
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    25
  virtual uint32_t Deserialize (Buffer::Iterator start);
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    26
  virtual uint32_t GetSerializedSize (void) const;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    27
private:
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    28
  uint16_t m_data;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    29
};
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    30
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    31
MyHeader::MyHeader ()
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    32
{
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    33
  // 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
    34
  // 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
    35
}
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    36
MyHeader::~MyHeader ()
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    37
{}
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    38
2643
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    39
TypeId 
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    40
MyHeader::GetTypeId (void)
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    41
{
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    42
  static TypeId tid = TypeId ("ns3::MyHeader")
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    43
    .SetParent<Header> ()
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    44
    ;
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    45
  return tid;
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    46
}
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    47
TypeId 
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    48
MyHeader::GetInstanceTypeId (void) const
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    49
{
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    50
  return GetTypeId ();
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    51
}
2a3324f4dabe define a TypeId for each Header/Trailer.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2189
diff changeset
    52
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    53
void 
1232
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    54
MyHeader::Print (std::ostream &os) const
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    55
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    56
  // 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
    57
  // 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
    58
  os << "data=" << m_data << std::endl;
104
3006f1b350ae add header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 102
diff changeset
    59
}
3006f1b350ae add header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 102
diff changeset
    60
uint32_t
122
6b8f1eda5c57 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 111
diff changeset
    61
MyHeader::GetSerializedSize (void) const
104
3006f1b350ae add header
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 102
diff changeset
    62
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    63
  // we reserve 2 bytes for our header.
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    64
  return 2;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    65
}
463
c2082308e01a merge Packet API changes needed for Packet pretty printing.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 150
diff changeset
    66
void
1232
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    67
MyHeader::Serialize (Buffer::Iterator start) const
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    68
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    69
  // 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
    70
  // we write them in network byte order.
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    71
  start.WriteHtonU16 (m_data);
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    72
}
463
c2082308e01a merge Packet API changes needed for Packet pretty printing.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 150
diff changeset
    73
uint32_t
1232
2e8c3f8bb77f remove Chunk base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1151
diff changeset
    74
MyHeader::Deserialize (Buffer::Iterator start)
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    75
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    76
  // 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
    77
  // 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
    78
  // in host byte order.
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    79
  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
    80
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
    81
  // 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
    82
  return 2;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    83
}
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    84
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    85
void 
122
6b8f1eda5c57 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 111
diff changeset
    86
MyHeader::SetData (uint16_t data)
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    87
{
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    88
  m_data = data;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    89
}
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    90
uint16_t 
122
6b8f1eda5c57 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 111
diff changeset
    91
MyHeader::GetData (void) const
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    92
{
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
    93
  return m_data;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    94
}
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    95
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    96
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
int main (int argc, char *argv[])
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    99
{
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   100
  // instantiate a header.
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   101
  MyHeader sourceHeader;
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   102
  sourceHeader.SetData (2);
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   103
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   104
  // instantiate a packet
2189
036cf935e7cf packet pointer police patrolled product preventing presence of prior pattern proactively
Craig Dowell <craigdo@ee.washington.edu>
parents: 1245
diff changeset
   105
  Ptr<Packet> p = Create<Packet> ();
036cf935e7cf packet pointer police patrolled product preventing presence of prior pattern proactively
Craig Dowell <craigdo@ee.washington.edu>
parents: 1245
diff changeset
   106
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   107
  // and store my header into the packet.
2189
036cf935e7cf packet pointer police patrolled product preventing presence of prior pattern proactively
Craig Dowell <craigdo@ee.washington.edu>
parents: 1245
diff changeset
   108
  p->AddHeader (sourceHeader);
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   109
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   110
  // print the content of my packet on the standard output.
2189
036cf935e7cf packet pointer police patrolled product preventing presence of prior pattern proactively
Craig Dowell <craigdo@ee.washington.edu>
parents: 1245
diff changeset
   111
  p->Print (std::cout);
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   112
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   113
  // 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
   114
  MyHeader destinationHeader;
2189
036cf935e7cf packet pointer police patrolled product preventing presence of prior pattern proactively
Craig Dowell <craigdo@ee.washington.edu>
parents: 1245
diff changeset
   115
  p->RemoveHeader (destinationHeader);
1132
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   116
de8ccffc8485 doxygen improvements to Packet, Tags, and Headers/Trailers
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1128
diff changeset
   117
  // 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
   118
  // 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
   119
  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
   120
150
663120712cd9 fix coding style
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 131
diff changeset
   121
  return 0;
12
917ba023c576 utils and samples
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   122
}