cbr-module.h

/* -*-  Mode:C++ -*- */
//
// Copyright (c) 2006 Regents of the SIGNET lab, University of Padova.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the University of Padova (SIGNET lab) nor the 
//    names of its contributors may be used to endorse or promote products 
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
 

#ifndef CBR_MODULE_H
#define CBR_MODULE_H

#include <module.h>

#define CBR_DROP_REASON_UNKNOWN_TYPE "UKT"
#define CBR_DROP_REASON_RECEIVED "RCV"
#define CBR_DROP_REASON_OUT_OF_SEQUENCE "OOS"
#define CBR_DROP_REASON_WRONG_SADDR "WSA"
#define CBR_DROP_REASON_WRONG_SPORT "WSP"
#define CBR_DROP_REASON_EXCEEDED_PLAYOUT "EPB"


#define HDR_CBR(P)      (hdr_cbr::access(P))

extern packet_t PT_MCBR;

typedef struct hdr_cbr {

  double ts;  
  int sn;     
  bool rftt_valid; 
  double rftt;    
  static int offset_;
  inline static int& offset() { return offset_; }
  inline static struct hdr_cbr* access(const Packet* p) {
    return (struct hdr_cbr*)p->access(offset_);
  }
  
} hdr_cbr;


class CbrModule;


class SendTimer : public TimerHandler
{
public:
  SendTimer(CbrModule *m) : TimerHandler() { module = m; }
        
protected:
  virtual void expire(Event *e);
  CbrModule* module;
};


class CbrModule : public Module
{
  friend class SendTimer;

public:

  CbrModule();
  ~CbrModule();         
                
  virtual void recv(Packet*);
  virtual void recv(Packet* p, Handler* h);
  virtual int command(int argc, const char*const* argv);
  virtual int crLayCommand(ClMessage* m);

  virtual double GetRTT();
  virtual double GetFTT();
  virtual double GetFTTpob();


  virtual double GetPER();  
  virtual double GetTHR(); 

  virtual double GetPER_PB();  
    
  virtual double GetRTTstd();
  virtual double GetFTTstd();

  virtual void resetStats(); 


protected:

  static int uidcnt_;  
  nsaddr_t dstPort_;
  nsaddr_t dstAddr_;


  virtual void sendPkt();
  virtual void transmit();

  virtual void initPkt(Packet* p);

  virtual void start();
                

  virtual void stop();

  virtual void updateRTT(double rtt);
  virtual void updateFTT(double ftt);
  virtual void updateThroughput(int bytes, double dt);

  virtual void incrPktLost(int npkts);
  virtual void incrPktRecv();
  virtual void incrPktOoseq();
  virtual void incrPktInvalid();

 virtual void incrPktOutBuff();

  virtual double getTimeBeforeNextPkt();


  double alpha_;      
  int txsn;          
  int hrsn;          
  int pkts_recv;     
  int pkts_ooseq;    
  // playout buffer -------------

  virtual double getMOS(double Pdrop, double delay, double rsource);

 virtual void updateMOS(double Pdrop, double delay, double rsource);
   virtual double GetMOS();
  double addfd_;
  double fd_;

  double cr_;
  double MOS;

  int pob_; // if 1 then playout buffer is used

  double pob_time; // playout buffer delay

  int pkts_opt;     
  double first_pkt_rftt; // reference froward trip time

  int first_pkt_; // first packet

  //----------------------

  int pkts_lost;     
  int pkts_invalid;  
  int pkts_last_reset; 
  double rftt;       
  double srtt;       
  double sftt;       
  double lrtime;       
  double sthr;       
  double period_;      
  int pktSize_;        
  SendTimer sendTmr_;  
 /* Cumulative statistics */

  double sumrtt;       
  double sumrtt2;      
  int rttsamples;      
  double sumftt;       
  double sumftt2;      
  int fttsamples;      
  double sumbytes;
  double sumdt;



  int PoissonTraffic_;  

  
};




#endif /* CBR_MODULE_H */

---