csimplemodule.h Source File¶

82struct SIM_API SendOptions {

83 simtime_t sendDelay = SIMTIME_ZERO; // for after()

84 simtime_t propagationDelay_ = SIMTIME_ZERO; // for sendDirect()

85 simtime_t duration_ = DURATION_UNSPEC; // for packets not using channel datarate

86 bool isUpdate = false;

87 txid_t transmissionId_ = -1; // if not -1, specifies the transmission id

88 simtime_t remainingDuration = DURATION_UNSPEC; // when updating an earlier transmission

89

90 static const simtime_t DURATION_UNSPEC;

91 static const SendOptions DEFAULT;

96 SendOptions() {}

108 SendOptions& after(simtime_t delay) {this->sendDelay = delay; return *this;}

114 SendOptions& propagationDelay(simtime_t delay) {this->propagationDelay_ = delay; return *this;}

124 SendOptions& duration(simtime_t duration) {this->duration_ = duration; return *this;}

133 SendOptions& transmissionId(txid_t transmissionId) {this->transmissionId_ = transmissionId; return *this;}

142 SendOptions& finishTx(txid_t transmissionId) {this->isUpdate = true; this->transmissionId_ = transmissionId; remainingDuration = SIMTIME_ZERO; return *this;}

151 SendOptions& updateTx(txid_t transmissionId) {this->isUpdate = true; this->transmissionId_ = transmissionId; remainingDuration = DURATION_UNSPEC; return *this;}

158 SendOptions& updateTx(txid_t transmissionId, simtime_t remainingDuration) {this->isUpdate = true; this->transmissionId_ = transmissionId; this->remainingDuration = remainingDuration; return *this;}

163 std::string str() const;

164};

202class SIM_API cSimpleModule : public cModule //implies noncopyable

