InterfaceTable Class Reference

#include <InterfaceTable.h>

Inheritance diagram for InterfaceTable:

List of all members.

---

Detailed Description

Represents the interface table. This object has one instance per host or router. It has methods to manage the interface table, so one can access functionality similar to the "ifconfig" command.

See the NED documentation for general overview.

This is a simple module without gates, it requires function calls to it (message handling does nothing). Methods are provided for reading and updating the interface table.

Interfaces are dynamically registered: at the start of the simulation, every L2 module adds its own InterfaceEntry to the table; after that, IPv4's RoutingTable and IPv6's RoutingTable6 (an possibly, further L3 protocols) add protocol-specific data on each InterfaceEntry (see IPv4InterfaceData, IPv6InterfaceData, and InterfaceEntry::setIPv4Data(), InterfaceEntry::setIPv6Data())

Interfaces are represented by InterfaceEntry objects.

See also:

InterfaceEntry

Public Member Functions
	InterfaceTable ()
virtual	~InterfaceTable ()
virtual void	receiveChangeNotification (int category, cPolymorphic *details)
void	addInterface (InterfaceEntry *entry, cModule *ifmod)
int	numInterfaces ()
InterfaceEntry *	interfaceAt (int pos)
InterfaceEntry *	interfaceByNodeOutputGateId (int id)
InterfaceEntry *	interfaceByNodeInputGateId (int id)
InterfaceEntry *	interfaceByNetworkLayerGateIndex (int index)
InterfaceEntry *	interfaceByName (const char *name)
InterfaceEntry *	firstLoopbackInterface ()
Protected Member Functions
void	updateDisplayString ()
void	discoverConnectingGates (InterfaceEntry *entry, cModule *ifmod)
int	numInitStages () const
void	initialize (int stage)
void	handleMessage (cMessage *)
Private Types
typedef std::vector< InterfaceEntry * >	InterfaceVector
Private Attributes
NotificationBoard *	nb
InterfaceVector	interfaces

---

Member Typedef Documentation

typedef std::vector<InterfaceEntry *> InterfaceTable::InterfaceVector [private]

---

Constructor & Destructor Documentation

InterfaceTable::InterfaceTable (   )

{ }

InterfaceTable::~InterfaceTable (   )  [virtual]

{ for (unsigned int i=0; i<interfaces.size(); i++) delete interfaces[i]; }

---

Member Function Documentation

void InterfaceTable::addInterface (  InterfaceEntry *  entry, cModule *  ifmod )

