InterfaceEntry.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_INTERFACEENTRY_H
#define __INET_INTERFACEENTRY_H

#include <vector>
#include <omnetpp.h>
#include "INETDefs.h"
#include "MACAddress.h"
#include "InterfaceToken.h"
#include "NotifierConsts.h"


// Forward declarations. Do NOT #include the corresponding header files
// since that would create dependence on IPv4 and IPv6 stuff!
class IInterfaceTable;
class InterfaceEntry;
class InterfaceProtocolData;
class IPv4InterfaceData;
class IPv6InterfaceData;

class INET_API InterfaceProtocolData : public cPolymorphic
{
    friend class InterfaceEntry; //only this guy is allowed to set ownerp

  protected:
    InterfaceEntry *ownerp;  // the interface entry this object belongs to

  protected:
    // fires notification with the given category, and the interface entry as details
    virtual void changed(int category);

  public:
    InterfaceProtocolData() {ownerp = NULL;}

    InterfaceEntry *getInterfaceEntry() const {return ownerp;}
};


class INET_API InterfaceEntry : public cNamedObject
{
    friend class InterfaceProtocolData; // to call protocolDataChanged()
  protected:
    IInterfaceTable *ownerp; 
    int interfaceId;      
    int nwLayerGateIndex; 
    int nodeOutputGateId; 
    int nodeInputGateId;  
    int peernamid;        
    int mtu;              
    bool down;            
    bool broadcast;       
    bool multicast;       
    bool pointToPoint;    
    bool loopback;        
    double datarate;      
    MACAddress macAddr;   
    InterfaceToken token; 

    IPv4InterfaceData *ipv4data;   
    IPv6InterfaceData *ipv6data;   
    InterfaceProtocolData *protocol3data; 
    InterfaceProtocolData *protocol4data; 

  private:
    // copying not supported: following are private and also left undefined
    InterfaceEntry(const InterfaceEntry& obj);
    InterfaceEntry& operator=(const InterfaceEntry& obj);

  protected:
    // change notifications
    virtual void configChanged() {changed(NF_INTERFACE_CONFIG_CHANGED);}
    virtual void stateChanged() {changed(NF_INTERFACE_STATE_CHANGED);}
    virtual void changed(int category);

  public:
    // internal: to be invoked from InterfaceTable only!
    virtual void setInterfaceTable(IInterfaceTable *t) {ownerp = t;}
    virtual void setInterfaceId(int id) {interfaceId = id;}

  public:
    InterfaceEntry();
    virtual ~InterfaceEntry() {}
    virtual std::string info() const;
    virtual std::string detailedInfo() const;

    IInterfaceTable *getInterfaceTable() const {return ownerp;}

    int getInterfaceId() const        {return interfaceId;}
    int getNetworkLayerGateIndex() const {return nwLayerGateIndex;}
    int getNodeOutputGateId() const   {return nodeOutputGateId;}
    int getNodeInputGateId() const    {return nodeInputGateId;}
    int getPeerNamId() const          {return peernamid;}
    int getMTU() const                {return mtu;}
    bool isDown() const               {return down;}
    bool isBroadcast() const          {return broadcast;}
    bool isMulticast() const          {return multicast;}
    bool isPointToPoint() const       {return pointToPoint;}
    bool isLoopback() const           {return loopback;}
    double getDatarate() const        {return datarate;}
    const MACAddress& getMacAddress() const  {return macAddr;}
    const InterfaceToken& getInterfaceToken() const {return token;}

    virtual void setName(const char *s)  {cNamedObject::setName(s); configChanged();}
    virtual void setNetworkLayerGateIndex(int i) {nwLayerGateIndex = i; configChanged();}
    virtual void setNodeOutputGateId(int i) {nodeOutputGateId = i; configChanged();}
    virtual void setNodeInputGateId(int i)  {nodeInputGateId = i; configChanged();}
    virtual void setPeerNamId(int ni)    {peernamid = ni; configChanged();}
    virtual void setMtu(int m)           {mtu = m; configChanged();}
    virtual void setDown(bool b)         {down = b; stateChanged();}
    virtual void setBroadcast(bool b)    {broadcast = b; configChanged();}
    virtual void setMulticast(bool b)    {multicast = b; configChanged();}
    virtual void setPointToPoint(bool b) {pointToPoint = b; configChanged();}
    virtual void setLoopback(bool b)     {loopback = b; configChanged();}
    virtual void setDatarate(double d)   {datarate = d; configChanged();}
    virtual void setMACAddress(const MACAddress& addr) {macAddr = addr; configChanged();}
    virtual void setInterfaceToken(const InterfaceToken& t) {token = t; configChanged();}

    IPv4InterfaceData *ipv4Data()  {return ipv4data;}
    IPv6InterfaceData *ipv6Data()  {return ipv6data;}
    InterfaceProtocolData *getProtocol3Data()  {return protocol3data;}
    InterfaceProtocolData *getProtocol4Data()  {return protocol4data;}

    virtual void setIPv4Data(IPv4InterfaceData *p);
    virtual void setIPv6Data(IPv6InterfaceData *p);
    virtual void setProtocol3Data(InterfaceProtocolData *p)  {protocol3data = p; configChanged();}
    virtual void setProtocol4Data(InterfaceProtocolData *p)  {protocol4data = p; configChanged();}
};

#endif