A Discrete-Event Network Simulator
API
ripng-header.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 Universita' di Firenze, Italy
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  * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
18  */
19 
20 #ifndef RIPNG_HEADER_H
21 #define RIPNG_HEADER_H
22 
23 #include "ns3/header.h"
24 #include "ns3/ipv6-address.h"
25 #include "ns3/ipv6-header.h"
26 #include "ns3/packet.h"
27 
28 #include <list>
29 
30 namespace ns3
31 {
32 
38 class RipNgRte : public Header
39 {
40  public:
41  RipNgRte();
42 
47  static TypeId GetTypeId();
48 
53  TypeId GetInstanceTypeId() const override;
54 
55  void Print(std::ostream& os) const override;
56 
61  uint32_t GetSerializedSize() const override;
62 
67  void Serialize(Buffer::Iterator start) const override;
68 
74  uint32_t Deserialize(Buffer::Iterator start) override;
75 
80  void SetPrefix(Ipv6Address prefix);
81 
86  Ipv6Address GetPrefix() const;
87 
92  void SetPrefixLen(uint8_t prefixLen);
93 
98  uint8_t GetPrefixLen() const;
99 
104  void SetRouteTag(uint16_t routeTag);
105 
110  uint16_t GetRouteTag() const;
111 
116  void SetRouteMetric(uint8_t routeMetric);
117 
122  uint8_t GetRouteMetric() const;
123 
124  private:
126  uint16_t m_tag;
127  uint8_t m_prefixLen;
128  uint8_t m_metric;
129 };
130 
138 std::ostream& operator<<(std::ostream& os, const RipNgRte& h);
139 
145 class RipNgHeader : public Header
146 {
147  public:
148  RipNgHeader();
149 
154  static TypeId GetTypeId();
155 
160  TypeId GetInstanceTypeId() const override;
161 
162  void Print(std::ostream& os) const override;
163 
168  uint32_t GetSerializedSize() const override;
169 
174  void Serialize(Buffer::Iterator start) const override;
175 
181  uint32_t Deserialize(Buffer::Iterator start) override;
182 
187  {
188  REQUEST = 0x1,
189  RESPONSE = 0x2,
190  };
191 
196  void SetCommand(Command_e command);
197 
202  Command_e GetCommand() const;
203 
208  void AddRte(RipNgRte rte);
209 
213  void ClearRtes();
214 
219  uint16_t GetRteNumber() const;
220 
225  std::list<RipNgRte> GetRteList() const;
226 
227  private:
228  uint8_t m_command;
229  std::list<RipNgRte> m_rteList;
230 };
231 
239 std::ostream& operator<<(std::ostream& os, const RipNgHeader& h);
240 
241 } // namespace ns3
242 
243 #endif /* RIPNG_HEADER_H */
iterator in a Buffer instance
Definition: buffer.h:100
Protocol header serialization and deserialization.
Definition: header.h:44
virtual uint32_t Deserialize(Buffer::Iterator start)=0
Deserialize the object from a buffer iterator.
Describes an IPv6 address.
Definition: ipv6-address.h:50
RipNgHeader - see RFC 2080
Definition: ripng-header.h:146
uint8_t m_command
command type
Definition: ripng-header.h:228
void SetCommand(Command_e command)
Set the command.
void ClearRtes()
Clear all the RTEs from the header.
uint16_t GetRteNumber() const
Get the number of RTE included in the message.
static TypeId GetTypeId()
Get the type ID.
void Serialize(Buffer::Iterator start) const override
Serialize the packet.
TypeId GetInstanceTypeId() const override
Return the instance type identifier.
std::list< RipNgRte > m_rteList
list of the RTEs in the message
Definition: ripng-header.h:229
void Print(std::ostream &os) const override
Command_e
Commands to be used in RipNg headers.
Definition: ripng-header.h:187
uint32_t GetSerializedSize() const override
Get the serialized size of the packet.
Command_e GetCommand() const
Get the command.
std::list< RipNgRte > GetRteList() const
Get the list of the RTEs included in the message.
void AddRte(RipNgRte rte)
Add a RTE to the message.
RipNg Routing Table Entry (RTE) - see RFC 2080
Definition: ripng-header.h:39
uint16_t m_tag
route tag
Definition: ripng-header.h:126
static TypeId GetTypeId()
Get the type ID.
Definition: ripng-header.cc:41
uint8_t m_metric
route metric
Definition: ripng-header.h:128
Ipv6Address m_prefix
prefix
Definition: ripng-header.h:125
Ipv6Address GetPrefix() const
Get the prefix.
uint8_t GetRouteMetric() const
Get the route metric.
uint8_t GetPrefixLen() const
Get the prefix length.
uint16_t GetRouteTag() const
Get the route tag.
uint8_t m_prefixLen
prefix length
Definition: ripng-header.h:127
void SetPrefix(Ipv6Address prefix)
Set the prefix.
Definition: ripng-header.cc:97
void Print(std::ostream &os) const override
Definition: ripng-header.cc:57
void Serialize(Buffer::Iterator start) const override
Serialize the packet.
Definition: ripng-header.cc:70
void SetPrefixLen(uint8_t prefixLen)
Set the prefix length.
void SetRouteMetric(uint8_t routeMetric)
Set the route metric.
TypeId GetInstanceTypeId() const override
Return the instance type identifier.
Definition: ripng-header.cc:51
uint32_t GetSerializedSize() const override
Get the serialized size of the packet.
Definition: ripng-header.cc:64
void SetRouteTag(uint16_t routeTag)
Set the route tag.
a unique identifier for an interface.
Definition: type-id.h:60
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition: angles.cc:129