Ns-3 Nix-vector Routing

src/routing/nix-vector-routing/ipv4-nix-vector-routing.h

+/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2009 The Georgia Institute of Technology 
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation;
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * Authors: Josh Pelkey <jpelkey@gatech.edu>
+ */
+
+#ifndef __IPV4_NIX_VECTOR_ROUTING_H__
+#define __IPV4_NIX_VECTOR_ROUTING_H__
+
+#include <map>
+
+#include "ns3/channel.h"
+#include "ns3/node-container.h"
+#include "ns3/node-list.h"
+#include "ns3/net-device-container.h"
+#include "ns3/ipv4-routing-protocol.h"
+#include "ns3/ipv4-route.h"
+
+namespace ns3 {
+
+typedef std::map<Ipv4Address, Ptr<NixVector> > NixMap_t;
+typedef std::map<Ipv4Address, Ptr<Ipv4Route> > Ipv4RouteMap_t;
+
+class Ipv4NixVectorRouting : public Ipv4RoutingProtocol
+{
+  public:
+    Ipv4NixVectorRouting ();

[craigdo, 2009/09/11 22:38:17]

Needs Doxygen

[jpelkey, 2009/09/12 18:34:14]

On 2009/09/11 22:38:17, craigdo wrote:
> Needs Doxygen

I moved most of these to private, as they should be.  Documented GetTypeId and
SetNode.

+    ~Ipv4NixVectorRouting ();
+    static TypeId GetTypeId (void);
+    Ptr<NixVector> GetNixVector (Ptr<Node>, Ipv4Address);
+    Ptr<NixVector> GetNixVectorInCache (Ipv4Address);
+    Ptr<Ipv4Route> GetIpv4RouteInCache (Ipv4Address);
+    void GetAdjacentNetDevices (Ptr<NetDevice>, Ptr<Channel>, NetDeviceContainer &);
+    Ptr<Node> GetNodeByIp (Ipv4Address);
+    void SetNode (Ptr<Node>);
+
+  private:
+    bool BuildNixVectorLocal (Ptr<NixVector> nixVector);
+    bool BuildNixVector (const std::vector< Ptr<Node> > & parentVector, uint32_t source, uint32_t dest, Ptr<NixVector> nixVector);
+    uint32_t FindTotalNeighbors (void);
+    uint32_t FindNetDeviceForNixIndex (uint32_t nodeIndex, Ipv4Address & gatewayIp);
+
+    // Breadth first search algorithm
+    // Param1: Vector containing all nodes in the graph
+    // Param2: Source Node
+    // Param3: Dest Node
+    // Param4: (returned) Parent vector for retracing routes
+    // Returns: false if dest not found, true o.w.
+    bool BFS (uint32_t numberOfNodes, 
+             Ptr<Node> source, 
+             Ptr<Node> dest, 
+             std::vector< Ptr<Node> > & parentVector);
+
+    void DoDispose (void);
+
+    // From Ipv4RoutingProtocol
+    virtual Ptr<Ipv4Route> RouteOutput (Ptr<Packet> p, const Ipv4Header &header, uint32_t oif, Socket::SocketErrno &sockerr);
+    virtual bool RouteInput (Ptr<const Packet> p, const Ipv4Header &header, Ptr<const NetDevice> idev,
+                             UnicastForwardCallback ucb, MulticastForwardCallback mcb,
+                             LocalDeliverCallback lcb, ErrorCallback ecb);  
+    virtual void NotifyInterfaceUp (uint32_t interface); 
+    virtual void NotifyInterfaceDown (uint32_t interface); 
+    virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address); 
+    virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address); 
+    virtual void SetIpv4 (Ptr<Ipv4> ipv4); 
+
+
+    NixMap_t m_nixCache;
+    Ipv4RouteMap_t m_ipv4RouteCache;
+    Ptr<Ipv4> m_ipv4;
+    Ptr<Node> m_node;
+    uint32_t m_totalNeighbors;
+};
+} // namepace ns3
+#endif