203{

204 friend class cModule;

205 friend class cSimulation;

206 friend class cMessage;

207

208 private:

209 enum {

210 FL_USESACTIVITY = 1 << 13, // uses activity() or handleMessage()

211 FL_ISTERMINATED = 1 << 14, // for both activity and handleMessage modules

212 FL_STACKALREADYUNWOUND = 1 << 15, // only for activity modules

213 FL_SUPPORTSTXUPDATES = 1 << 16, // whether module is prepared to receive tx updates (see SendOptions)

214 };

215

216 cMessage *timeoutMessage; // msg used in wait() and receive() with timeout

217 cCoroutine *coroutine;

218

219 static cMessage *msgForActivity; // helper variable to pass the received message into activity()

220 static bool stackCleanupRequested; // 'true' value asks activity() to throw a cStackCleanupException

221 static cSimpleModule *afterCleanupTransferTo; // transfer back to this module (or to main)

222

223 private:

224 // internal use

225 static void activate(void *p);

226

227 // internal utility methods

228 cGate *resolveSendDirectGate(cModule *mod, int gateId);

229 cGate *resolveSendDirectGate(cModule *mod, const char *gateName, int gateIndex);

230 static SendOptions resolveSendDirectOptions(simtime_t propagationDelay, simtime_t duration);

231 void deleteObsoletedTransmissionFromFES(txid_t transmissionId, cPacket *updatePkt);

232 void throwNotOwnerOfMessage(const char *sendOp, cMessage *msg);

233

234 protected:

235 // internal: handle a message event, basically dispatch to handleMessage() or activity(); not supposed to be overridden by models

236 virtual void doMessageEvent(cMessage *msg);

237

238 protected:

255 virtual void activity();

261 virtual void handleMessage(cMessage *msg);

263

264 public:

273 cSimpleModule(unsigned stacksize = 0);

279 virtual ~cSimpleModule();

288 virtual std::string str() const override;

293 virtual bool isSimple() const override;

299 virtual void forEachChild(cVisitor *v) override;

308 virtual void scheduleStart(simtime_t t) override;

315 virtual void arrived(cMessage *msg, cGate *ongate, const SendOptions& options, simtime_t t) override;

324 bool usesActivity() const {return flags&FL_USESACTIVITY;}

341 void setTxUpdateSupport(bool b) {setFlag(FL_SUPPORTSTXUPDATES, b);}

348 bool supportsTxUpdates() const {return flags&FL_SUPPORTSTXUPDATES;}

354 bool isTerminated() const {return flags&FL_ISTERMINATED;}

375 virtual void snapshot(cObject *obj=nullptr, const char *label=nullptr);

384 virtual void send(cMessage *msg, int gateid) {send(msg, gate(gateid));}

390 virtual void send(cMessage *msg, const char *gatename, int gateindex=-1) {send(msg, gate(gatename, gateindex));}

395 virtual void send(cMessage *msg, cGate *outputgate) {send(msg, SendOptions::DEFAULT, outputgate);}

400 virtual void send(cMessage *msg, const SendOptions& options, int gateid) {send(msg, options, gate(gateid));}

406 virtual void send(cMessage *msg, const SendOptions& options, const char *gatename, int gateindex=-1) {send(msg, options, gate(gatename, gateindex));}

411 virtual void send(cMessage *msg, const SendOptions& options, cGate *outputgate);

416 virtual void sendDelayed(cMessage *msg, simtime_t delay, int gateid) {send(msg, SendOptions().after(delay), gate(gateid));}

421 virtual void sendDelayed(cMessage *msg, simtime_t delay, const char *gatename, int gateindex=-1) {send(msg, SendOptions().after(delay), gate(gatename, gateindex));}

426 virtual void sendDelayed(cMessage *msg, simtime_t delay, cGate *outputgate) {send(msg, SendOptions().after(delay), outputgate);}

433 virtual void sendDirect(cMessage *msg, cModule *mod, const char *inputGateName, int gateIndex=-1) {sendDirect(msg, SendOptions::DEFAULT, resolveSendDirectGate(mod, inputGateName, gateIndex));}

440 virtual void sendDirect(cMessage *msg, cModule *mod, int inputGateId) {sendDirect(msg, SendOptions::DEFAULT, resolveSendDirectGate(mod, inputGateId));}

447 virtual void sendDirect(cMessage *msg, cGate *inputGate) {sendDirect(msg, SendOptions::DEFAULT, inputGate);}

454 virtual void sendDirect(cMessage *msg, const SendOptions& options, cModule *mod, const char *inputGateName, int gateIndex=-1) {sendDirect(msg, options, resolveSendDirectGate(mod, inputGateName, gateIndex));}

461 virtual void sendDirect(cMessage *msg, const SendOptions& options, cModule *mod, int inputGateId) {sendDirect(msg, options, resolveSendDirectGate(mod, inputGateId));}

485 virtual void sendDirect(cMessage *msg, const SendOptions& options, cGate *inputGate);

490 virtual void sendDirect(cMessage *msg, simtime_t propagationDelay, simtime_t duration, cModule *mod, const char *inputGateName, int gateIndex=-1) {sendDirect(msg, resolveSendDirectOptions(propagationDelay, duration), resolveSendDirectGate(mod, inputGateName, gateIndex));}

495 virtual void sendDirect(cMessage *msg, simtime_t propagationDelay, simtime_t duration, cModule *mod, int inputGateId) {sendDirect(msg, resolveSendDirectOptions(propagationDelay, duration), resolveSendDirectGate(mod, inputGateId));}

500 virtual void sendDirect(cMessage *msg, simtime_t propagationDelay, simtime_t duration, cGate *inputGate) {sendDirect(msg, resolveSendDirectOptions(propagationDelay, duration), inputGate);}

534 virtual void scheduleAt(simtime_t t, cMessage *msg);

543 virtual void scheduleAfter(simtime_t delay, cMessage *msg);

552 virtual void rescheduleAt(simtime_t t, cMessage *msg);

561 virtual void rescheduleAfter(simtime_t delay, cMessage *msg);

569 virtual cMessage *cancelEvent(cMessage *msg);

577 virtual void cancelAndDelete(cMessage *msg);

590 virtual cMessage *receive();

599 virtual cMessage *receive(simtime_t timeout);

618 virtual void wait(simtime_t time);

627 virtual void waitAndEnqueue(simtime_t time, cQueue *queue);

636 virtual void endSimulation();

643 virtual void halt();

648 _OPP_GNU_ATTRIBUTE(format(printf, 2, 3))

649 virtual void error(const char *format,...) const;

663 virtual bool hasStackOverflow() const;

669 virtual unsigned getStackSize() const;

679 virtual unsigned getStackUsage() const;

681};