TCPBaseAlg.h

Go to the documentation of this file.

//
// Copyright (C) 2004 Andras Varga
// Copyright (C) 2009-2010 Thomas Reschka
//
// 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 2
// 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/>.
//

#ifndef __INET_TCPBASEALG_H
#define __INET_TCPBASEALG_H

#include <omnetpp.h>
#include "TCPAlgorithm.h"


class INET_API TCPBaseAlgStateVariables : public TCPStateVariables
{
  public:
    TCPBaseAlgStateVariables();
    virtual std::string info() const;
    virtual std::string detailedInfo() const;


    int rexmit_count;         
    simtime_t rexmit_timeout; 



    uint persist_factor;       
    simtime_t persist_timeout; 



    uint32 snd_cwnd;            



    uint32 rtseq;             
    simtime_t rtseq_sendtime; 



    simtime_t srtt;          
    simtime_t rttvar;        



    uint32 numRtos;          



    uint32 recover;            
    bool firstPartialACK;      

};


class INET_API TCPBaseAlg : public TCPAlgorithm
{
  protected:
    TCPBaseAlgStateVariables *&state; // alias to TCPAlgorithm's 'state'

    cMessage *rexmitTimer;
    cMessage *persistTimer;
    cMessage *delayedAckTimer;
    cMessage *keepAliveTimer;

    cOutVector *cwndVector;  // will record changes to snd_cwnd
    cOutVector *ssthreshVector; // will record changes to ssthresh
    cOutVector *rttVector;   // will record measured RTT
    cOutVector *srttVector;  // will record smoothed RTT
    cOutVector *rttvarVector;// will record RTT variance (rttvar)
    cOutVector *rtoVector;   // will record retransmission timeout
    cOutVector *numRtosVector; // will record total number of RTOs

  protected:
    virtual void processRexmitTimer(TCPEventCode& event);
    virtual void processPersistTimer(TCPEventCode& event);
    virtual void processDelayedAckTimer(TCPEventCode& event);
    virtual void processKeepAliveTimer(TCPEventCode& event);

    virtual void startRexmitTimer();

    virtual void rttMeasurementComplete(simtime_t tSent, simtime_t tAcked);

    virtual void rttMeasurementCompleteUsingTS(uint32 echoedTS);

    virtual bool sendData();

    cMessage *cancelEvent(cMessage *msg) {return conn->getTcpMain()->cancelEvent(msg);}

  public:
    TCPBaseAlg();

    virtual ~TCPBaseAlg();

    virtual void initialize();

    virtual void established(bool active);

    virtual void connectionClosed();

    virtual void processTimer(cMessage *timer, TCPEventCode& event);

    virtual void sendCommandInvoked();

    virtual void receivedOutOfOrderSegment();

    virtual void receiveSeqChanged();

    virtual void receivedDataAck(uint32 firstSeqAcked);

    virtual void receivedDuplicateAck();

    virtual void receivedAckForDataNotYetSent(uint32 seq);

    virtual void ackSent();

    virtual void dataSent(uint32 fromseq);

    virtual void restartRexmitTimer();
};

#endif