A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 
42 class Ipv4PacketInfoTag : public Tag
43 {
44 public:
46 
52  void SetAddress (Ipv4Address addr);
53 
59  Ipv4Address GetAddress (void) const;
67  void SetLocalAddress (Ipv4Address addr);
75  Ipv4Address GetLocalAddress (void) const;
76 
82  void SetRecvIf (uint32_t ifindex);
88  uint32_t GetRecvIf (void) const;
89 
95  void SetTtl (uint8_t ttl);
101  uint8_t GetTtl (void) const;
102 
107  static TypeId GetTypeId (void);
108  virtual TypeId GetInstanceTypeId (void) const;
109  virtual uint32_t GetSerializedSize (void) const;
110  virtual void Serialize (TagBuffer i) const;
111  virtual void Deserialize (TagBuffer i);
112  virtual void Print (std::ostream &os) const;
113 
114 private:
115  // Linux IP_PKTINFO ip(7) implementation
116  //
117  // struct in_pktinfo {
118  // unsigned int ipi_ifindex; /* Interface index */
119  // struct in_addr ipi_spec_dst; /* Local address */
120  // struct in_addr ipi_addr; /* Header Destination
121  // address */
122  // };
123 
126  uint32_t m_ifindex;
127 
128  // Used for IP_RECVTTL, though not implemented yet.
129  uint8_t m_ttl;
130 };
131 } // namespace ns3
132 
133 #endif /* IPV4_PACKET_INFO_TAG_H */
virtual uint32_t GetSerializedSize(void) const
Ipv4Address m_addr
Header destination address.
virtual TypeId GetInstanceTypeId(void) const
uint32_t m_ifindex
interface index
void SetTtl(uint8_t ttl)
Set the tag's Time to Live Implemented, but not used in the stack yet.
Ipv4Address m_spec_dst
Local address.
uint32_t GetRecvIf(void) const
Get the tag's receiving interface.
virtual void Serialize(TagBuffer i) const
uint8_t GetTtl(void) const
Get the tag's Time to Live Implemented, but not used in the stack yet.
tag a set of bytes in a packet
Definition: tag.h:36
Ipv4Address GetLocalAddress(void) const
Get the tag's local address.
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:38
read and write tag data
Definition: tag-buffer.h:51
virtual void Deserialize(TagBuffer i)
Ipv4Address GetAddress(void) const
Get the tag's address.
void SetLocalAddress(Ipv4Address addr)
Set the tag's local address.
virtual void Print(std::ostream &os) const
void SetAddress(Ipv4Address addr)
Set the tag's address.
a unique identifier for an interface.
Definition: type-id.h:49
void SetRecvIf(uint32_t ifindex)
Set the tag's receiving interface.