A Discrete-Event Network Simulator
API
ipv6.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 
21 /* taken from src/node/ipv4.h and adapted to IPv6 */
22 
23 #ifndef IPV6_H
24 #define IPV6_H
25 
26 #include <stdint.h>
27 
28 #include "ns3/object.h"
29 #include "ns3/socket.h"
30 #include "ns3/callback.h"
31 
32 #include "ns3/ipv6-address.h"
33 #include "ipv6-interface-address.h"
34 
35 namespace ns3 {
36 
37 class Node;
38 class NetDevice;
39 class Packet;
40 class Ipv6RoutingProtocol;
41 class IpL4Protocol;
42 class Ipv6Route;
43 
81 class Ipv6 : public Object
82 {
83 public:
88  static TypeId GetTypeId (void);
89 
93  Ipv6 ();
94 
98  virtual ~Ipv6 ();
99 
109  virtual void SetRoutingProtocol (Ptr<Ipv6RoutingProtocol> routingProtocol) = 0;
110 
116  virtual Ptr<Ipv6RoutingProtocol> GetRoutingProtocol (void) const = 0;
117 
128  virtual uint32_t AddInterface (Ptr<NetDevice> device) = 0;
129 
134  virtual uint32_t GetNInterfaces (void) const = 0;
135 
150  virtual int32_t GetInterfaceForAddress (Ipv6Address address) const = 0;
151 
168  virtual int32_t GetInterfaceForPrefix (Ipv6Address address,
169  Ipv6Prefix mask) const = 0;
170 
176  virtual Ptr<NetDevice> GetNetDevice (uint32_t interface) = 0;
177 
183  virtual int32_t GetInterfaceForDevice (Ptr<const NetDevice> device) const = 0;
184 
191  virtual bool AddAddress (uint32_t interface, Ipv6InterfaceAddress address) = 0;
192 
198  virtual uint32_t GetNAddresses (uint32_t interface) const = 0;
199 
210  virtual Ipv6InterfaceAddress GetAddress (uint32_t interface, uint32_t addressIndex) const = 0;
211 
224  virtual bool RemoveAddress (uint32_t interface, uint32_t addressIndex) = 0;
225 
233  virtual bool RemoveAddress (uint32_t interface, Ipv6Address address) = 0;
234 
242  virtual void SetMetric (uint32_t interface, uint16_t metric) = 0;
243 
251  virtual uint16_t GetMetric (uint32_t interface) const = 0;
252 
259  virtual uint16_t GetMtu (uint32_t interface) const = 0;
260 
266  virtual void SetPmtu (Ipv6Address dst, uint32_t pmtu) = 0;
267 
274  virtual bool IsUp (uint32_t interface) const = 0;
275 
282  virtual void SetUp (uint32_t interface) = 0;
283 
290  virtual void SetDown (uint32_t interface) = 0;
291 
297  virtual bool IsForwarding (uint32_t interface) const = 0;
298 
306  virtual void SetForwarding (uint32_t interface, bool val) = 0;
307 
314  virtual Ipv6Address SourceAddressSelection (uint32_t interface, Ipv6Address dest) = 0;
315 
320  virtual void Insert (Ptr<IpL4Protocol> protocol) = 0;
321 
335  virtual void Insert (Ptr<IpL4Protocol> protocol, uint32_t interfaceIndex) = 0;
336 
341  virtual void Remove (Ptr<IpL4Protocol> protocol) = 0;
342 
348  virtual void Remove (Ptr<IpL4Protocol> protocol, uint32_t interfaceIndex) = 0;
349 
355  virtual Ptr<IpL4Protocol> GetProtocol (int protocolNumber) const = 0;
356 
363  virtual Ptr<IpL4Protocol> GetProtocol (int protocolNumber, int32_t interfaceIndex) const = 0;
364 
375  virtual void Send (Ptr<Packet> packet, Ipv6Address source, Ipv6Address destination, uint8_t protocol, Ptr<Ipv6Route> route) = 0;
376 
380  virtual void RegisterExtensions () = 0;
381 
385  virtual void RegisterOptions () = 0;
386 
390  static const uint32_t IF_ANY = 0xffffffff;
391 
392 private:
393  // Indirect the IPv6 attributes through private pure virtual methods
398  virtual void SetIpForward (bool forward) = 0;
399 
404  virtual bool GetIpForward (void) const = 0;
405 
410  virtual void SetMtuDiscover (bool mtuDiscover) = 0;
411 
416  virtual bool GetMtuDiscover (void) const = 0;
417 };
418 
419 } // namespace ns3
420 
421 #endif /* IPV6_H */
422 
virtual uint16_t GetMetric(uint32_t interface) const =0
Get metric for the specified IPv6 interface.
static TypeId GetTypeId(void)
Get the type ID.
Definition: ipv6.cc:34
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
virtual void SetMetric(uint32_t interface, uint16_t metric)=0
Set metric on specified Ipv6 interface.
virtual uint32_t GetNAddresses(uint32_t interface) const =0
Get number of addresses on specified IPv6 interface.
virtual void Insert(Ptr< IpL4Protocol > protocol)=0
Add a L4 protocol.
Access to the IPv6 forwarding table, interfaces, and configuration.
Definition: ipv6.h:81
virtual bool IsUp(uint32_t interface) const =0
If the specified interface index is in "up" state.
virtual void SetPmtu(Ipv6Address dst, uint32_t pmtu)=0
Set the Path MTU for the specified IPv6 destination address.
virtual bool RemoveAddress(uint32_t interface, uint32_t addressIndex)=0
Remove an address on specified IPv6 interface.
IPv6 address associated with an interface.
Ipv6()
Constructor.
Definition: ipv6.cc:53
virtual void SetMtuDiscover(bool mtuDiscover)=0
Set IPv6 MTU discover state.
virtual void SetIpForward(bool forward)=0
Set IPv6 forwarding state.
virtual void SetRoutingProtocol(Ptr< Ipv6RoutingProtocol > routingProtocol)=0
Register a new routing protocol to be used by this IPv6 stack.
virtual void Send(Ptr< Packet > packet, Ipv6Address source, Ipv6Address destination, uint8_t protocol, Ptr< Ipv6Route > route)=0
Higher-level layers call this method to send a packet down the stack to the MAC and PHY layers...
virtual Ipv6InterfaceAddress GetAddress(uint32_t interface, uint32_t addressIndex) const =0
Get IPv6 address on specified IPv6 interface.
virtual void SetForwarding(uint32_t interface, bool val)=0
Set forwarding on specified IPv6 interface.
virtual bool GetMtuDiscover(void) const =0
Get IPv6 MTU discover state.
virtual void RegisterExtensions()=0
Register the IPv6 Extensions.
virtual Ptr< IpL4Protocol > GetProtocol(int protocolNumber) const =0
Get L4 protocol by protocol number.
virtual uint16_t GetMtu(uint32_t interface) const =0
Get MTU for the specified IPv6 interface.
virtual ~Ipv6()
Destructor.
Definition: ipv6.cc:57
Every class exported by the ns3 library is enclosed in the ns3 namespace.
static const uint32_t IF_ANY
Any interface magic number.
Definition: ipv6.h:390
address
Definition: first.py:44
virtual void Remove(Ptr< IpL4Protocol > protocol)=0
Remove a L4 protocol.
virtual bool GetIpForward(void) const =0
Get IPv6 forwarding state.
virtual uint32_t AddInterface(Ptr< NetDevice > device)=0
Add a NetDevice interface.
Describes an IPv6 address.
Definition: ipv6-address.h:49
virtual int32_t GetInterfaceForPrefix(Ipv6Address address, Ipv6Prefix mask) const =0
Return the interface number of first interface found that has an IPv6 address within the prefix speci...
virtual void RegisterOptions()=0
Register the IPv6 Options.
virtual Ptr< NetDevice > GetNetDevice(uint32_t interface)=0
Get the NetDevice of the specified interface number.
Describes an IPv6 prefix.
Definition: ipv6-address.h:459
virtual bool IsForwarding(uint32_t interface) const =0
If the specified IPv6 interface has forwarding enabled.
virtual bool AddAddress(uint32_t interface, Ipv6InterfaceAddress address)=0
Add an address on the specified IPv6 interface.
A base class which provides memory management and object aggregation.
Definition: object.h:87
virtual Ptr< Ipv6RoutingProtocol > GetRoutingProtocol(void) const =0
Get the routing protocol to be used by this IPv6 stack.
virtual int32_t GetInterfaceForAddress(Ipv6Address address) const =0
Return the interface number of the interface that has been assigned the specified IP address...
a unique identifier for an interface.
Definition: type-id.h:58
virtual int32_t GetInterfaceForDevice(Ptr< const NetDevice > device) const =0
Get the interface index of the specified NetDevice.
virtual Ipv6Address SourceAddressSelection(uint32_t interface, Ipv6Address dest)=0
Choose the source address to use with destination address.
virtual void SetDown(uint32_t interface)=0
Set the interface into the "down" state.
virtual uint32_t GetNInterfaces(void) const =0
Get number of interfaces.
virtual void SetUp(uint32_t interface)=0
Set the interface into the "up" state.