A Discrete-Event Network Simulator
API
ipv6-packet-info-tag.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 Hajime Tazaki
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
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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  * Authors: Hajime Tazaki <tazaki@sfc.wide.ad.jp>
19  */
20 
21 #ifndef IPV6_PACKET_INFO_TAG_H
22 #define IPV6_PACKET_INFO_TAG_H
23 
24 #include "ns3/tag.h"
25 #include "ns3/ipv6-address.h"
26 
27 namespace ns3 {
28 
29 
30 class Node;
31 class Packet;
32 
48 class Ipv6PacketInfoTag : public Tag
49 {
50 public:
52 
57  static TypeId GetTypeId (void);
58 
64  void SetAddress (Ipv6Address addr);
65 
71  Ipv6Address GetAddress (void) const;
72 
78  void SetRecvIf (uint32_t ifindex);
79 
85  uint32_t GetRecvIf (void) const;
86 
92  void SetHoplimit (uint8_t ttl);
93 
99  uint8_t GetHoplimit (void) const;
100 
106  void SetTrafficClass (uint8_t tclass);
107 
113  uint8_t GetTrafficClass (void) const;
114 
115  // inherited functions, no doc necessary
116  virtual TypeId GetInstanceTypeId (void) const;
117  virtual uint32_t GetSerializedSize (void) const;
118  virtual void Serialize (TagBuffer i) const;
119  virtual void Deserialize (TagBuffer i);
120  virtual void Print (std::ostream &os) const;
121 
122 private:
123  /*
124  * RFC 3542 includes
125  * for outgoing packet,
126  * 1. the source IPv6 address,
127  * 2. the outgoing interface index,
128  * 3. the outgoing hop limit,
129  * 4. the next hop address, and
130  * 5. the outgoing traffic class value.
131  *
132  * for incoming packet,
133  * 1. the destination IPv6 address,
134  * 2. the arriving interface index,
135  * 3. the arriving hop limit, and
136  * 4. the arriving traffic class value.
137  */
139  uint8_t m_ifindex;
140  uint8_t m_hoplimit;
141  uint8_t m_tclass;
142 };
143 } // namespace ns3
144 
145 #endif /* IPV6_PACKET_INFO_TAG_H */
146 
Describes an IPv6 address.
Definition: ipv6-address.h:50
This class implements a tag that carries socket ancillary data to the socket interface.
void SetTrafficClass(uint8_t tclass)
Set the tag's Traffic Class.
uint8_t GetHoplimit(void) const
Get the tag's Hop Limit.
Ipv6Address m_addr
the packet address (src or dst)
virtual void Serialize(TagBuffer i) const
Ipv6Address GetAddress(void) const
Get the tag's address.
uint8_t m_tclass
the Traffic Class
uint8_t m_ifindex
the Interface index
virtual void Print(std::ostream &os) const
void SetRecvIf(uint32_t ifindex)
Set the tag's receiving interface.
static TypeId GetTypeId(void)
Get the type ID.
uint8_t GetTrafficClass(void) const
Get the tag's Traffic Class.
void SetHoplimit(uint8_t ttl)
Set the tag's Hop Limit.
uint8_t m_hoplimit
the Hop Limit
uint32_t GetRecvIf(void) const
Get the tag's receiving interface.
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
virtual uint32_t GetSerializedSize(void) const
virtual void Deserialize(TagBuffer i)
void SetAddress(Ipv6Address addr)
Set the tag's address.
read and write tag data
Definition: tag-buffer.h:52
tag a set of bytes in a packet
Definition: tag.h:37
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.