uan-header-rc.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 University of Washington
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Leonard Tracy <lentracy@gmail.com>
 */


#ifndef UAN_HEADER_RC_H
#define UAN_HEADER_RC_H

#include "ns3/header.h"
#include "ns3/nstime.h"
#include "ns3/mac8-address.h"

#include <set>

namespace ns3 {

class UanHeaderRcData : public Header
{
public:
  UanHeaderRcData ();
  UanHeaderRcData (uint8_t frameNum, Time propDelay);
  virtual ~UanHeaderRcData ();

  static TypeId GetTypeId (void);

  void SetFrameNo (uint8_t frameNum);
  void SetPropDelay (Time propDelay);
  uint8_t GetFrameNo (void) const;
  Time GetPropDelay (void) const;
  void Print (std::ostream &os, Time::Unit unit) const;

  // Inherrited methods
  virtual uint32_t GetSerializedSize (void) const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual void Print (std::ostream &os) const;
  virtual TypeId GetInstanceTypeId (void) const;

private:
  uint8_t m_frameNo;  
  Time m_propDelay;   

};  // class UanHeaderRcData

class UanHeaderRcRts : public Header
{
public:
  UanHeaderRcRts ();
  UanHeaderRcRts (uint8_t frameNo, uint8_t retryNo, uint8_t noFrames, uint16_t length, Time ts);
  virtual ~UanHeaderRcRts ();

  static TypeId GetTypeId (void);

  void SetFrameNo (uint8_t fno);
  void SetNoFrames (uint8_t no);
  void SetTimeStamp (Time timeStamp);
  void SetLength (uint16_t length);
  void SetRetryNo (uint8_t no);

  uint8_t GetFrameNo (void) const;
  uint8_t GetNoFrames (void) const;
  Time GetTimeStamp (void) const;
  uint16_t GetLength (void) const;
  uint8_t GetRetryNo (void) const;
  void Print (std::ostream &os, Time::Unit unit) const;

  // Inherrited methods
  virtual uint32_t GetSerializedSize (void) const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual void Print (std::ostream &os) const;
  virtual TypeId GetInstanceTypeId (void) const;

private:
  uint8_t m_frameNo;   
  uint8_t m_noFrames;  
  uint16_t m_length;   
  Time m_timeStamp;    
  uint8_t m_retryNo;   

};  // class UanHeaderRcRts

class UanHeaderRcCtsGlobal : public Header
{
public:
  UanHeaderRcCtsGlobal ();
  UanHeaderRcCtsGlobal (Time wt, Time ts, uint16_t rate, uint16_t retryRate);
  ~UanHeaderRcCtsGlobal ();

  static TypeId GetTypeId (void);

  void SetRateNum (uint16_t rate);
  void SetRetryRate (uint16_t rate);
  void SetWindowTime (Time t);

  void SetTxTimeStamp (Time timeStamp);

  uint16_t GetRateNum (void) const;
  uint16_t GetRetryRate (void) const;
  Time GetWindowTime (void) const;
  Time GetTxTimeStamp (void) const;
  void Print (std::ostream &os, Time::Unit unit) const;

  // Inherrited methods
  virtual uint32_t GetSerializedSize (void) const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual void Print (std::ostream &os) const;
  virtual TypeId GetInstanceTypeId (void) const;

private:
  Time m_timeStampTx;    
  Time m_winTime;        
  uint16_t m_retryRate;  
  uint16_t m_rateNum;    

};  // class UanHeaderRcCtsGlobal

class UanHeaderRcCts : public Header
{
public:
  UanHeaderRcCts ();
  UanHeaderRcCts (uint8_t frameNo, uint8_t retryNo, Time rtsTs, Time delay, Mac8Address addr);
  virtual ~UanHeaderRcCts ();

  static TypeId GetTypeId (void);

  void SetFrameNo (uint8_t frameNo);
  void SetRtsTimeStamp (Time timeStamp);
  void SetDelayToTx (Time delay);
  void SetRetryNo (uint8_t no);
  void SetAddress (Mac8Address addr);

  uint8_t GetFrameNo (void) const;
  Time GetRtsTimeStamp (void) const;
  Time GetDelayToTx (void) const;
  uint8_t GetRetryNo (void) const;
  Mac8Address GetAddress (void) const;
  void Print (std::ostream &os, Time::Unit unit) const;

  // Inherrited methods
  virtual uint32_t GetSerializedSize (void) const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual void Print (std::ostream &os) const;
  virtual TypeId GetInstanceTypeId (void) const;

private:
  uint8_t m_frameNo;     
  Time m_timeStampRts;   
  uint8_t m_retryNo;     
  Time m_delay;          
  Mac8Address m_address;  

};  // class UanHeaderRcCts

class UanHeaderRcAck : public Header
{
public:
  UanHeaderRcAck ();
  virtual ~UanHeaderRcAck ();

  static TypeId GetTypeId (void);

  void SetFrameNo (uint8_t frameNo);
  void AddNackedFrame (uint8_t frame);

  const std::set<uint8_t> &GetNackedFrames (void) const;
  uint8_t GetFrameNo (void) const;
  uint8_t GetNoNacks (void) const;

  // Inherrited methods
  virtual uint32_t GetSerializedSize (void) const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual void Print (std::ostream &os) const;
  virtual TypeId GetInstanceTypeId (void) const;

private:
  uint8_t m_frameNo;                 
  std::set<uint8_t> m_nackedFrames;  

};  // class UanHeaderRcAck

} // namespace ns3

#endif /* UAN_HEADER_RC_H */