uan-mac-cw.h

Go to the documentation of this file.

/*
 * 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_MAC_CW_H
#define UAN_MAC_CW_H
 
#include "uan-mac.h"
#include "uan-phy.h"
#include "uan-tx-mode.h"
 
#include "ns3/mac8-address.h"
#include "ns3/nstime.h"
#include "ns3/random-variable-stream.h"
#include "ns3/simulator.h"
 
namespace ns3
{
 
class UanMacCw : public UanMac, public UanPhyListener
{
  public:
    UanMacCw();
    ~UanMacCw() override;
    static TypeId GetTypeId();
 
    virtual void SetCw(uint32_t cw);
    virtual void SetSlotTime(Time duration);
    virtual uint32_t GetCw();
    virtual Time GetSlotTime();
 
    // Inherited methods from UanMac
    bool Enqueue(Ptr<Packet> pkt, uint16_t protocolNumber, const Address& dest) override;
    void SetForwardUpCb(Callback<void, Ptr<Packet>, uint16_t, const Mac8Address&> cb) override;
    void AttachPhy(Ptr<UanPhy> phy) override;
    void Clear() override;
    int64_t AssignStreams(int64_t stream) override;
 
    // Inherited methods from UanPhyListener
    void NotifyRxStart() override;
    void NotifyRxEndOk() override;
    void NotifyRxEndError() override;
    void NotifyCcaStart() override;
    void NotifyCcaEnd() override;
    void NotifyTxStart(Time duration) override;
    void NotifyTxEnd() override;
 
    typedef void (*QueueTracedCallback)(Ptr<const Packet> packet, uint16_t proto);
 
  private:
    enum State
    {
        IDLE,    
        CCABUSY, 
        RUNNING, 
        TX       
    };
 
    Callback<void, Ptr<Packet>, uint16_t, const Mac8Address&> m_forwardUpCb;
    Ptr<UanPhy> m_phy;
    TracedCallback<Ptr<const Packet>, UanTxMode> m_rxLogger;
    TracedCallback<Ptr<const Packet>, uint16_t> m_enqueueLogger;
    TracedCallback<Ptr<const Packet>, uint16_t> m_dequeueLogger;
 
    // Mac parameters
    uint32_t m_cw;   
    Time m_slotTime; 
 
    // State variables
    Time m_sendTime;
    Time m_savedDelayS;
    Ptr<Packet> m_pktTx;
    uint16_t m_pktTxProt;
    EventId m_sendEvent;
    bool m_txOngoing;
    State m_state;
 
    bool m_cleared;
 
    Ptr<UniformRandomVariable> m_rv;
 
    void PhyRxPacketGood(Ptr<Packet> packet, double sinr, UanTxMode mode);
    void PhyRxPacketError(Ptr<Packet> packet, double sinr);
    void SaveTimer();
    void StartTimer();
    void SendPacket();
    void EndTx();
 
  protected:
    void DoDispose() override;
 
}; // class UanMacCw
 
} // namespace ns3
 
#endif /* UAN_MAC_CW_H */