InterfaceTable.h

Go to the documentation of this file.

//
// Copyright (C) 2005 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.1 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_INTERFACETABLE_H
#define __INET_INTERFACETABLE_H

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


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

    // primary storage for interfaces: vector indexed by id; may contain NULLs;
    // slots are never reused to ensure id uniqueness
    typedef std::vector<InterfaceEntry *> InterfaceVector;
    InterfaceVector idToInterface;

    // fields to support getNumInterfaces() and getInterface(pos)
    int tmpNumInterfaces; // caches number of non-NULL elements of idToInterface; -1 if invalid
    InterfaceEntry **tmpInterfaceList; // caches non-NULL elements of idToInterface; NULL if invalid

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

    // discover and store which nwlayer/host gates connect to this interface
    virtual void discoverConnectingGates(InterfaceEntry *entry, cModule *ifmod);

    // called from InterfaceEntry
    virtual void interfaceChanged(InterfaceEntry *entry, int category);

    // internal
    virtual void invalidateTmpInterfaceList();

  public:
    InterfaceTable();
    virtual ~InterfaceTable();
    virtual std::string getFullPath() const {return cSimpleModule::getFullPath();}

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

    virtual void handleMessage(cMessage *);

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

    virtual void addInterface(InterfaceEntry *entry, cModule *ifmod);

    virtual void deleteInterface(InterfaceEntry *entry);

    virtual int getNumInterfaces();

    virtual InterfaceEntry *getInterface(int pos);

    virtual InterfaceEntry *getInterfaceById(int id);

    virtual InterfaceEntry *getInterfaceByNodeOutputGateId(int id);

    virtual InterfaceEntry *getInterfaceByNodeInputGateId(int id);

    virtual InterfaceEntry *getInterfaceByNetworkLayerGateIndex(int index);

    virtual InterfaceEntry *getInterfaceByName(const char *name);

    virtual InterfaceEntry *getFirstLoopbackInterface();
};

#endif