Adds an interface. The second argument should be a module which belongs to the physical interface (e.g. PPP or EtherMac) -- it will be used to discover and fill in networkLayerGateIndex(), nodeOutputGateId(), and nodeInputGateId() in InterfaceEntry. It should be NULL if this is a virtual interface (e.g. loopback). Note: Interface deletion is not supported, but one can mark one as "down". { // check name is unique if (interfaceByName(entry->name())!=NULL) opp_error("addInterface(): interface '%s' already registered", entry->name()); // insert entry->_interfaceId = interfaces.size(); interfaces.push_back(entry); // fill in networkLayerGateIndex, nodeOutputGateId, nodeInputGateId if (ifmod) discoverConnectingGates(entry, ifmod); }

void InterfaceTable::discoverConnectingGates (  InterfaceEntry *  entry, cModule *  ifmod )  [protected]

{ // ifmod is something like "host.eth[1].mac"; climb up to find "host.eth[1]" from it cModule *host = parentModule(); while (ifmod && ifmod->parentModule()!=host) ifmod = ifmod->parentModule(); if (!ifmod) opp_error("addInterface(): specified module is not in this host/router"); // find gates connected to host / network layer cGate *nwlayerInGate=NULL, *nwlayerOutGate=NULL; for (int i=0; i<ifmod->gates(); i++) { cGate *g = ifmod->gate(i); if (!g) continue; // find the host/router's gates that internally connect to this interface if (g->type()=='O' && g->toGate() && g->toGate()->ownerModule()==host) entry->setNodeOutputGateId(g->toGate()->id()); if (g->type()=='I' && g->fromGate() && g->fromGate()->ownerModule()==host) entry->setNodeInputGateId(g->fromGate()->id()); // find the gate index of networkLayer/networkLayer6/mpls that connects to this interface if (g->type()=='O' && g->toGate() && g->toGate()->isName("ifIn")) nwlayerInGate = g->toGate(); if (g->type()=='I' && g->fromGate() && g->fromGate()->isName("ifOut")) nwlayerOutGate = g->fromGate(); } // consistency checks // note: we don't check nodeOutputGateId/nodeInputGateId, because wireless interfaces // are not connected to the host if (!nwlayerInGate || !nwlayerOutGate || nwlayerInGate->index()!=nwlayerOutGate->index()) opp_error("addInterface(): interface must be connected to network layer's ifIn[]/ifOut[] gates of the same index"); entry->setNetworkLayerGateIndex(nwlayerInGate->index()); }

InterfaceEntry * InterfaceTable::firstLoopbackInterface (   )

Returns the first interface with the isLoopback flag set. (If there's no loopback, it returns NULL -- but this should never happen because InterfaceTable itself registers a loopback interface on startup.) { Enter_Method_Silent(); for (InterfaceVector::iterator i=interfaces.begin(); i!=interfaces.end(); ++i) if ((*i)->isLoopback()) return *i; return NULL; }

void InterfaceTable::handleMessage (  cMessage *   )  [protected]

Raises an error. { opp_error("This module doesn't process messages"); }

void InterfaceTable::initialize (  int  stage  )  [protected]

{ if (stage==0) { // get a pointer to the NotificationBoard module nb = NotificationBoardAccess().get(); // register a loopback interface InterfaceEntry *ie = new InterfaceEntry(); ie->setName("lo0"); ie->setMtu(3924); ie->setLoopback(true); addInterface(ie, NULL); } else if (stage==1) { WATCH_PTRVECTOR(interfaces); updateDisplayString(); } }

InterfaceEntry * InterfaceTable::interfaceAt (  int  pos  )

Returns the InterfaceEntry specified by an index 0..numInterfaces-1. { if (pos==-1) // -1 is commonly used as "none" return NULL; if (pos<0 || pos>=(int)interfaces.size()) opp_error("interfaceAt(): nonexistent interface %d", pos); return interfaces[pos]; }

InterfaceEntry * InterfaceTable::interfaceByName (  const char *  name  )

Returns an interface given by its name. Returns NULL if not found. { Enter_Method_Silent(); if (!name) return NULL; for (InterfaceVector::iterator i=interfaces.begin(); i!=interfaces.end(); ++i) if (!strcmp(name, (*i)->name())) return *i; return NULL; }

InterfaceEntry * InterfaceTable::interfaceByNetworkLayerGateIndex (  int  index  )

Returns an interface given by its networkLayerGateIndex(). Returns NULL if not found. { // linear search is OK because normally we have don't have many interfaces and this func is rarely called Enter_Method_Silent(); for (InterfaceVector::iterator i=interfaces.begin(); i!=interfaces.end(); ++i) if ((*i)->networkLayerGateIndex()==index) return *i; return NULL; }

InterfaceEntry * InterfaceTable::interfaceByNodeInputGateId (  int  id  )

Returns an interface given by its nodeInputGateId(). Returns NULL if not found. { // linear search is OK because normally we have don't have many interfaces and this func is rarely called Enter_Method_Silent(); for (InterfaceVector::iterator i=interfaces.begin(); i!=interfaces.end(); ++i) if ((*i)->nodeInputGateId()==id) return *i; return NULL; }

InterfaceEntry * InterfaceTable::interfaceByNodeOutputGateId (  int  id  )

Returns an interface given by its nodeOutputGateId(). Returns NULL if not found. { // linear search is OK because normally we have don't have many interfaces and this func is rarely called Enter_Method_Silent(); for (InterfaceVector::iterator i=interfaces.begin(); i!=interfaces.end(); ++i) if ((*i)->nodeOutputGateId()==id) return *i; return NULL; }

int InterfaceTable::numInitStages (   )  const [inline, protected]

{return 2;}

int InterfaceTable::numInterfaces (   )  [inline]

Returns the number of interfaces. {return interfaces.size();}

void InterfaceTable::receiveChangeNotification (  int  category, cPolymorphic *  details )  [virtual]

Called by the NotificationBoard whenever a change of a category occurs to which this client has subscribed. Implements INotifiable. { // nothing needed here at the moment }

void InterfaceTable::updateDisplayString (   )  [protected]

{ if (!ev.isGUI()) return; char buf[80]; sprintf(buf, "%d interfaces", interfaces.size()); displayString().setTagArg("t",0,buf); }

---

Member Data Documentation

InterfaceVector InterfaceTable::interfaces [private]

NotificationBoard* InterfaceTable::nb [private]

---

The documentation for this class was generated from the following files:

• InterfaceTable.h
• InterfaceTable.cc

---