RMTQueue.h

Go to the documentation of this file.

// The MIT License (MIT)
//
// Copyright (c) 2014-2016 Brno University of Technology, PRISTINE project
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#ifndef __RINA_RMTQUEUE_H_
#define __RINA_RMTQUEUE_H_

#include <omnetpp.h>
#include <queue>

#include "RINASignals.h"
#include "PDU.h"

#include "Flow.h"

class RMTQueue : public cSimpleModule
{
  /* tight coupling for management purposes */
  friend class RMT;
  friend class RMTPort;
  friend class RMTModuleAllocator;

  public:

    virtual ~RMTQueue();

    enum queueType { INPUT = 'I', OUTPUT = 'O'};

    queueType getType() const;

    int getLength() const;

    simtime_t getQTime() const;

    int getMaxLength() const;

    void setMaxLength(int value);

    int getThreshLength() const;

    void setThreshLength(int value);

    const cPacket* getFirstPDU() const;

    const cPacket* getLastPDU() const;

    typedef std::deque<cPacket*>::iterator iterator;
    typedef std::deque<cPacket*>::const_iterator const_iterator;
    iterator begin() { return queue.begin(); }
    iterator end() { return queue.end(); }

    void releasePDU();

    void markCongestionOnLast();

    std::string info() const;

    void setFlow(Flow *);
    const Flow* getFlow() const;

  protected:
    virtual void initialize();
    virtual void finish();
    virtual void handleMessage(cMessage* msg);

  private:
    std::deque<cPacket*> queue;
    queueType type;

    int maxQLength;
    int thresholdQLength;

    simtime_t qTime;

    cGate* rmtAccessGate;
    cGate* outputGate;
    cGate* inputGate;

    Flow  * flow;

    void setType(queueType type);

    void enqueuePDU(cPacket* pdu);
    cPacket* dropLast();

    cGate* getOutputGate() const;
    cGate* getInputGate() const;
    cGate* getRMTAccessGate() const;
    void setRMTAccessGate(cGate* gate);

    void redrawGUI();

    simsignal_t sigRMTPDUPreRcvd;
    simsignal_t sigRMTPDUPostRcvd;
    simsignal_t sigRMTPDUPreSend;
    simsignal_t sigRMTPDUSent;
    simsignal_t sigStatRMTQueueLength;
};

typedef RMTQueue::queueType RMTQueueType;
typedef std::vector<RMTQueue*>  RMTQueues;

std::ostream& operator<< (std::ostream& os, const RMTQueue& cte);

#endif