//
// Copyright Š 2014 PRISTINE Consortium (http://ict-pristine.eu)
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see http://www.gnu.org/licenses/.
//
/*
* @file DTPState.h
* @author Marcel Marek
* @date Apr 28, 2014
* @brief
* @detail
* EFCPSpec 8.5.2 DTP State - the DTSV
*/
#ifndef DTPSTATE_H_
#define DTPSTATE_H_
#include <cobject.h>
#include <queue>
typedef enum
{
//NULL = 0,
DTP_STATE_ACTIVE = 0x01,
DTP_STATE_PORT_ID_TRANS = 0x10, //Port-id transition
} DTPStateState;
/*
*
*/
class DTPState : public cObject {
private:
/* These parameters can set smaller values of the DTAE constants
* for a given flow. These must have values less than or equal
* those defined for the DIF. */
unsigned int maxFlowSDUSize;
unsigned int maxFlowPDUSize;
unsigned int seqNumRollOverThresh;
int state;
bool dtcpPresent; /*!<a Boolean that indicates whether this connection is using DTCP. */
bool winBased; /*!< a Boolean that indicates whether window-based flow control is in use.*/
bool rateBased; /*!<a Boolean indicates whether rate-based flow control is in use.*/
bool rxPresent; /*!<a Boolean that indicates whether Retransmission Control (potentially with gaps) is in use*/
bool closedWindow; /*!< This Boolean indicates whether or not the flow control window is closed.*/
bool rateFullfilled; //This Boolean indicates that with rate-based flow control all the PDUs that can be sent during this time period have been sent.
unsigned int closedWinQueLen; //The number of PDUs queued to send because the flow control window is shut.
unsigned int maxClosedWinQueLen; /*!<an Integer that the number PDUs that can be put on the ClosedWindowQueue before something must be done.*/
bool partDeliv; /* Partial Delivery of SDUs is Allowed */
bool incompDeliv; /* Delivery of Incomplete SDUs is Allowed */
//queue<PDU,timer>rexmsnQ; //The queue of PDUs that have been handed off to the RMT but not yet acknowledged.
//queue<PDU> closedWinQ; //The queue of PDUs ready to be sent once the window opens.
unsigned int rcvLeftWinEdge;
unsigned int maxSeqNumRcvd;
unsigned int senderLeftWinEdge;
unsigned int nextSeqNumToSend;
//queue<PDU,seqNum> pduReassemblyQ
/* Not in specs */
unsigned int dropDup; //number of dropped duplicates (this variable is not mentioned in specs)
//moved to DTP.h
// queue<unsigned char *> sduQ; //SDUs generated from delimiting
public:
DTPState();
virtual ~DTPState();
void incDropDup(){dropDup++;}
bool isFlowControlPresent(){ return winBased || rateBased;}
bool isClosedWindow() const;
void setClosedWindow(bool closedWindow);
unsigned int getClosedWinQueLen() const;
void setClosedWinQueLen(unsigned int closedWinQueLen);
bool isDtcpPresent() const;
void setDtcpPresent(bool dtcpPresent);
bool isIncompDeliv() const;
void setIncompDeliv(bool incompDeliv);
unsigned int getMaxClosedWinQueLen() const;
void setMaxClosedWinQueLen(unsigned int maxClosedWinQueLen);
unsigned int getMaxFlowPduSize() const;
void setMaxFlowPduSize(unsigned int maxFlowPduSize);
unsigned int getMaxFlowSduSize() const;
void setMaxFlowSduSize(unsigned int maxFlowSduSize);
unsigned int getMaxSeqNumRcvd() const;
void setMaxSeqNumRcvd(unsigned int maxSeqNumRcvd);
void incMaxSeqNumRcvd();
unsigned int getNextSeqNumToSend();
void setNextSeqNumToSend(unsigned int nextSeqNumToSend);
void incNextSeqNumToSend();
bool isPartDeliv() const;
void setPartDeliv(bool partDeliv);
bool isRateBased() const;
void setRateBased(bool rateBased);
bool isRateFullfilled() const;
void setRateFullfilled(bool rateFullfilled);
unsigned int getRcvLeftWinEdge() const;
void setRcvLeftWinEdge(unsigned int rcvLeftWinEdge);
bool isRxPresent() const;
void setRxPresent(bool rxPresent);
unsigned int getSenderLeftWinEdge() const;
void setSenderLeftWinEdge(unsigned int senderLeftWinEdge);
unsigned int getSeqNumRollOverThresh() const;
void setSeqNumRollOverThresh(unsigned int seqNumRollOverThresh);
int getState() const;
void setState(int state);
bool isWinBased() const;
void setWinBased(bool winBased);
};
#endif /* DTPSTATE_H_ */