A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ipv6-interface.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007-2009 Strasbourg University
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: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
19  */
20 
21 #ifndef IPV6_INTERFACE_H
22 #define IPV6_INTERFACE_H
23 
24 #include <list>
25 
26 #include "ns3/ipv6-address.h"
27 #include "ns3/ipv6-interface-address.h"
28 #include "ns3/ptr.h"
29 #include "ns3/object.h"
30 #include "ns3/timer.h"
31 
32 namespace ns3
33 {
34 
35 class NetDevice;
36 class Packet;
37 class Node;
38 class NdiscCache;
39 
49 class Ipv6Interface : public Object
50 {
51 public:
56  static TypeId GetTypeId ();
57 
61  Ipv6Interface ();
62 
66  virtual ~Ipv6Interface ();
67 
72  void SetNode (Ptr<Node> node);
73 
78  void SetDevice (Ptr<NetDevice> device);
79 
84  virtual Ptr<NetDevice> GetDevice () const;
85 
90  void SetMetric (uint16_t metric);
91 
96  uint16_t GetMetric () const;
97 
102  bool IsUp () const;
103 
108  bool IsDown () const;
109 
113  void SetUp ();
114 
118  void SetDown ();
119 
124  bool IsForwarding () const;
125 
130  void SetForwarding (bool forward);
131 
136  void SetCurHopLimit (uint8_t curHopLimit);
137 
142  uint8_t GetCurHopLimit () const;
143 
148  void SetBaseReachableTime (uint16_t baseReachableTime);
149 
154  uint16_t GetBaseReachableTime () const;
155 
160  void SetReachableTime (uint16_t reachableTime);
161 
166  uint16_t GetReachableTime () const;
167 
172  void SetRetransTimer (uint16_t retransTimer);
173 
178  uint16_t GetRetransTimer () const;
179 
188  void Send (Ptr<Packet> p, Ipv6Address dest);
189 
195  bool AddAddress (Ipv6InterfaceAddress iface);
196 
202 
208  Ipv6InterfaceAddress GetAddress (uint32_t index) const;
209 
216 
221  uint32_t GetNAddresses (void) const;
222 
228  Ipv6InterfaceAddress RemoveAddress (uint32_t index);
229 
238 
244  void SetState (Ipv6Address address, Ipv6InterfaceAddress::State_e state);
245 
251  void SetNsDadUid (Ipv6Address address, uint32_t uid);
252 
253 protected:
257  virtual void DoDispose ();
258 
259 private:
263  typedef std::list<Ipv6InterfaceAddress> Ipv6InterfaceAddressList;
264 
268  typedef std::list<Ipv6InterfaceAddress>::iterator Ipv6InterfaceAddressListI;
269 
273  typedef std::list<Ipv6InterfaceAddress>::const_iterator Ipv6InterfaceAddressListCI;
274 
278  void DoSetup ();
279 
284 
288  bool m_ifup;
289 
294 
298  uint16_t m_metric;
299 
304 
309 
314 
318  uint8_t m_curHopLimit;
319 
324 
329  uint16_t m_reachableTime;
330 
335  uint16_t m_retransTimer;
336 };
337 
338 } /* namespace ns3 */
339 
340 #endif /* IPV6_INTERFACE_H */
341 
Ipv6InterfaceAddressList m_addresses
The addresses assigned to this interface.
bool m_ifup
The state of this interface.
bool AddAddress(Ipv6InterfaceAddress iface)
Add an IPv6 address.
void SetState(Ipv6Address address, Ipv6InterfaceAddress::State_e state)
Update state of an interface address.
void SetUp()
Enable this interface.
uint16_t GetRetransTimer() const
Get the retransmission timer.
bool m_forwarding
Forwarding state.
Ipv6InterfaceAddress GetAddress(uint32_t index) const
Get an address from IPv6 interface.
IPv6 address associated with an interface.
Ptr< NetDevice > m_device
NetDevice associated with this interface.
void SetDevice(Ptr< NetDevice > device)
Set the NetDevice.
void SetReachableTime(uint16_t reachableTime)
Set the reachable time.
std::list< Ipv6InterfaceAddress >::iterator Ipv6InterfaceAddressListI
Container Iterator for the Ipv6InterfaceAddresses.
std::list< Ipv6InterfaceAddress > Ipv6InterfaceAddressList
Container for the Ipv6InterfaceAddresses.
bool IsUp() const
Is the interface UP ?
bool IsDown() const
Is the interface DOWN ?
void SetBaseReachableTime(uint16_t baseReachableTime)
Set the base reachable time.
uint16_t m_baseReachableTime
Base value used for computing the random reachable time value (in millisecond).
The IPv6 representation of a network interface.
uint16_t GetBaseReachableTime() const
Get the base reachable time.
uint32_t GetNAddresses(void) const
Get number of addresses on this IPv6 interface.
void SetMetric(uint16_t metric)
Set the metric.
Ptr< Node > m_node
Node associated with this interface.
virtual ~Ipv6Interface()
Destructor.
void SetRetransTimer(uint16_t retransTimer)
Set the retransmission timer.
uint16_t m_retransTimer
Retransmission timer (in millisecond).
static TypeId GetTypeId()
Get the type ID.
virtual Ptr< NetDevice > GetDevice() const
Get the NetDevice.
void Send(Ptr< Packet > p, Ipv6Address dest)
Send a packet through this interface.
void SetNsDadUid(Ipv6Address address, uint32_t uid)
Update NS DAD packet UID of an interface address.
void SetNode(Ptr< Node > node)
Set node associated with interface.
void SetForwarding(bool forward)
Set forwarding enabled or not.
uint8_t m_curHopLimit
Current hop limit.
void SetCurHopLimit(uint8_t curHopLimit)
Set the current hop limit.
Ipv6InterfaceAddress GetLinkLocalAddress() const
Get link-local address from IPv6 interface.
uint8_t GetCurHopLimit() const
Get the current hop limit value.
Describes an IPv6 address.
Definition: ipv6-address.h:46
uint16_t GetMetric() const
Get the metric.
State_e
State of an address associated with an interface.
void DoSetup()
Initialize interface.
uint16_t m_reachableTime
Reachable time (in millisecond).
bool IsForwarding() const
If the interface allows forwarding packets.
uint16_t GetReachableTime() const
Get the reachable time.
Ipv6InterfaceAddress RemoveAddress(uint32_t index)
Remove an address from interface.
a base class which provides memory management and object aggregation
Definition: object.h:64
tuple address
Definition: first.py:37
virtual void DoDispose()
Dispose this object.
std::list< Ipv6InterfaceAddress >::const_iterator Ipv6InterfaceAddressListCI
Const Container Iterator for the Ipv6InterfaceAddresses.
uint16_t m_metric
The metric.
void SetDown()
Disable this interface.
a unique identifier for an interface.
Definition: type-id.h:49
Ipv6InterfaceAddress GetAddressMatchingDestination(Ipv6Address dst)
Get an address which is in the same network prefix as destination.
Ptr< NdiscCache > m_ndCache
Neighbor cache.
Ipv6Interface()
Constructs an Ipv6Interface.