A Discrete-Event Network Simulator
API
ipv4.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef IPV4_H
21 #define IPV4_H
22 
23 #include <stdint.h>
24 #include "ns3/object.h"
25 #include "ns3/socket.h"
26 #include "ns3/callback.h"
27 #include "ns3/ipv4-address.h"
28 #include "ipv4-route.h"
29 #include "ipv4-interface-address.h"
30 
31 namespace ns3 {
32 
33 class Node;
34 class NetDevice;
35 class Packet;
36 class Ipv4RoutingProtocol;
37 class IpL4Protocol;
38 class Ipv4Header;
39 
76 class Ipv4 : public Object
77 {
78 public:
83  static TypeId GetTypeId (void);
84  Ipv4 ();
85  virtual ~Ipv4 ();
86 
96  virtual void SetRoutingProtocol (Ptr<Ipv4RoutingProtocol> routingProtocol) = 0;
97 
103  virtual Ptr<Ipv4RoutingProtocol> GetRoutingProtocol (void) const = 0;
104 
114  virtual uint32_t AddInterface (Ptr<NetDevice> device) = 0;
115 
119  virtual uint32_t GetNInterfaces (void) const = 0;
120 
136  virtual int32_t GetInterfaceForAddress (Ipv4Address address) const = 0;
137 
148  virtual void Send (Ptr<Packet> packet, Ipv4Address source,
149  Ipv4Address destination, uint8_t protocol, Ptr<Ipv4Route> route) = 0;
150 
159  virtual void SendWithHeader (Ptr<Packet> packet, Ipv4Header ipHeader, Ptr<Ipv4Route> route) = 0;
160 
171  virtual void Insert (Ptr<IpL4Protocol> protocol) = 0;
172 
186  virtual void Insert (Ptr<IpL4Protocol> protocol, uint32_t interfaceIndex) = 0;
187 
194  virtual void Remove (Ptr<IpL4Protocol> protocol) = 0;
195 
201  virtual void Remove (Ptr<IpL4Protocol> protocol, uint32_t interfaceIndex) = 0;
202 
223  virtual bool IsDestinationAddress (Ipv4Address address, uint32_t iif) const = 0;
224 
241  virtual int32_t GetInterfaceForPrefix (Ipv4Address address,
242  Ipv4Mask mask) const = 0;
243 
248  virtual Ptr<NetDevice> GetNetDevice (uint32_t interface) = 0;
249 
254  virtual int32_t GetInterfaceForDevice (Ptr<const NetDevice> device) const = 0;
255 
261  virtual bool AddAddress (uint32_t interface, Ipv4InterfaceAddress address) = 0;
262 
267  virtual uint32_t GetNAddresses (uint32_t interface) const = 0;
268 
277  virtual Ipv4InterfaceAddress GetAddress (uint32_t interface, uint32_t addressIndex) const = 0;
278 
289  virtual bool RemoveAddress (uint32_t interface, uint32_t addressIndex) = 0;
290 
298  virtual bool RemoveAddress (uint32_t interface, Ipv4Address address) = 0;
299 
337 
343  virtual void SetMetric (uint32_t interface, uint16_t metric) = 0;
344 
350  virtual uint16_t GetMetric (uint32_t interface) const = 0;
351 
357  virtual uint16_t GetMtu (uint32_t interface) const = 0;
358 
364  virtual bool IsUp (uint32_t interface) const = 0;
365 
372  virtual void SetUp (uint32_t interface) = 0;
373 
380  virtual void SetDown (uint32_t interface) = 0;
381 
386  virtual bool IsForwarding (uint32_t interface) const = 0;
387 
394  virtual void SetForwarding (uint32_t interface, bool val) = 0;
395 
402  virtual Ipv4Address SourceAddressSelection (uint32_t interface, Ipv4Address dest) = 0;
403 
412  virtual Ptr<IpL4Protocol> GetProtocol (int protocolNumber) const = 0;
413 
420  virtual Ptr<IpL4Protocol> GetProtocol (int protocolNumber, int32_t interfaceIndex) const = 0;
421 
427  virtual Ptr<Socket> CreateRawSocket (void) = 0;
428 
434  virtual void DeleteRawSocket (Ptr<Socket> socket) = 0;
435 
436 
437  static const uint32_t IF_ANY = 0xffffffff;
438 
439 private:
440  // Indirect the Ipv4 attributes through private pure virtual methods
441 
446  virtual void SetIpForward (bool forward) = 0;
451  virtual bool GetIpForward (void) const = 0;
452 
459  virtual void SetWeakEsModel (bool model) = 0;
466  virtual bool GetWeakEsModel (void) const = 0;
467 };
468 
469 } // namespace ns3
470 
471 #endif /* IPV4_H */
static TypeId GetTypeId(void)
Get the type ID.
Definition: ipv4.cc:34
virtual uint32_t AddInterface(Ptr< NetDevice > device)=0
virtual int32_t GetInterfaceForPrefix(Ipv4Address address, Ipv4Mask mask) const =0
Return the interface number of first interface found that has an Ipv4 address within the prefix speci...
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
virtual void SetWeakEsModel(bool model)=0
Set or unset the Weak Es Model.
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:263
virtual Ipv4Address SourceAddressSelection(uint32_t interface, Ipv4Address dest)=0
Choose the source address to use with destination address.
virtual Ptr< NetDevice > GetNetDevice(uint32_t interface)=0
virtual void SetForwarding(uint32_t interface, bool val)=0
virtual Ptr< Ipv4RoutingProtocol > GetRoutingProtocol(void) const =0
Get the routing protocol to be used by this Ipv4 stack.
virtual bool IsDestinationAddress(Ipv4Address address, uint32_t iif) const =0
Determine whether address and interface corresponding to received packet can be accepted for local de...
Packet header for IPv4.
Definition: ipv4-header.h:33
virtual bool GetIpForward(void) const =0
Get the IP forwarding state.
virtual void DeleteRawSocket(Ptr< Socket > socket)=0
Deletes a particular raw socket.
virtual Ptr< IpL4Protocol > GetProtocol(int protocolNumber) const =0
Ipv4()
Definition: ipv4.cc:61
virtual void SetUp(uint32_t interface)=0
virtual uint16_t GetMetric(uint32_t interface) const =0
virtual void SendWithHeader(Ptr< Packet > packet, Ipv4Header ipHeader, Ptr< Ipv4Route > route)=0
Access to the IPv4 forwarding table, interfaces, and configuration.
Definition: ipv4.h:76
virtual bool GetWeakEsModel(void) const =0
Get the Weak Es Model status.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual bool IsForwarding(uint32_t interface) const =0
address
Definition: first.py:44
virtual uint16_t GetMtu(uint32_t interface) const =0
virtual void Send(Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination, uint8_t protocol, Ptr< Ipv4Route > route)=0
virtual ~Ipv4()
Definition: ipv4.cc:66
virtual Ptr< Socket > CreateRawSocket(void)=0
Creates a raw socket.
virtual bool IsUp(uint32_t interface) const =0
virtual void SetIpForward(bool forward)=0
Set or unset the IP forwarding state.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:41
virtual void Insert(Ptr< IpL4Protocol > protocol)=0
a class to store IPv4 address information on an interface
virtual Ipv4InterfaceAddress GetAddress(uint32_t interface, uint32_t addressIndex) const =0
Because addresses can be removed, the addressIndex is not guaranteed to be static across calls to thi...
virtual uint32_t GetNAddresses(uint32_t interface) const =0
static const uint32_t IF_ANY
interface wildcard, meaning any interface
Definition: ipv4.h:437
virtual Ipv4Address SelectSourceAddress(Ptr< const NetDevice > device, Ipv4Address dst, Ipv4InterfaceAddress::InterfaceAddressScope_e scope)=0
Return the first primary source address with scope less than or equal to the requested scope...
virtual void SetMetric(uint32_t interface, uint16_t metric)=0
virtual int32_t GetInterfaceForDevice(Ptr< const NetDevice > device) const =0
virtual bool AddAddress(uint32_t interface, Ipv4InterfaceAddress address)=0
virtual int32_t GetInterfaceForAddress(Ipv4Address address) const =0
Return the interface number of the interface that has been assigned the specified IP address...
A base class which provides memory management and object aggregation.
Definition: object.h:87
virtual void SetDown(uint32_t interface)=0
virtual bool RemoveAddress(uint32_t interface, uint32_t addressIndex)=0
Remove the address at addressIndex on named interface.
a unique identifier for an interface.
Definition: type-id.h:58
virtual uint32_t GetNInterfaces(void) const =0
virtual void SetRoutingProtocol(Ptr< Ipv4RoutingProtocol > routingProtocol)=0
Register a new routing protocol to be used by this Ipv4 stack.
virtual void Remove(Ptr< IpL4Protocol > protocol)=0