src/routing/list-routing/ipv4-list-routing.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Fri, 26 Jun 2009 15:34:16 +0200
changeset 4616 a84f60b6cd12
parent 4603 67a0a49c1db4
child 4673 36b78cddce4d
permissions -rw-r--r--
bug 600: lower the default routing priority of Ipv4GlobalRouting; move to helper
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4561
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     2
/*
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     3
 * Copyright (c) 2009 University of Washington
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     4
 *
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
 *
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    12
 * GNU General Public License for more details.
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    13
 *
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
 */
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    18
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    19
#ifndef IPV4_LIST_ROUTING_H
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    20
#define IPV4_LIST_ROUTING_H
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    21
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    22
#include <list>
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    23
#include "ns3/ipv4-routing-protocol.h"
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    24
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
namespace ns3 {
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    26
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    27
/**
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    28
 * \ingroup ipv4Routing 
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    29
 *
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    30
 * This class is a specialization of Ipv4RoutingProtocol that allows 
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    31
 * other instances of Ipv4RoutingProtocol to be inserted in a 
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    32
 * prioritized list.  Routing protocols in the list are consulted one
4562
8539f55c6b55 Fix bug 587 for ListRoutingProtocol bug; add unit test
Tom Henderson <tomh@tomh.org>
parents: 4561
diff changeset
    33
 * by one, from highest to lowest priority, until a routing protocol
4561
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    34
 * is found that will take the packet (this corresponds to a non-zero
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    35
 * return value to RouteOutput, or a return value of true to RouteInput).
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    36
 * The order by which routing protocols with the same priority value 
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    37
 * are consulted is undefined.
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    38
 * 
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    39
 */
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    40
class Ipv4ListRouting : public Ipv4RoutingProtocol
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    41
{
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    42
public:
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    43
  static TypeId GetTypeId (void);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    44
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    45
  Ipv4ListRouting ();  
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    46
  virtual ~Ipv4ListRouting ();  
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    47
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    48
  /**
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    49
   * \brief Register a new routing protocol to be used in this IPv4 stack
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    50
   *
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    51
   * \param routingProtocol new routing protocol implementation object
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    52
   * \param priority priority to give to this routing protocol.
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    53
   * Values may range between -32768 and +32767.  
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    54
   */
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    55
  virtual void AddRoutingProtocol (Ptr<Ipv4RoutingProtocol> routingProtocol, int16_t priority);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    56
  /**
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    57
   * \return number of routing protocols in the list
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    58
   */
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    59
  virtual uint32_t GetNRoutingProtocols (void) const;
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    60
  /**
4562
8539f55c6b55 Fix bug 587 for ListRoutingProtocol bug; add unit test
Tom Henderson <tomh@tomh.org>
parents: 4561
diff changeset
    61
   * Return pointer to routing protocol stored at index, with the
8539f55c6b55 Fix bug 587 for ListRoutingProtocol bug; add unit test
Tom Henderson <tomh@tomh.org>
parents: 4561
diff changeset
    62
   * first protocol (index 0) the highest priority, the next one (index 1)
8539f55c6b55 Fix bug 587 for ListRoutingProtocol bug; add unit test
Tom Henderson <tomh@tomh.org>
parents: 4561
diff changeset
    63
   * the second highest priority, and so on.  The priority parameter is an
8539f55c6b55 Fix bug 587 for ListRoutingProtocol bug; add unit test
Tom Henderson <tomh@tomh.org>
parents: 4561
diff changeset
    64
   * output parameter and it returns the integer priority of the protocol.
8539f55c6b55 Fix bug 587 for ListRoutingProtocol bug; add unit test
Tom Henderson <tomh@tomh.org>
parents: 4561
diff changeset
    65
   * 
4561
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    66
   * \return pointer to routing protocol indexed by 
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    67
   * \param index index of protocol to return
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    68
   * \param priority output parameter, set to the priority of the protocol
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    69
            being returned
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    70
   */
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    71
  virtual Ptr<Ipv4RoutingProtocol> GetRoutingProtocol (uint32_t index, int16_t& priority) const;
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    72
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    73
  // Below are from Ipv4RoutingProtocol
4603
67a0a49c1db4 bug 592: Ipv4RoutingProtocol::RouteOutput needs a packet pointer argument for reactive protocols
Josh Pelkey <joshpelkey@gmail.com>
parents: 4573
diff changeset
    74
  virtual Ptr<Ipv4Route> RouteOutput (Ptr<Packet> p, const Ipv4Header &header, uint32_t oif, Socket::SocketErrno &sockerr);
4561
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    75
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    76
  virtual bool RouteInput (Ptr<const Packet> p, const Ipv4Header &header, Ptr<const NetDevice> idev,
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    77
                           UnicastForwardCallback ucb, MulticastForwardCallback mcb,
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    78
                           LocalDeliverCallback lcb, ErrorCallback ecb);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    79
  virtual void NotifyInterfaceUp (uint32_t interface);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    80
  virtual void NotifyInterfaceDown (uint32_t interface);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    81
  virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    82
  virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    83
  virtual void SetIpv4 (Ptr<Ipv4> ipv4);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    84
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    85
protected:
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    86
  void DoDispose (void);
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    87
private:
4570
5c6e1f086a36 avoid using non-portable reverse iterator methods
Tom Henderson <tomh@tomh.org>
parents: 4562
diff changeset
    88
  typedef std::pair<int16_t, Ptr<Ipv4RoutingProtocol> > Ipv4RoutingProtocolEntry;
5c6e1f086a36 avoid using non-portable reverse iterator methods
Tom Henderson <tomh@tomh.org>
parents: 4562
diff changeset
    89
  typedef std::list<Ipv4RoutingProtocolEntry> Ipv4RoutingProtocolList;
4561
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    90
  Ipv4RoutingProtocolList m_routingProtocols;
4570
5c6e1f086a36 avoid using non-portable reverse iterator methods
Tom Henderson <tomh@tomh.org>
parents: 4562
diff changeset
    91
  static bool Compare (const Ipv4RoutingProtocolEntry& a, const Ipv4RoutingProtocolEntry& b);
4561
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    92
  Ptr<Ipv4> m_ipv4;
4570
5c6e1f086a36 avoid using non-portable reverse iterator methods
Tom Henderson <tomh@tomh.org>
parents: 4562
diff changeset
    93
4561
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    94
};
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    95
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    96
} //namespace ns3
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    97
cf6e27dd3a08 Move Ipv4ListRouting to src/internet-stack; get rid of Impl class
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    98
#endif /* IPV4_LIST_ROUTING_H */