Flow.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 FLOW_H_
#define FLOW_H_

//Standard libraries
#include <string>
#include <sstream>
//RINASim libraries
#include "APNamingInfo.h"
#include "ConnectionId.h"
#include "Address.h"
#include "QoSReq.h"

extern const int VAL_UNDEF_PORTID;
extern const int VAL_MGMT_PORTID;
extern const int VAL_MAXHOPCOUNT;
extern const int VAL_MAXCREATERETRIES;

class Flow : public cObject
{
  public:
    Flow();

    Flow(APNamingInfo src, APNamingInfo dst);

    virtual ~Flow();

    bool operator== (const Flow& other) const;

    bool compare(const Flow& other) const;

    virtual Flow* dup() const;

    Flow* dupToMgmt() const;

    //Various string output functions
    std::string info() const;

    std::string infoSource() const;

    std::string infoDestination() const;

    std::string infoOther() const;

    std::string infoQoS() const;

    std::string getFlowName() const;

    Flow& swapFlow();

    ConnectionId& getConnectionId();

    const ConnectionId& getConId() const;

    void setConId(const ConnectionId& conId);


    void setQosCube(const QoSCube& qosCube);

    const QoSCube& getQosCube() const;

    const QoSReq& getQosRequirements() const;

    QoSReq& getQosReqs();

    void setQosRequirements(const QoSReq& qosReqs);

    const APNamingInfo& getSrcApni() const;

    void setSrcApni(const APNamingInfo& srcApni);

    const APNamingInfo& getDstApni() const;

    void setDstApni(const APNamingInfo& dstApni);

    int getSrcPortId() const;

    void setSrcPortId(int srcPortId);

    int getDstPortId() const;

    void setDstPortId(int dstPortId);

    uint32_t getCreateFlowRetries() const;

    void setCreateFlowRetries(uint32_t createFlowRetries);

    uint32_t getMaxCreateFlowRetries() const;

    void setMaxCreateFlowRetries(uint32_t maxCreateFlowRetries);

    uint32_t getHopCount() const;

    void setHopCount(uint32_t hopCount);

    const Address& getSrcAddr() const;

    void setSrcAddr(const Address& srcAddr);

    const Address& getDstAddr() const;

    void setDstAddr(const Address& dstAddr);

    //TODO: Vesely - Pull addresses to new Flow child class

    const Address& getSrcNeighbor() const;

    void setSrcNeighbor(const Address& srcNeighbor);

    const Address& getDstNeighbor() const;

    void setDstNeighbor(const Address& dstNeighbor);

    long getAllocInvokeId() const;

    void setAllocInvokeId(long allocInvokeId);

    long getDeallocInvokeId() const;

    void setDeallocInvokeId(long deallocInvokeId);

    bool isDdtFlag() const;

    void setDdtFlag(bool ddtFlag);

    bool isManagementFlow() const;

    bool isManagementFlowLocalToIPCP() const;

  protected:
    //Properties are based on RINA-Demo-2012-001.pdf page 6

    APNamingInfo srcApni;

    APNamingInfo dstApni;

    int srcPortId;

    int dstPortId;

    Address srcAddr;

    Address dstAddr;

    Address srcNeighbor;

    Address dstNeighbor;

    ConnectionId conId;

    uint32_t createFlowRetries;

    uint32_t maxCreateFlowRetries;

    uint32_t hopCount;


    QoSCube qosCube;

    QoSReq qosReqs;

    long allocInvokeId;

    long deallocInvokeId;

    bool ddtFlag;

    void swapPortIds();

    void swapAddresses();

    void swapCepIds();

    void swapApni();


};


//Free function
std::ostream& operator<< (std::ostream& os, const Flow& fl);

#endif /* FLOW_H_ */