A Discrete-Event Network Simulator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef PACKET_H
21 #define PACKET_H
23 #include <stdint.h>
24 #include "buffer.h"
25 #include "header.h"
26 #include "trailer.h"
27 #include "packet-metadata.h"
28 #include "tag.h"
29 #include "byte-tag-list.h"
30 #include "packet-tag-list.h"
31 #include "nix-vector.h"
32 #include "ns3/callback.h"
33 #include "ns3/assert.h"
34 #include "ns3/ptr.h"
35 #include "ns3/deprecated.h"
37 namespace ns3 {
51 {
52 public:
57  class Item
58  {
59 public:
63  TypeId GetTypeId (void) const;
69  uint32_t GetStart (void) const;
75  uint32_t GetEnd (void) const;
84  void GetTag (Tag &tag) const;
85 private:
86  friend class ByteTagIterator;
94  Item (TypeId tid, uint32_t start, uint32_t end, TagBuffer buffer);
97  uint32_t m_start;
98  uint32_t m_end;
100  };
104  bool HasNext (void) const;
108  Item Next (void);
109 private:
110  friend class Packet;
117 };
126 {
127 public:
131  class Item
132  {
133 public:
137  TypeId GetTypeId (void) const;
146  void GetTag (Tag &tag) const;
147 private:
148  friend class PacketTagIterator;
153  Item (const struct PacketTagList::TagData *data);
155  };
159  bool HasNext (void) const;
163  Item Next (void);
164 private:
165  friend class Packet;
170  PacketTagIterator (const struct PacketTagList::TagData *head);
172 };
223 class Packet : public SimpleRefCount<Packet>
224 {
225 public:
231  Packet ();
236  Packet (const Packet &o);
242  Packet &operator = (const Packet &o);
254  Packet (uint32_t size);
267  Packet (uint8_t const*buffer, uint32_t size, bool magic);
278  Packet (uint8_t const*buffer, uint32_t size);
289  Ptr<Packet> CreateFragment (uint32_t start, uint32_t length) const;
296  inline uint32_t GetSize (void) const;
307  void AddHeader (const Header & header);
316  uint32_t RemoveHeader (Header &header);
325  uint32_t PeekHeader (Header &header) const;
336  void AddTrailer (const Trailer &trailer);
345  uint32_t RemoveTrailer (Trailer &trailer);
354  uint32_t PeekTrailer (Trailer &trailer);
364  void AddAtEnd (Ptr<const Packet> packet);
370  void AddPaddingAtEnd (uint32_t size);
379  void RemoveAtEnd (uint32_t size);
388  void RemoveAtStart (uint32_t size);
403  uint8_t const *PeekData (void) const NS_DEPRECATED;
415  uint32_t CopyData (uint8_t *buffer, uint32_t size) const;
425  void CopyData (std::ostream *os, uint32_t size) const;
436  Ptr<Packet> Copy (void) const;
457  uint64_t GetUid (void) const;
469  void Print (std::ostream &os) const;
494  static void EnablePrinting (void);
505  static void EnableChecking (void);
518  uint32_t GetSerializedSize (void) const;
528  uint32_t Serialize (uint8_t* buffer, uint32_t maxSize) const;
546  void AddByteTag (const Tag &tag) const;
552  ByteTagIterator GetByteTagIterator (void) const;
562  bool FindFirstMatchingByteTag (Tag &tag) const;
567  void RemoveAllByteTags (void);
575  void PrintByteTags (std::ostream &os) const;
586  void AddPacketTag (const Tag &tag) const;
595  bool RemovePacketTag (Tag &tag);
606  bool ReplacePacketTag (Tag & tag);
614  bool PeekPacketTag (Tag &tag) const;
618  void RemoveAllPacketTags (void);
628  void PrintPacketTags (std::ostream &os) const;
651  void SetNixVector (Ptr<NixVector> nixVector);
659  Ptr<NixVector> GetNixVector (void) const;
661 private:
669  Packet (const Buffer &buffer, const ByteTagList &byteTagList,
670  const PacketTagList &packetTagList, const PacketMetadata &metadata);
672  uint32_t Deserialize (uint8_t const*buffer, uint32_t size);
679  /* Please see comments above about nix-vector */
682  static uint32_t m_globalUid;
683 };
692 std::ostream& operator<< (std::ostream& os, const Packet &packet);
735 } // namespace ns3
737 /****************************************************
738  * Implementation of inline methods for performance
739  ****************************************************/
741 namespace ns3 {
743 uint32_t
744 Packet::GetSize (void) const
745 {
746  return m_buffer.GetSize ();
747 }
749 } // namespace ns3
751 #endif /* PACKET_H */
bool HasNext(void) const
Definition: packet.cc:65
Protocol header serialization and deserialization.
Definition: header.h:42
PacketMetadata m_metadata
the packet's metadata
Definition: packet.h:677
uint32_t RemoveHeader(Header &header)
Deserialize and remove the header from the internal buffer.
Definition: packet.cc:268
bool FindFirstMatchingByteTag(Tag &tag) const
Finds the first tag matching the parameter Tag type.
Definition: packet.cc:824
void PrintPacketTags(std::ostream &os) const
Print the list of packet tags.
Definition: packet.cc:876
uint32_t Deserialize(uint8_t const *buffer, uint32_t size)
Definition: packet.cc:726
const struct PacketTagList::TagData * m_data
the tag data
Definition: packet.h:154
automatically resized byte buffer
Definition: buffer.h:92
void AddPacketTag(const Tag &tag) const
Add a packet tag.
Definition: packet.cc:841
List of the packet tags stored in a packet.
uint64_t GetUid(void) const
Returns the packet's Uid.
Definition: packet.cc:393
uint32_t Serialize(uint8_t *buffer, uint32_t maxSize) const
Serialize a packet, tags, and metadata into a byte buffer.
Definition: packet.cc:608
keep track of the byte tags stored in a packet.
Definition: byte-tag-list.h:68
static uint32_t m_globalUid
Global counter of packets Uid.
Definition: packet.h:682
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:744
Buffer m_buffer
the packet buffer (it's actual contents)
Definition: packet.h:674
Ptr< NixVector > GetNixVector(void) const
Get the packet nix-vector.
Definition: packet.cc:247
Item(TypeId tid, uint32_t start, uint32_t end, TagBuffer buffer)
Definition: packet.cc:57
void Print(std::ostream &os) const
Print the packet contents.
Definition: packet.cc:429
Packet & operator=(const Packet &o)
Basic assignment.
Definition: packet.cc:157
network packets
Definition: packet.h:223
Item Next(void)
Definition: packet.cc:94
PacketTagIterator GetPacketTagIterator(void) const
Returns an object which can be used to iterate over the list of packet tags.
Definition: packet.cc:899
ByteTagList::Iterator m_current
actual position over the set of byte tags in a packet
Definition: packet.h:116
Create an empty packet with a new uid (as returned by getUid).
Definition: packet.cc:130
void GetTag(Tag &tag) const
Read the requested tag and store it in the user-provided tag instance.
Definition: packet.cc:112
Ptr< Packet > CreateFragment(uint32_t start, uint32_t length) const
Create a new packet which contains a fragment of the original packet.
Definition: packet.cc:228
uint32_t PeekTrailer(Trailer &trailer)
Deserialize but does not remove a trailer from the internal buffer.
Definition: packet.cc:309
void AddAtEnd(Ptr< const Packet > packet)
Concatenate the input packet at the end of the current packet.
Definition: packet.cc:317
Tree node for sharing serialized tags.
uint8_t const * PeekData(void) const NS_DEPRECATED
Definition: packet.cc:368
bool PeekPacketTag(Tag &tag) const
Search a matching tag and call Tag::Deserialize if it is found.
Definition: packet.cc:863
void RemoveAllPacketTags(void)
Remove all packet tags.
Definition: packet.cc:869
Identifies a byte tag and a set of bytes within a packet to which the tag applies.
Definition: packet.h:57
bool HasNext(void) const
Definition: packet.cc:89
void RemoveAtStart(uint32_t size)
Remove size bytes from the start of the current packet.
Definition: packet.cc:353
Definition: deprecated.h:7
TagBuffer m_buffer
the buffer associated with this tag.
Definition: packet.h:99
static void EnablePrinting(void)
Enable printing packets metadata.
Definition: packet.cc:552
TypeId m_tid
the ns3::TypeId associated to this tag.
Definition: packet.h:96
void SetNixVector(Ptr< NixVector > nixVector)
Set the packet nix-vector.
Definition: packet.cc:241
ByteTagList m_byteTagList
the ByteTag list
Definition: packet.h:675
Defines a linked list of Packet tags, including copy-on-write semantics.
uint8_t data[writeSize]
Iterator class for metadata items.
bool ReplacePacketTag(Tag &tag)
Replace the value of a packet tag.
Definition: packet.cc:855
static void EnableChecking(void)
Enable packets metadata checking.
Definition: packet.cc:559
void AddPaddingAtEnd(uint32_t size)
Add a zero-filled padding to the packet.
Definition: packet.cc:333
ByteTagIterator GetByteTagIterator(void) const
Retiurns an iterator over the set of byte tags included in this packet.
Definition: packet.cc:818
Item Next(void)
Definition: packet.cc:70
uint32_t GetEnd(void) const
The index is an offset from the start of the packet.
Definition: packet.cc:44
Iterator over the set of packet tags in a packet.
Definition: packet.h:125
void PrintByteTags(std::ostream &os) const
Iterate over the byte tags present in this packet, and invoke the Print method of each tag stored in ...
Definition: packet.cc:399
const struct PacketTagList::TagData * m_current
actual position over the set of tags in a packet
Definition: packet.h:171
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:43
Ptr< Packet > Copy(void) const
performs a COW copy of the packet.
Definition: packet.cc:122
uint32_t PeekHeader(Header &header) const
Deserialize but does not remove the header from the internal buffer.
Definition: packet.cc:277
uint32_t m_end
the index of the last byte tagged by this tag.
Definition: packet.h:98
Protocol trailer serialization and deserialization.
Definition: trailer.h:40
tag a set of bytes in a packet
Definition: tag.h:36
PacketMetadata::ItemIterator BeginItem(void) const
Returns an iterator which points to the first 'item' stored in this buffer.
Definition: packet.cc:546
PacketTagIterator(const struct PacketTagList::TagData *head)
Definition: packet.cc:84
void AddTrailer(const Trailer &trailer)
Add trailer to this packet.
Definition: packet.cc:284
void RemoveAtEnd(uint32_t size)
Remove size bytes from the end of the current packet.
Definition: packet.cc:346
Iterator over the set of byte tags in a packet.
Definition: packet.h:50
uint32_t RemoveTrailer(Trailer &trailer)
Remove a deserialized trailer from the internal buffer.
Definition: packet.cc:300
PacketTagList m_packetTagList
the packet's Tag list
Definition: packet.h:676
TypeId GetTypeId(void) const
Definition: packet.cc:34
Identifies a packet tag within a packet.
Definition: packet.h:131
uint32_t GetSize(void) const
Definition: buffer.h:1070
TypeId GetTypeId(void) const
Definition: packet.cc:107
Item(const struct PacketTagList::TagData *data)
Definition: packet.cc:102
void GetTag(Tag &tag) const
Read the requested tag and store it in the user-provided tag instance.
Definition: packet.cc:49
An iterator for iterating through a byte tag list.
Definition: byte-tag-list.h:77
read and write tag data
Definition: tag-buffer.h:51
uint32_t GetStart(void) const
The index is an offset from the start of the packet.
Definition: packet.cc:39
uint32_t GetSerializedSize(void) const
Returns number of bytes required for packet serialization.
Definition: packet.cc:565
bool RemovePacketTag(Tag &tag)
Remove a packet tag.
Definition: packet.cc:848
void RemoveAllByteTags(void)
Remove all byte tags stored in this packet.
Definition: packet.cc:361
Ptr< NixVector > m_nixVector
the packet's Nix vector
Definition: packet.h:680
uint32_t CopyData(uint8_t *buffer, uint32_t size) const
Copy the packet contents to a byte buffer.
Definition: packet.cc:381
uint32_t m_start
the index of the first byte tagged by this tag.
Definition: packet.h:97
ByteTagIterator(ByteTagList::Iterator i)
Copy Constructor.
Definition: packet.cc:78
A template-based reference counting class.
a unique identifier for an interface.
Definition: type-id.h:49
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:253
Handle packet metadata about packet headers and trailers.
void AddByteTag(const Tag &tag) const
Tag each byte included in this packet with a new byte tag.
Definition: packet.cc:808