A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ipv4.h
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/ip-l4-protocol.h"
28 #include "ns3/ipv4-address.h"
29 #include "ipv4-route.h"
30 #include "ipv4-interface-address.h"
31 
32 namespace ns3 {
33 
34 class Node;
35 class NetDevice;
36 class Packet;
37 class Ipv4RoutingProtocol;
38 
75 class Ipv4 : public Object
76 {
77 public:
78  static TypeId GetTypeId (void);
79  Ipv4 ();
80  virtual ~Ipv4 ();
81 
91  virtual void SetRoutingProtocol (Ptr<Ipv4RoutingProtocol> routingProtocol) = 0;
92 
98  virtual Ptr<Ipv4RoutingProtocol> GetRoutingProtocol (void) const = 0;
99 
109  virtual uint32_t AddInterface (Ptr<NetDevice> device) = 0;
110 
114  virtual uint32_t GetNInterfaces (void) const = 0;
115 
131  virtual int32_t GetInterfaceForAddress (Ipv4Address address) const = 0;
132 
143  virtual void Send (Ptr<Packet> packet, Ipv4Address source,
144  Ipv4Address destination, uint8_t protocol, Ptr<Ipv4Route> route) = 0;
145 
154  virtual void SendWithHeader (Ptr<Packet> packet, Ipv4Header ipHeader, Ptr<Ipv4Route> route) = 0;
155 
162  virtual void Insert (Ptr<IpL4Protocol> protocol) = 0;
163 
183  virtual bool IsDestinationAddress (Ipv4Address address, uint32_t iif) const = 0;
184 
201  virtual int32_t GetInterfaceForPrefix (Ipv4Address address,
202  Ipv4Mask mask) const = 0;
203 
208  virtual Ptr<NetDevice> GetNetDevice (uint32_t interface) = 0;
209 
214  virtual int32_t GetInterfaceForDevice (Ptr<const NetDevice> device) const = 0;
215 
221  virtual bool AddAddress (uint32_t interface, Ipv4InterfaceAddress address) = 0;
222 
227  virtual uint32_t GetNAddresses (uint32_t interface) const = 0;
228 
237  virtual Ipv4InterfaceAddress GetAddress (uint32_t interface, uint32_t addressIndex) const = 0;
238 
249  virtual bool RemoveAddress (uint32_t interface, uint32_t addressIndex) = 0;
250 
287  Ipv4Address dst, Ipv4InterfaceAddress::InterfaceAddressScope_e scope) = 0;
288 
294  virtual void SetMetric (uint32_t interface, uint16_t metric) = 0;
295 
301  virtual uint16_t GetMetric (uint32_t interface) const = 0;
302 
308  virtual uint16_t GetMtu (uint32_t interface) const = 0;
309 
315  virtual bool IsUp (uint32_t interface) const = 0;
316 
323  virtual void SetUp (uint32_t interface) = 0;
324 
331  virtual void SetDown (uint32_t interface) = 0;
332 
337  virtual bool IsForwarding (uint32_t interface) const = 0;
338 
345  virtual void SetForwarding (uint32_t interface, bool val) = 0;
346 
355  virtual Ptr<IpL4Protocol> GetProtocol (int protocolNumber) const = 0;
356 
362  virtual Ptr<Socket> CreateRawSocket (void) = 0;
363 
369  virtual void DeleteRawSocket (Ptr<Socket> socket) = 0;
370 
371 
372  static const uint32_t IF_ANY = 0xffffffff;
373 
374 private:
375  // Indirect the Ipv4 attributes through private pure virtual methods
376  virtual void SetIpForward (bool forward) = 0;
377  virtual bool GetIpForward (void) const = 0;
378  virtual void SetWeakEsModel (bool model) = 0;
379  virtual bool GetWeakEsModel (void) const = 0;
380 };
381 
382 } // namespace ns3
383 
384 #endif /* IPV4_H */
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:59
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:210
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:31
virtual void DeleteRawSocket(Ptr< Socket > socket)=0
Deletes a particular raw socket.
virtual Ptr< IpL4Protocol > GetProtocol(int protocolNumber) const =0
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:75
virtual bool IsForwarding(uint32_t interface) const =0
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 Ptr< Socket > CreateRawSocket(void)=0
Creates a raw socket.
virtual bool IsUp(uint32_t interface) const =0
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
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
virtual uint32_t GetNAddresses(uint32_t interface) const =0
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:63
virtual void SetDown(uint32_t interface)=0
virtual bool RemoveAddress(uint32_t interface, uint32_t addressIndex)=0
a unique identifier for an interface.
Definition: type-id.h:44
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.