NAMTraceWriter Class Reference

#include <NAMTraceWriter.h>

Inheritance diagram for NAMTraceWriter:

List of all members.

---

Detailed Description

Writes a "nam" trace.

Protected Member Functions
void	recordNodeEvent (char *state, char *shape)
void	recordLinkEvent (int peernamid, double datarate, double delay, char *state)
void	recordLinkEvent (InterfaceEntry *ie, char *state)
void	recordPacketEvent (const char event, int peernamid, cMessage *msg)
virtual int	numInitStages () const
virtual void	initialize (int stage)
virtual void	finish ()
virtual void	receiveChangeNotification (int category, cPolymorphic *details)
Protected Attributes
int	namid
NAMTrace *	nt

---

Member Function Documentation

void NAMTraceWriter::finish (   )  [protected, virtual]

{ if (nt && nt->enabled()) { recordNodeEvent("DOWN", "circle"); } }

void NAMTraceWriter::initialize (  int  stage  )  [protected, virtual]

{ if (stage==1) // let NAMTrace module initialize in stage 0 { // get pointer to the NAMTrace module cModule *namMod = simulation.moduleByPath("nam"); if (!namMod) { nt = NULL; EV << "NAMTraceWriter: nam module not found, no trace will be written\n"; return; } // store ptr to namtrace module nt = check_and_cast<NAMTrace*>(namMod); // register given namid; -1 means autoconfigure int namid0 = par("namid"); cModule *node = parentModule(); // the host or router namid = nt->assignNamId(node, namid0); if (namid0==-1) par("namid") = namid; // let parameter reflect autoconfigured namid // write "node" entry to the trace if (nt->enabled()) recordNodeEvent("UP", "circle"); // subscribe to the interesting notifications NotificationBoard *nb = NotificationBoardAccess().get(); nb->subscribe(this, NF_NODE_FAILURE); nb->subscribe(this, NF_NODE_RECOVERY); nb->subscribe(this, NF_PP_TX_BEGIN); nb->subscribe(this, NF_PP_RX_END); nb->subscribe(this, NF_L2_Q_DROP); } else if (stage==2 && nt!=NULL && nt->enabled()) { // write "link" entries InterfaceTable *ift = InterfaceTableAccess().get(); cModule *node = parentModule(); // the host or router for (int i=0; i<ift->numInterfaces(); i++) { // skip loopback interfaces InterfaceEntry *ie = ift->interfaceAt(i); if (ie->isLoopback()) continue; if (!ie->isPointToPoint()) continue; // consider pont-to-point links only // fill in peerNamIds in InterfaceEntries cGate *outgate = node->gate(ie->nodeOutputGateId()); if (!outgate || !outgate->toGate()) continue; cModule *peernode = outgate->toGate()->ownerModule(); // FIXME not entirely correct: what if a subnet is "boxed"? cModule *peerwriter = peernode->submodule("namTrace"); if (!peerwriter) error("module %s doesn't have a submodule named namTrace", peernode->fullPath().c_str()); int peernamid = peerwriter->par("namid"); ie->setPeerNamId(peernamid); // find delay double delay = 0; cSimpleChannel *chan = dynamic_cast<cSimpleChannel*>(outgate->channel()); if (chan) delay = chan->delay(); // write link entry into trace recordLinkEvent(peernamid, ie->datarate(), delay, "UP"); } } }

virtual int NAMTraceWriter::numInitStages (   )  const [inline, protected, virtual]

{return 3;}

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

Redefined INotifiable method. Called by NotificationBoard on changes. Implements INotifiable. { // don't do anything if global NAMTrace module doesn't exist or does not have a file open if (!nt || !nt->enabled()) return; // process notification if (category==NF_PP_TX_BEGIN || category==NF_PP_RX_END || category==NF_L2_Q_DROP) { TxNotifDetails *d = check_and_cast<TxNotifDetails *>(details); int peernamid = d->interfaceEntry()->peerNamId(); cMessage *msg = d->message(); switch(category) { case NF_PP_TX_BEGIN: recordPacketEvent('h', peernamid, msg); break; case NF_PP_RX_END: recordPacketEvent('r', peernamid, msg); break; case NF_L2_Q_DROP: recordPacketEvent('d', peernamid, msg); break; } } else { switch(category) { case NF_NODE_FAILURE: break; // TODO case NF_NODE_RECOVERY: break; // TODO } } }

void NAMTraceWriter::recordLinkEvent (  InterfaceEntry *  ie, char *  state )  [protected]

void NAMTraceWriter::recordLinkEvent (  int  peernamid, double  datarate, double  delay, char *  state )  [protected]

{ ASSERT(nt && nt->enabled()); std::ostream& out = nt->out(); // link entry (to be registered ON ONE END ONLY! This also means that // ns2 thinks that datarate and delay must be the same in both directions) if (namid < peernamid) out << "l -t * -s " << namid << " -d " << peernamid << " -S " << state << " -r " << (int)datarate << " -D " << delay << endl; // queue entry out << "q -t * -s " << namid << " -d " << peernamid << " -a 0 " << endl; }

void NAMTraceWriter::recordNodeEvent (  char *  state, char *  shape )  [protected]

{ ASSERT(nt && nt->enabled()); std::ostream& out = nt->out(); out << "n -t "; if (simTime() == 0.0) out << "*"; else out << simTime(); out << " -s " << namid << " -a " << namid << " -S " << state << " -v " << shape << endl; }

void NAMTraceWriter::recordPacketEvent (  const char  event, int  peernamid, cMessage *  msg )  [protected]

{ ASSERT(nt && nt->enabled()); std::ostream& out = nt->out(); int size = msg->byteLength(); int color = 0; for (cMessage *em = msg; em; em = em->encapsulatedMsg()) if (em->hasPar("color")) {color = em->par("color").longValue(); break;} out << event << " -t " << simTime(); if (event=='h') out << " -s " << namid << " -d " << peernamid; else out << " -s " << peernamid << " -d " << namid; out << " -e " << size << " -a " << color << endl; }

---

Member Data Documentation

int NAMTraceWriter::namid [protected]

NAMTrace* NAMTraceWriter::nt [protected]

---

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

• NAMTraceWriter.h
• NAMTraceWriter.cc

---