IRoutingTable.h

Go to the documentation of this file.

//
// Copyright (C) 2008 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/>.
//

#ifndef __INET_IROUTINGTABLE_H
#define __INET_IROUTINGTABLE_H

#include <vector>
#include <omnetpp.h>
#include "INETDefs.h"
#include "IPAddress.h"
#include "IPRoute.h"  // not strictly required, but most clients will need it anyway


struct MulticastRoute
{
    InterfaceEntry *interf;
    IPAddress gateway;
};
typedef std::vector<MulticastRoute> MulticastRoutes;


class INET_API IRoutingTable
{
  public:
    virtual ~IRoutingTable() {};

    virtual void printRoutingTable() const = 0;

    virtual void configureInterfaceForIPv4(InterfaceEntry *ie) = 0;

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

    virtual bool isIPForwardingEnabled() = 0;

    virtual IPAddress getRouterId() = 0;

    virtual void setRouterId(IPAddress a) = 0;

    virtual bool isLocalAddress(const IPAddress& dest) const = 0;

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

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

    virtual IPAddress getGatewayForDestAddr(const IPAddress& dest) const = 0;


    virtual bool isLocalMulticastAddress(const IPAddress& dest) const = 0;

    virtual MulticastRoutes getMulticastRoutesFor(const IPAddress& dest) const = 0;


    virtual int getNumRoutes() const = 0;

    virtual const IPRoute *getRoute(int k) const = 0;

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

    virtual const IPRoute *getDefaultRoute() const = 0;

    virtual void addRoute(const IPRoute *entry) = 0;

    virtual bool deleteRoute(const IPRoute *entry) = 0;

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

};

#endif