PPP Class Reference

#include <PPP.h>

List of all members.

---

Detailed Description

PPP implementation. Derived from the p-to-p OMNeT++ sample simulation.

Public Member Functions
	PPP ()
virtual	~PPP ()
Protected Member Functions
InterfaceEntry *	registerInterface (double datarate)
void	startTransmitting (cMessage *msg)
PPPFrame *	encapsulate (cMessage *msg)
cMessage *	decapsulate (PPPFrame *pppFrame)
void	displayBusy ()
void	displayIdle ()
void	updateDisplayString ()
virtual int	numInitStages () const
virtual void	initialize (int stage)
virtual void	handleMessage (cMessage *msg)
Protected Attributes
bool	connected
long	txQueueLimit
cGate *	gateToWatch
cQueue	txQueue
cMessage *	endTransmissionEvent
IPassiveQueue *	queueModule
InterfaceEntry *	interfaceEntry
double	datarate
NotificationBoard *	nb
TxNotifDetails	notifDetails
std::string	oldConnColor
long	numSent
long	numRcvdOK
long	numBitErr
long	numDroppedIfaceDown

---

Constructor & Destructor Documentation

PPP::PPP (   )

{ endTransmissionEvent = NULL; }

PPP::~PPP (   )  [virtual]

{ cancelAndDelete(endTransmissionEvent); }

---

Member Function Documentation

cMessage * PPP::decapsulate (  PPPFrame *  pppFrame  )  [protected]

{ cMessage *msg = pppFrame->decapsulate(); delete pppFrame; return msg; }

void PPP::displayBusy (   )  [protected]

{ displayString().setTagArg("i",1, txQueue.length()>=3 ? "red" : "yellow"); gateToWatch->displayString().setTagArg("o",0,"yellow"); gateToWatch->displayString().setTagArg("o",1,"3"); gate("physOut")->displayString().setTagArg("o",0,"yellow"); gate("physOut")->displayString().setTagArg("o",1,"3"); }

void PPP::displayIdle (   )  [protected]

{ displayString().setTagArg("i",1,""); gateToWatch->displayString().setTagArg("o",0,oldConnColor.c_str()); gateToWatch->displayString().setTagArg("o",1,"1"); gate("physOut")->displayString().setTagArg("o",0,"black"); gate("physOut")->displayString().setTagArg("o",1,"1"); }

PPPFrame * PPP::encapsulate (  cMessage *  msg  )  [protected]

{ PPPFrame *pppFrame = new PPPFrame(msg->name()); pppFrame->setByteLength(PPP_OVERHEAD_BYTES); pppFrame->encapsulate(msg); return pppFrame; }

void PPP::handleMessage (  cMessage *  msg  )  [protected, virtual]

