A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
ipv6-packet-info-tag.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2010 Hajime Tazaki
3
*
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License version 2 as
6
* published by the Free Software Foundation;
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU General Public License for more details.
12
*
13
* You should have received a copy of the GNU General Public License
14
* along with this program; if not, write to the Free Software
15
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
*
17
* Authors: Hajime Tazaki <tazaki@sfc.wide.ad.jp>
18
*/
19
20
#ifndef IPV6_PACKET_INFO_TAG_H
21
#define IPV6_PACKET_INFO_TAG_H
22
23
#include "ns3/ipv6-address.h"
24
#include "ns3/tag.h"
25
26
namespace
ns3
27
{
28
29
class
Node;
30
class
Packet;
31
32
/**
33
* \ingroup ipv6
34
*
35
* \brief This class implements a tag that carries socket ancillary
36
* data to the socket interface. This is used like
37
* socket option of IP_PKTINFO/IPV6_PKTINFO in \RFC{3542}
38
*
39
* See also SocketIpv6TclassTag and SocketIpv6HopLimitTag
40
*
41
* This tag in the send direction is presently not enabled but we
42
* would accept a patch along those lines in the future. To include
43
* the nexthop in the send direction would increase the size of the
44
* tag beyond 20 bytes, so in that case, we recommend that an
45
* additional tag be used to carry the IPv6 next hop address.
46
*/
47
class
Ipv6PacketInfoTag
:
public
Tag
48
{
49
public
:
50
Ipv6PacketInfoTag
();
51
52
/**
53
* \brief Get the type ID.
54
* \return the object TypeId
55
*/
56
static
TypeId
GetTypeId
();
57
58
/**
59
* \brief Set the tag's address
60
*
61
* \param addr the address
62
*/
63
void
SetAddress
(
Ipv6Address
addr);
64
65
/**
66
* \brief Get the tag's address
67
*
68
* \returns the address
69
*/
70
Ipv6Address
GetAddress
()
const
;
71
72
/**
73
* \brief Set the tag's receiving interface
74
*
75
* \param ifindex the interface index
76
*/
77
void
SetRecvIf
(
uint32_t
ifindex);
78
79
/**
80
* \brief Get the tag's receiving interface
81
*
82
* \returns the interface index
83
*/
84
uint32_t
GetRecvIf
()
const
;
85
86
/**
87
* \brief Set the tag's Hop Limit
88
*
89
* \param ttl the hop limit
90
*/
91
void
SetHoplimit
(uint8_t ttl);
92
93
/**
94
* \brief Get the tag's Hop Limit
95
*
96
* \returns the Hop Limit
97
*/
98
uint8_t
GetHoplimit
()
const
;
99
100
/**
101
* \brief Set the tag's Traffic Class
102
*
103
* \param tclass the Traffic Class
104
*/
105
void
SetTrafficClass
(uint8_t tclass);
106
107
/**
108
* \brief Get the tag's Traffic Class
109
*
110
* \returns the Traffic Class
111
*/
112
uint8_t
GetTrafficClass
()
const
;
113
114
// inherited functions, no doc necessary
115
TypeId
GetInstanceTypeId
()
const override
;
116
uint32_t
GetSerializedSize
()
const override
;
117
void
Serialize
(
TagBuffer
i)
const override
;
118
void
Deserialize
(
TagBuffer
i)
override
;
119
void
Print
(std::ostream& os)
const override
;
120
121
private
:
122
/*
123
* RFC 3542 includes
124
* for outgoing packet,
125
* 1. the source IPv6 address,
126
* 2. the outgoing interface index,
127
* 3. the outgoing hop limit,
128
* 4. the next hop address, and
129
* 5. the outgoing traffic class value.
130
*
131
* for incoming packet,
132
* 1. the destination IPv6 address,
133
* 2. the arriving interface index,
134
* 3. the arriving hop limit, and
135
* 4. the arriving traffic class value.
136
*/
137
Ipv6Address
m_addr
;
//!< the packet address (src or dst)
138
uint8_t
m_ifindex
;
//!< the Interface index
139
uint8_t
m_hoplimit
;
//!< the Hop Limit
140
uint8_t
m_tclass
;
//!< the Traffic Class
141
};
142
}
// namespace ns3
143
144
#endif
/* IPV6_PACKET_INFO_TAG_H */
ns3::Ipv6Address
Describes an IPv6 address.
Definition:
ipv6-address.h:49
ns3::Ipv6PacketInfoTag
This class implements a tag that carries socket ancillary data to the socket interface.
Definition:
ipv6-packet-info-tag.h:48
ns3::Ipv6PacketInfoTag::Deserialize
void Deserialize(TagBuffer i) override
Definition:
ipv6-packet-info-tag.cc:119
ns3::Ipv6PacketInfoTag::Ipv6PacketInfoTag
Ipv6PacketInfoTag()
Definition:
ipv6-packet-info-tag.cc:29
ns3::Ipv6PacketInfoTag::SetTrafficClass
void SetTrafficClass(uint8_t tclass)
Set the tag's Traffic Class.
Definition:
ipv6-packet-info-tag.cc:74
ns3::Ipv6PacketInfoTag::GetInstanceTypeId
TypeId GetInstanceTypeId() const override
Get the most derived TypeId for this Object.
Definition:
ipv6-packet-info-tag.cc:96
ns3::Ipv6PacketInfoTag::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
ipv6-packet-info-tag.cc:86
ns3::Ipv6PacketInfoTag::Print
void Print(std::ostream &os) const override
Definition:
ipv6-packet-info-tag.cc:130
ns3::Ipv6PacketInfoTag::m_addr
Ipv6Address m_addr
the packet address (src or dst)
Definition:
ipv6-packet-info-tag.h:137
ns3::Ipv6PacketInfoTag::Serialize
void Serialize(TagBuffer i) const override
Definition:
ipv6-packet-info-tag.cc:108
ns3::Ipv6PacketInfoTag::m_tclass
uint8_t m_tclass
the Traffic Class
Definition:
ipv6-packet-info-tag.h:140
ns3::Ipv6PacketInfoTag::m_ifindex
uint8_t m_ifindex
the Interface index
Definition:
ipv6-packet-info-tag.h:138
ns3::Ipv6PacketInfoTag::GetAddress
Ipv6Address GetAddress() const
Get the tag's address.
Definition:
ipv6-packet-info-tag.cc:44
ns3::Ipv6PacketInfoTag::SetRecvIf
void SetRecvIf(uint32_t ifindex)
Set the tag's receiving interface.
Definition:
ipv6-packet-info-tag.cc:50
ns3::Ipv6PacketInfoTag::SetHoplimit
void SetHoplimit(uint8_t ttl)
Set the tag's Hop Limit.
Definition:
ipv6-packet-info-tag.cc:62
ns3::Ipv6PacketInfoTag::GetHoplimit
uint8_t GetHoplimit() const
Get the tag's Hop Limit.
Definition:
ipv6-packet-info-tag.cc:68
ns3::Ipv6PacketInfoTag::GetTrafficClass
uint8_t GetTrafficClass() const
Get the tag's Traffic Class.
Definition:
ipv6-packet-info-tag.cc:80
ns3::Ipv6PacketInfoTag::m_hoplimit
uint8_t m_hoplimit
the Hop Limit
Definition:
ipv6-packet-info-tag.h:139
ns3::Ipv6PacketInfoTag::GetSerializedSize
uint32_t GetSerializedSize() const override
Definition:
ipv6-packet-info-tag.cc:102
ns3::Ipv6PacketInfoTag::GetRecvIf
uint32_t GetRecvIf() const
Get the tag's receiving interface.
Definition:
ipv6-packet-info-tag.cc:56
ns3::Ipv6PacketInfoTag::SetAddress
void SetAddress(Ipv6Address addr)
Set the tag's address.
Definition:
ipv6-packet-info-tag.cc:38
ns3::TagBuffer
read and write tag data
Definition:
tag-buffer.h:52
ns3::Tag
tag a set of bytes in a packet
Definition:
tag.h:39
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
uint32_t
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
internet
model
ipv6-packet-info-tag.h
Generated on Mon Aug 12 2024 11:16:14 for ns-3 by
1.9.6