A Discrete-Event Network Simulator
API
rip-header.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2016 Universita' di Firenze, Italy
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 * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
19 */
20
21#ifndef RIP_HEADER_H
22#define RIP_HEADER_H
23
24#include <list>
25#include "ns3/header.h"
26#include "ns3/ipv4-address.h"
27#include "ns3/packet.h"
28#include "ns3/ipv4-header.h"
29
30
31namespace ns3 {
32
37class RipRte : public Header
38{
39public:
40 RipRte (void);
41
46 static TypeId GetTypeId (void);
47
52 virtual TypeId GetInstanceTypeId (void) const;
53
54 virtual void Print (std::ostream& os) const;
55
60 virtual uint32_t GetSerializedSize (void) const;
61
66 virtual void Serialize (Buffer::Iterator start) const;
67
74
79 void SetPrefix (Ipv4Address prefix);
80
85 Ipv4Address GetPrefix (void) const;
86
91 void SetSubnetMask (Ipv4Mask subnetMask);
92
97 Ipv4Mask GetSubnetMask (void) const;
98
103 void SetRouteTag (uint16_t routeTag);
104
109 uint16_t GetRouteTag (void) const;
110
115 void SetRouteMetric (uint32_t routeMetric);
116
121 uint32_t GetRouteMetric (void) const;
122
127 void SetNextHop (Ipv4Address nextHop);
128
133 Ipv4Address GetNextHop (void) const;
134
135
136private:
137 uint16_t m_tag;
142};
143
151std::ostream & operator << (std::ostream & os, const RipRte & h);
152
157class RipHeader : public Header
158{
159public:
160 RipHeader (void);
161
166 static TypeId GetTypeId (void);
167
172 virtual TypeId GetInstanceTypeId (void) const;
173
174 virtual void Print (std::ostream& os) const;
175
180 virtual uint32_t GetSerializedSize (void) const;
181
186 virtual void Serialize (Buffer::Iterator start) const;
187
194
199 {
200 REQUEST = 0x1,
201 RESPONSE = 0x2,
202 };
203
208 void SetCommand (Command_e command);
209
214 Command_e GetCommand (void) const;
215
220 void AddRte (RipRte rte);
221
225 void ClearRtes ();
226
231 uint16_t GetRteNumber (void) const;
232
237 std::list<RipRte> GetRteList (void) const;
238
239private:
240 uint8_t m_command;
241 std::list<RipRte> m_rteList;
242};
243
251std::ostream & operator << (std::ostream & os, const RipHeader & h);
252
253}
254
255#endif /* Rip_HEADER_H */
256
iterator in a Buffer instance
Definition: buffer.h:99
Protocol header serialization and deserialization.
Definition: header.h:43
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:256
RipHeader - see RFC 2453
Definition: rip-header.h:158
virtual void Print(std::ostream &os) const
Definition: rip-header.cc:176
std::list< RipRte > GetRteList(void) const
Get the list of the RTEs included in the message.
Definition: rip-header.cc:272
virtual TypeId GetInstanceTypeId(void) const
Return the instance type identifier.
Definition: rip-header.cc:171
void AddRte(RipRte rte)
Add a RTE to the message.
Definition: rip-header.cc:257
virtual uint32_t GetSerializedSize(void) const
Get the serialized size of the packet.
Definition: rip-header.cc:187
std::list< RipRte > m_rteList
list of the RTEs in the message
Definition: rip-header.h:241
void SetCommand(Command_e command)
Set the command.
Definition: rip-header.cc:247
Command_e
Commands to be used in Rip headers.
Definition: rip-header.h:199
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
Definition: rip-header.cc:209
uint8_t m_command
command type
Definition: rip-header.h:240
static TypeId GetTypeId(void)
Get the type ID.
Definition: rip-header.cc:162
void ClearRtes()
Clear all the RTEs from the header.
Definition: rip-header.cc:262
uint16_t GetRteNumber(void) const
Get the number of RTE included in the message.
Definition: rip-header.cc:267
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
Definition: rip-header.cc:193
Command_e GetCommand(void) const
Get the command.
Definition: rip-header.cc:252
Rip v2 Routing Table Entry (RTE) - see RFC 2453.
Definition: rip-header.h:38
void SetSubnetMask(Ipv4Mask subnetMask)
Set the subnet mask.
Definition: rip-header.cc:103
Ipv4Address GetNextHop(void) const
Get the next hop.
Definition: rip-header.cc:138
Ipv4Address m_prefix
Advertised prefix.
Definition: rip-header.h:138
uint32_t m_metric
Route metric.
Definition: rip-header.h:141
Ipv4Mask m_subnetMask
Subnet mask.
Definition: rip-header.h:139
void SetRouteMetric(uint32_t routeMetric)
Set the route metric.
Definition: rip-header.cc:123
Ipv4Address GetPrefix(void) const
Get the prefix.
Definition: rip-header.cc:98
uint16_t m_tag
Route tag.
Definition: rip-header.h:137
void SetPrefix(Ipv4Address prefix)
Set the prefix.
Definition: rip-header.cc:93
uint16_t GetRouteTag(void) const
Get the route tag.
Definition: rip-header.cc:118
Ipv4Mask GetSubnetMask(void) const
Get the subnet mask.
Definition: rip-header.cc:108
virtual TypeId GetInstanceTypeId(void) const
Return the instance type identifier.
Definition: rip-header.cc:46
RipRte(void)
Definition: rip-header.cc:32
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
Definition: rip-header.cc:62
uint32_t GetRouteMetric(void) const
Get the route metric.
Definition: rip-header.cc:128
virtual uint32_t GetSerializedSize(void) const
Get the serialized size of the packet.
Definition: rip-header.cc:57
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
Definition: rip-header.cc:73
Ipv4Address m_nextHop
Next hop.
Definition: rip-header.h:140
void SetRouteTag(uint16_t routeTag)
Set the route tag.
Definition: rip-header.cc:113
static TypeId GetTypeId(void)
Get the type ID.
Definition: rip-header.cc:37
void SetNextHop(Ipv4Address nextHop)
Set the next hop.
Definition: rip-header.cc:133
virtual void Print(std::ostream &os) const
Definition: rip-header.cc:51
a unique identifier for an interface.
Definition: type-id.h:59
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:139
def start()
Definition: core.py:1853