A Discrete-Event Network Simulator
API
ipv4-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 IPV4_PACKET_INFO_TAG_H
22 #define IPV4_PACKET_INFO_TAG_H
23 
24 #include "ns3/tag.h"
25 #include "ns3/ipv4-address.h"
26 
27 namespace ns3 {
28 
29 
30 class Node;
31 class Packet;
32 
44 class Ipv4PacketInfoTag : public Tag
45 {
46 public:
48 
54  void SetAddress (Ipv4Address addr);
55 
61  Ipv4Address GetAddress (void) const;
69  void SetLocalAddress (Ipv4Address addr);
77  Ipv4Address GetLocalAddress (void) const;
78 
84  void SetRecvIf (uint32_t ifindex);
90  uint32_t GetRecvIf (void) const;
91 
97  void SetTtl (uint8_t ttl);
103  uint8_t GetTtl (void) const;
104 
109  static TypeId GetTypeId (void);
110  virtual TypeId GetInstanceTypeId (void) const;
111  virtual uint32_t GetSerializedSize (void) const;
112  virtual void Serialize (TagBuffer i) const;
113  virtual void Deserialize (TagBuffer i);
114  virtual void Print (std::ostream &os) const;
115 
116 private:
117  // Linux IP_PKTINFO ip(7) implementation
118  //
119  // struct in_pktinfo {
120  // unsigned int ipi_ifindex; /* Interface index */
121  // struct in_addr ipi_spec_dst; /* Local address */
122  // struct in_addr ipi_addr; /* Header Destination
123  // address */
124  // };
125 
128  uint32_t m_ifindex;
129 
130  // Used for IP_RECVTTL, though not implemented yet.
131  uint8_t m_ttl;
132 };
133 } // namespace ns3
134 
135 #endif /* IPV4_PACKET_INFO_TAG_H */
uint32_t GetRecvIf(void) const
Get the tag&#39;s receiving interface.
Ipv4Address m_addr
Header destination address.
uint32_t m_ifindex
interface index
virtual void Serialize(TagBuffer i) const
void SetTtl(uint8_t ttl)
Set the tag&#39;s Time to Live Implemented, but not used in the stack yet.
Ipv4Address GetAddress(void) const
Get the tag&#39;s address.
Ipv4Address m_spec_dst
Local address.
virtual void Print(std::ostream &os) const
uint8_t GetTtl(void) const
Get the tag&#39;s Time to Live Implemented, but not used in the stack yet.
tag a set of bytes in a packet
Definition: tag.h:36
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
static TypeId GetTypeId(void)
Get the type ID.
uint8_t m_ttl
Time to Live.
This class implements Linux struct pktinfo in order to deliver ancillary information to the socket in...
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
read and write tag data
Definition: tag-buffer.h:51
virtual void Deserialize(TagBuffer i)
virtual uint32_t GetSerializedSize(void) const
void SetLocalAddress(Ipv4Address addr)
Set the tag&#39;s local address.
void SetAddress(Ipv4Address addr)
Set the tag&#39;s address.
Ipv4Address GetLocalAddress(void) const
Get the tag&#39;s local address.
a unique identifier for an interface.
Definition: type-id.h:58
void SetRecvIf(uint32_t ifindex)
Set the tag&#39;s receiving interface.