RMTPort.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_RMTPORT_H_
#define __RINA_RMTPORT_H_

#include <omnetpp.h>
#include <algorithm>

#include "Utils.h"
#include "RINASignals.h"
#include "Flow.h"
#include "RMTQueue.h"
#include "QueueIDGenBase.h"
#include "SDUData_m.h"

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

  public:

    bool isOutputReady();

    bool isInputReady();

    void blockOutput();

    void unblockOutput();

    void blockInput();

    void unblockInput();

    bool hasBlockedInput() { return blockedInput; };

    /*
     * Returns the input drain speed of this port.
     */
    long getInputRate();

    /*
     * Sets the input drain speed of this port.
     */
    void setInputRate(long pdusPerSecond);

    const Flow* getFlow() const;

    RMTQueue* getFirstQueue(RMTQueueType type) const;

    RMTQueue* getLongestQueue(RMTQueueType type) const;

    RMTQueue* getQueueById(RMTQueueType type, const char* queueId) const;

    RMTQueues& getInputQueues();

    RMTQueues& getOutputQueues();

    unsigned long getWaiting(RMTQueueType direction);

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

    void addWaiting(RMTQueueType direction);

    void substractWaiting(RMTQueueType direction);

  private:
    bool inputReady;
    bool outputReady;
    bool blockedInput;
    bool blockedOutput;
    unsigned long waitingOnInput;
    unsigned long waitingOnOutput;
    long inputReadRate;
    double postReadDelay;
    std::string dstAppAddr;
    std::string dstAppQoS;

    Flow* flow;
    QueueIDGenBase* queueIdGen;

    std::set<cGate*> northInputGates;
    cGate* southInputGate;
    cGate* southOutputGate;
    cGate* protectIn;
    cGate* protectOut;
    cGate* unprotectIn;
    cGate* unprotectOut;
    cChannel* outputChannel;

    RMTQueues outputQueues;
    RMTQueues inputQueues;

    void setOutputReady();

    void setOutputBusy();

    void setInputReady();

    void setInputBusy();

    void postInitialize();
    void setFlow(Flow* flow);
    void registerInputQueue(RMTQueue* queue);
    void registerOutputQueue(RMTQueue* queue);
    void unregisterInputQueue(RMTQueue* queue);
    void unregisterOutputQueue(RMTQueue* queue);
    cGate* getSouthInputGate() const;
    cGate* getSouthOutputGate() const;

    void scheduleNextRead();
    void scheduleNextWrite();
    void redrawGUI(bool redrawParent = false);

    simsignal_t sigRMTPortReadyForRead;
    simsignal_t sigRMTPortReadyToWrite;
    simsignal_t sigStatRMTPortUp;
    simsignal_t sigStatRMTPortDown;
};

typedef std::vector<RMTPort*> RMTPorts;

#endif