{ if (!connected) { EV << "Interface is not connected, dropping packet " << msg << endl; delete msg; numDroppedIfaceDown++; } else if (msg==endTransmissionEvent) { // Transmission finished, we can start next one. EV << "Transmission finished.\n"; if (ev.isGUI()) displayIdle(); // fire notification notifDetails.setMessage(NULL); nb->fireChangeNotification(NF_PP_TX_END, &notifDetails); if (!txQueue.empty()) { msg = (cMessage *) txQueue.getTail(); startTransmitting(msg); numSent++; } else if (queueModule) { // tell queue module that we've become idle queueModule->requestPacket(); } } else if (msg->arrivedOn("physIn")) { // fire notification notifDetails.setMessage(msg); nb->fireChangeNotification(NF_PP_RX_END, &notifDetails); // check for bit errors if (msg->hasBitError()) { EV << "Bit error in " << msg << endl; numBitErr++; delete msg; } else { // pass up payload cMessage *payload = decapsulate(check_and_cast<PPPFrame *>(msg)); numRcvdOK++; send(payload,"netwOut"); } } else // arrived on gate "netwIn" { if (endTransmissionEvent->isScheduled()) { // We are currently busy, so just queue up the packet. EV << "Received " << msg << " for transmission but transmitter busy, queueing.\n"; if (ev.isGUI() && txQueue.length()>=3) displayString().setTagArg("i",1,"red"); if (txQueueLimit && txQueue.length()>txQueueLimit) error("txQueue length exceeds %d -- this is probably due to " "a bogus app model generating excessive traffic " "(or if this is normal, increase txQueueLimit!)", txQueueLimit); txQueue.insert(msg); } else { // We are idle, so we can start transmitting right away. EV << "Received " << msg << " for transmission\n"; startTransmitting(msg); numSent++; } } if (ev.isGUI()) updateDisplayString(); }

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

{ if (stage==3) { // update display string when addresses have been autoconfigured etc. updateDisplayString(); return; } // all initialization is done in the first stage if (stage!=0) return; txQueue.setName("txQueue"); endTransmissionEvent = new cMessage("pppEndTxEvent"); txQueueLimit = par("txQueueLimit"); interfaceEntry = NULL; numSent = numRcvdOK = numBitErr = numDroppedIfaceDown = 0; WATCH(numSent); WATCH(numRcvdOK); WATCH(numBitErr); WATCH(numDroppedIfaceDown); // find queueModule queueModule = NULL; if (par("queueModule").stringValue()[0]) { cModule *mod = parentModule()->submodule(par("queueModule").stringValue()); queueModule = check_and_cast<IPassiveQueue *>(mod); } // we're connected if other end of connection path is an input gate cGate *physOut = gate("physOut"); connected = physOut->destinationGate()->type()=='I'; // if we're connected, get the gate with transmission rate gateToWatch = physOut; datarate = 0; if (connected) { while (gateToWatch) { // does this gate have data rate? cSimpleChannel *chan = dynamic_cast<cSimpleChannel*>(gateToWatch->channel()); if (chan && (datarate=chan->datarate())>0) break; // otherwise just check next connection in path gateToWatch = gateToWatch->toGate(); } if (!gateToWatch) error("gate physOut must be connected (directly or indirectly) to a link with data rate"); } // register our interface entry in InterfaceTable interfaceEntry = registerInterface(datarate); // prepare to fire notifications nb = NotificationBoardAccess().get(); notifDetails.setInterfaceEntry(interfaceEntry); // if not connected, make it gray if (ev.isGUI()) { if (!connected) { displayString().setTagArg("i",1,"#707070"); displayString().setTagArg("i",2,"100"); } oldConnColor = gateToWatch->displayString().getTagArg("o",0); } // request first frame to send if (queueModule) { EV << "Requesting first frame from queue module\n"; queueModule->requestPacket(); } }

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

{return 4;}

InterfaceEntry * PPP::registerInterface (  double  datarate  )  [protected]

{ InterfaceEntry *e = new InterfaceEntry(); // interface name: our module name without special characters ([]) char *interfaceName = new char[strlen(parentModule()->fullName())+1]; char *d=interfaceName; for (const char *s=parentModule()->fullName(); *s; s++) if (isalnum(*s)) *d++ = *s; *d = '\0'; e->setName(interfaceName); delete [] interfaceName; // data rate e->setDatarate(datarate); // generate a link-layer address to be used as interface token for IPv6 InterfaceToken token(0, simulation.getUniqueNumber(), 64); e->setInterfaceToken(token); // MTU: typical values are 576 (Internet de facto), 1500 (Ethernet-friendly), // 4000 (on some point-to-point links), 4470 (Cisco routers default, FDDI compatible) e->setMtu(4470); // capabilities e->setMulticast(true); e->setPointToPoint(true); // add InterfaceTable *ift = InterfaceTableAccess().get(); ift->addInterface(e, this); return e; }

void PPP::startTransmitting (  cMessage *  msg  )  [protected]

{ // if there's any control info, remove it; then encapsulate the packet delete msg->removeControlInfo(); PPPFrame *pppFrame = encapsulate(msg); if (ev.isGUI()) displayBusy(); // fire notification notifDetails.setMessage(pppFrame); nb->fireChangeNotification(NF_PP_TX_BEGIN, &notifDetails); // send EV << "Starting transmission of " << pppFrame << endl; send(pppFrame, "physOut"); // schedule an event for the time when last bit will leave the gate. simtime_t endTransmission = gateToWatch->transmissionFinishes(); scheduleAt(endTransmission, endTransmissionEvent); }

void PPP::updateDisplayString (   )  [protected]

{ char buf[80]; if (ev.disabled()) { // speed up things displayString().setTagArg("t",0,""); } else if (connected) { char drate[40]; if (datarate>=1e9) sprintf(drate,"%gG", datarate/1e9); else if (datarate>=1e6) sprintf(drate,"%gM", datarate/1e6); else if (datarate>=1e3) sprintf(drate,"%gK", datarate/1e3); else sprintf(drate,"%gbps", datarate); /* TBD FIXME find solution for displaying IP address without dependence on IPv6 or IPv6 IPAddress addr = interfaceEntry->ipv4()->inetAddress(); sprintf(buf, "%s / %s\nrcv:%ld snt:%ld", addr.isUnspecified()?"-":addr.str().c_str(), drate, numRcvdOK, numSent); */ sprintf(buf, "%s\nrcv:%ld snt:%ld", drate, numRcvdOK, numSent); if (numBitErr>0) sprintf(buf+strlen(buf), "\nerr:%ld", numBitErr); displayString().setTagArg("t",0,buf); } else { sprintf(buf, "not connected\ndropped:%ld", numDroppedIfaceDown); displayString().setTagArg("t",0,buf); } }

---

Member Data Documentation

bool PPP::connected [protected]

double PPP::datarate [protected]

cMessage* PPP::endTransmissionEvent [protected]

cGate* PPP::gateToWatch [protected]

InterfaceEntry* PPP::interfaceEntry [protected]

NotificationBoard* PPP::nb [protected]

TxNotifDetails PPP::notifDetails [protected]

long PPP::numBitErr [protected]

long PPP::numDroppedIfaceDown [protected]

long PPP::numRcvdOK [protected]

long PPP::numSent [protected]

std::string PPP::oldConnColor [protected]

IPassiveQueue* PPP::queueModule [protected]

cQueue PPP::txQueue [protected]

long PPP::txQueueLimit [protected]

---

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

• PPP.h
• PPP.cc

---