cnullmessageprot.h

//=========================================================================
//  CNULLMESSAGEPROT.H - part of
//
//                  OMNeT++/OMNEST
//           Discrete System Simulation in C++
//
//  Author: Andras Varga, 2003
//          Dept. of Electrical and Computer Systems Engineering,
//          Monash University, Melbourne, Australia
//
//=========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 2003-2017 Andras Varga
  Copyright (C) 2006-2017 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __OMNETPP_CNULLMESSAGEPROT_H
#define __OMNETPP_CNULLMESSAGEPROT_H

#include "omnetpp/cmessage.h"  // MK_PARSIM_BEGIN
#include "cparsimprotocolbase.h"

namespace omnetpp {

class cCommBuffer;
class cNMPLookahead;


class SIM_API cNullMessageProtocol : public cParsimProtocolBase
{
  protected:
    struct PartitionInfo
    {
        cMessage *eitEvent;  // EIT received from partition
        cMessage *eotEvent;  // events which marks that a null message should be sent out
        simtime_t lastEotSent; // last EOT value that was sent
    };

    // partition information
    int numSeg;              // number of partitions
    PartitionInfo *segInfo;  // partition info array, size numSeg

    // controls null message resend frequency, 0<=laziness<=1
    double laziness;

    // internally used message kinds
    enum
    {
        MK_PARSIM_EIT =       MK_PARSIM_BEGIN - 1,
        MK_PARSIM_RESENDEOT = MK_PARSIM_BEGIN - 2
    };

    bool debug;

    cNMPLookahead *lookaheadcalc;

  protected:
    // process buffers coming from other partitions
    virtual void processReceivedBuffer(cCommBuffer *buffer, int tag, int sourceProcId) override;

    // processes a received EIT: reschedule partition's EIT message
    virtual void processReceivedEIT(int sourceProcId, simtime_t eit);

    // resend null message to this partition
    virtual void sendNullMessage(int procId, simtime_t now);

    // reschedule event in FES, to the given time
    virtual void rescheduleEvent(cMessage *msg, simtime_t t);

  public:
    cNullMessageProtocol();

    virtual ~cNullMessageProtocol();

    virtual void setContext(cSimulation *sim, cParsimPartition *seg, cParsimCommunications *co) override;

    void setLaziness(double d)  {laziness = d;}

    double getLaziness()  {return laziness;}

    virtual void startRun() override;

    virtual void endRun() override;

    virtual cEvent *takeNextEvent() override;

    virtual void putBackEvent(cEvent *event) override;

    virtual void processOutgoingMessage(cMessage *msg, int procId, int moduleId, int gateId, void *data) override;
};

}  // namespace omnetpp


#endif