src/routing/olsr/olsr-agent-impl.h
changeset 4365 f71fd5bfc4ad
parent 4361 5e4790eea56f
parent 4364 579bbfe8bb65
child 4366 1c3138bce75e
--- a/src/routing/olsr/olsr-agent-impl.h	Fri Apr 17 17:45:16 2009 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,236 +0,0 @@
-/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
-/*
- * Copyright (c) 2004 Francisco J. Ros 
- * Copyright (c) 2007 INESC Porto
- *
- * 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: Francisco J. Ros  <fjrm@dif.um.es>
- *          Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
- */
-
-
-#ifndef __OLSR_AGENT_IMPL_H__
-#define __OLSR_AGENT_IMPL_H__
-
-#include "olsr-header.h"
-#include "olsr-state.h"
-#include "olsr-repositories.h"
-
-#include "ns3/object.h"
-#include "ns3/packet.h"
-#include "ns3/node.h"
-#include "ns3/socket.h"
-#include "ns3/event-garbage-collector.h"
-#include "ns3/timer.h"
-#include "ns3/traced-callback.h"
-#include "ns3/ipv4.h"
-
-#include <vector>
-#include <map>
-
-
-namespace ns3 {
-namespace olsr {
-
-
-/// An %OLSR's routing table entry.
-struct RoutingTableEntry
-{
-  Ipv4Address destAddr;	///< Address of the destination node.
-  Ipv4Address nextAddr;	///< Address of the next hop.
-  uint32_t interface; ///< Interface index
-  uint32_t distance; ///< Distance in hops to the destination.
-
-  RoutingTableEntry () : // default values
-    destAddr (), nextAddr (),
-    interface (0), distance (0) {};
-};
-
-
-class AgentImpl : public Ipv4RoutingProtocol
-{
-public:
-  static TypeId GetTypeId (void);
-
-  AgentImpl ();
-  virtual ~AgentImpl ();
-
-  void SetNode (Ptr<Node> node);
-
-  void Start ();
-  void SetMainInterface (uint32_t interface);
-
-private:
-  std::map<Ipv4Address, RoutingTableEntry> m_table; ///< Data structure for the routing table.
-
-  EventGarbageCollector m_events;
-
-  /// Address of the routing agent.
-  Ipv4Address m_routingAgentAddr;
-	
-  /// Packets sequence number counter.
-  uint16_t m_packetSequenceNumber;
-  /// Messages sequence number counter.
-  uint16_t m_messageSequenceNumber;
-  /// Advertised Neighbor Set sequence number.
-  uint16_t m_ansn;
-  
-  /// HELLO messages' emission interval.
-  Time m_helloInterval;
-  /// TC messages' emission interval.
-  Time m_tcInterval;
-  /// MID messages' emission interval.
-  Time m_midInterval;
-  /// Willingness for forwarding packets on behalf of other nodes.
-  uint8_t m_willingness;
-	
-  /// Internal state with all needed data structs.
-  OlsrState m_state;
-
-  Ptr<Ipv4> m_ipv4;
-	
-private:
-
-  void Clear ();
-  uint32_t GetSize () const { return m_table.size (); }
-  std::vector<RoutingTableEntry> GetEntries () const;
-  void RemoveEntry (const Ipv4Address &dest);
-  void AddEntry (const Ipv4Address &dest,
-                 const Ipv4Address &next,
-                 uint32_t interface,
-                 uint32_t distance);
-  void AddEntry (const Ipv4Address &dest,
-                 const Ipv4Address &next,
-                 const Ipv4Address &interfaceAddress,
-                 uint32_t distance);
-  bool Lookup (const Ipv4Address &dest,
-               RoutingTableEntry &outEntry) const;
-  bool FindSendEntry (const RoutingTableEntry &entry,
-                      RoutingTableEntry &outEntry) const;
-
-  // From Ipv4RoutingProtocol
-  virtual bool RequestRoute (uint32_t ifIndex,
-                             const Ipv4Header &ipHeader,
-                             Ptr<Packet> packet,
-                             RouteReplyCallback routeReply);
-  virtual bool RequestIfIndex (Ipv4Address destination, 
-                               uint32_t& ifIndex);
-
-
-  void DoDispose ();
-
-  void SendPacket (Ptr<Packet> packet, const MessageList &containedMessages);
-	
-  /// Increments packet sequence number and returns the new value.
-  inline uint16_t GetPacketSequenceNumber ();
-  /// Increments message sequence number and returns the new value.
-  inline uint16_t GetMessageSequenceNumber ();
-	
-  void RecvOlsr (Ptr<Socket> socket);
-
-  void MprComputation ();
-  void RoutingTableComputation ();
-  Ipv4Address GetMainAddress (Ipv4Address iface_addr) const;
-
-  // Timer handlers
-  Timer m_helloTimer;
-  void HelloTimerExpire ();
-  
-  Timer m_tcTimer;
-  void TcTimerExpire ();
-
-  Timer m_midTimer;
-  void MidTimerExpire ();
-
-  void DupTupleTimerExpire (Ipv4Address address, uint16_t sequenceNumber);
-  bool m_linkTupleTimerFirstTime;
-  void LinkTupleTimerExpire (Ipv4Address neighborIfaceAddr);
-  void Nb2hopTupleTimerExpire (Ipv4Address neighborMainAddr, Ipv4Address twoHopNeighborAddr);
-  void MprSelTupleTimerExpire (Ipv4Address mainAddr);
-  void TopologyTupleTimerExpire (Ipv4Address destAddr, Ipv4Address lastAddr);
-  void IfaceAssocTupleTimerExpire (Ipv4Address ifaceAddr);
-
-  void IncrementAnsn ();
-
-  /// A list of pending messages which are buffered awaiting for being sent.
-  olsr::MessageList m_queuedMessages;
-  Timer m_queuedMessagesTimer; // timer for throttling outgoing messages
-
-  void ForwardDefault (olsr::MessageHeader olsrMessage,
-                       DuplicateTuple *duplicated,
-                       const Ipv4Address &localIface,
-                       const Ipv4Address &senderAddress);
-  void QueueMessage (const olsr::MessageHeader &message, Time delay);
-  void SendQueuedMessages ();
-  void SendHello ();
-  void SendTc ();
-  void SendMid ();
-
-  void NeighborLoss (const LinkTuple &tuple);
-  void AddDuplicateTuple (const DuplicateTuple &tuple);
-  void RemoveDuplicateTuple (const DuplicateTuple &tuple);
-  void LinkTupleAdded (const LinkTuple &tuple, uint8_t willingness);
-  void RemoveLinkTuple (const LinkTuple &tuple);
-  void LinkTupleUpdated (const LinkTuple &tuple, uint8_t willingness);
-  void AddNeighborTuple (const NeighborTuple &tuple);
-  void RemoveNeighborTuple (const NeighborTuple &tuple);
-  void AddTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple);
-  void RemoveTwoHopNeighborTuple (const TwoHopNeighborTuple &tuple);
-  void AddMprSelectorTuple (const MprSelectorTuple  &tuple);
-  void RemoveMprSelectorTuple (const MprSelectorTuple &tuple);
-  void AddTopologyTuple (const TopologyTuple &tuple);
-  void RemoveTopologyTuple (const TopologyTuple &tuple);
-  void AddIfaceAssocTuple (const IfaceAssocTuple &tuple);
-  void RemoveIfaceAssocTuple (const IfaceAssocTuple &tuple);
-
-  void ProcessHello (const olsr::MessageHeader &msg,
-                     const Ipv4Address &receiverIface,
-                     const Ipv4Address &senderIface);
-  void ProcessTc (const olsr::MessageHeader &msg,
-                  const Ipv4Address &senderIface);
-  void ProcessMid (const olsr::MessageHeader &msg,
-                   const Ipv4Address &senderIface);
-
-  void LinkSensing (const olsr::MessageHeader &msg,
-                    const olsr::MessageHeader::Hello &hello,
-                    const Ipv4Address &receiverIface,
-                    const Ipv4Address &sender_iface);
-  void PopulateNeighborSet (const olsr::MessageHeader &msg,
-                            const olsr::MessageHeader::Hello &hello);
-  void PopulateTwoHopNeighborSet (const olsr::MessageHeader &msg,
-                                  const olsr::MessageHeader::Hello &hello);
-  void PopulateMprSelectorSet (const olsr::MessageHeader &msg,
-                               const olsr::MessageHeader::Hello &hello);
-
-  int Degree (NeighborTuple const &tuple);
-
-  Ipv4Address m_mainAddress;
-
-  // One socket per interface, each bound to that interface's address
-  // (reason: for OLSR Link Sensing we need to know on which interface
-  // HELLO messages arrive)
-  std::map< Ptr<Socket>, Ipv4Address > m_socketAddresses;
-
-  TracedCallback <const PacketHeader &,
-                  const MessageList &> m_rxPacketTrace;
-  TracedCallback <const PacketHeader &,
-                  const MessageList &> m_txPacketTrace;
-  TracedCallback <uint32_t> m_routingTableChanged;
-
-};
-
-}} // namespace ns3
-
-#endif