RoutingTable.h

Go to the documentation of this file.

//
// Copyright (C) 2000 Institut fuer Telematik, Universitaet Karlsruhe
// Copyright (C) 2004-2006 Andras Varga
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, see <http://www.gnu.org/licenses/>.
//

//
//  Author:     Jochen Reber
//    Date:       18.5.00
//    On Linux:   19.5.00 - 29.5.00
//  Modified by Vincent Oberle
//    Date:       1.2.2001
//  Cleanup and rewrite: Andras Varga, 2004
//

#ifndef __ROUTINGTABLE_H
#define __ROUTINGTABLE_H

#include <vector>
#include <omnetpp.h>
#include "INETDefs.h"
#include "IPAddress.h"
#include "IInterfaceTable.h"
#include "NotificationBoard.h"
#include "IRoutingTable.h"

class RoutingTableParser;


class INET_API RoutingTable: public cSimpleModule, public IRoutingTable, protected INotifiable
{
  protected:
    IInterfaceTable *ift; // cached pointer
    NotificationBoard *nb; // cached pointer

    IPAddress routerId;
    bool IPForward;

    //
    // Routes:
    //
    typedef std::vector<IPRoute *> RouteVector;
    RouteVector routes;          // Unicast route array
    RouteVector multicastRoutes; // Multicast route array

    // routing cache: maps destination address to the route
    typedef std::map<IPAddress, const IPRoute *> RoutingCache;
    mutable RoutingCache routingCache;

    // local addresses cache (to speed up isLocalAddress())
    typedef std::set<IPAddress> AddressSet;
    mutable AddressSet localAddresses;

  protected:
    // set IP address etc on local loopback
    virtual void configureLoopbackForIPv4();

    // check if a route table entry corresponds to the following parameters
    virtual bool routeMatches(const IPRoute *entry,
        const IPAddress& target, const IPAddress& nmask, const IPAddress& gw,
        int metric, const char *dev) const;

    // set router Id
    virtual void configureRouterId();

    // adjust routes with src=IFACENETMASK to actual interface netmasks
    virtual void updateNetmaskRoutes();

    // displays summary above the icon
    virtual void updateDisplayString();

    // delete routes for the given interface
    virtual void deleteInterfaceRoutes(InterfaceEntry *entry);

    // invalidates routing cache and local addresses cache
    virtual void invalidateCache();

  public:
    RoutingTable();
    virtual ~RoutingTable();

  protected:
    virtual int numInitStages() const  {return 4;}
    virtual void initialize(int stage);

    virtual void handleMessage(cMessage *);

    virtual void receiveChangeNotification(int category, const cPolymorphic *details);

  public:
    virtual void printRoutingTable() const;

    virtual void configureInterfaceForIPv4(InterfaceEntry *ie);

    virtual InterfaceEntry *getInterfaceByAddress(const IPAddress& address) const;

    virtual bool isIPForwardingEnabled()  {return IPForward;}

    virtual IPAddress getRouterId()  {return routerId;}

    virtual void setRouterId(IPAddress a)  {routerId = a;}

    virtual bool isLocalAddress(const IPAddress& dest) const;

    virtual const IPRoute *findBestMatchingRoute(const IPAddress& dest) const;

    virtual InterfaceEntry *getInterfaceForDestAddr(const IPAddress& dest) const;

    virtual IPAddress getGatewayForDestAddr(const IPAddress& dest) const;


    virtual bool isLocalMulticastAddress(const IPAddress& dest) const;

    virtual MulticastRoutes getMulticastRoutesFor(const IPAddress& dest) const;


    virtual int getNumRoutes() const;

    virtual const IPRoute *getRoute(int k) const;

    virtual const IPRoute *findRoute(const IPAddress& target, const IPAddress& netmask,
        const IPAddress& gw, int metric = 0, const char *dev = NULL) const;

    virtual const IPRoute *getDefaultRoute() const;

    virtual void addRoute(const IPRoute *entry);

    virtual bool deleteRoute(const IPRoute *entry);

    virtual std::vector<IPAddress> gatherAddresses() const;

};

#endif