csma-channel.h

Go to the documentation of this file.

/*
 * Copyright (c) 2007 Emmanuelle Laprise
 * Copyright (c) 2012 Jeffrey Young
 * Copyright (c) 2014 Murphy McCauley
 * Copyright (c) 2017 Luciano Jerez Chaves
 *
 * 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: Emmanuelle Laprise<emmanuelle.laprise@bluekazoo.ca>
 * Author: Jeff Young <jyoung9@gatech.edu>
 * Author: Murphy McCauley <murphy.mccauley@gmail.com>
 * Author: Luciano Jerez Chaves <ljerezchaves@gmail.com>
 */
 
#ifndef CSMA_CHANNEL_H
#define CSMA_CHANNEL_H
 
#include "ns3/boolean.h"
#include "ns3/channel.h"
#include "ns3/data-rate.h"
#include "ns3/nstime.h"
#include "ns3/ptr.h"
 
namespace ns3
{
 
class Packet;
 
class CsmaNetDevice;
 
class CsmaDeviceRec
{
  public:
    Ptr<CsmaNetDevice> devicePtr; 
    bool active;                  
 
    CsmaDeviceRec();
 
    CsmaDeviceRec(Ptr<CsmaNetDevice> device);
 
    CsmaDeviceRec(const CsmaDeviceRec& o);
 
    bool IsActive() const;
};
 
class CsmaChannel : public Channel
{
  public:
    enum WireState
    {
        IDLE,         
        TRANSMITTING, 
        PROPAGATING   
    };
 
    static TypeId GetTypeId();
 
    CsmaChannel();
    ~CsmaChannel() override;
 
    // Delete copy constructor and assignment operator to avoid misuse
    CsmaChannel(const CsmaChannel&) = delete;
    CsmaChannel& operator=(const CsmaChannel&) = delete;
 
    int32_t Attach(Ptr<CsmaNetDevice> device);
 
    bool Detach(Ptr<CsmaNetDevice> device);
 
    bool Detach(uint32_t deviceId);
 
    bool Reattach(uint32_t deviceId);
 
    bool Reattach(Ptr<CsmaNetDevice> device);
 
    bool TransmitStart(Ptr<const Packet> p, uint32_t srcId);
 
    bool TransmitEnd(uint32_t deviceId);
 
    void PropagationCompleteEvent(uint32_t deviceId);
 
    int32_t GetDeviceNum(Ptr<CsmaNetDevice> device);
 
    WireState GetState(uint32_t deviceId);
 
    bool IsBusy(uint32_t deviceId);
 
    bool IsActive(uint32_t deviceId);
 
    bool IsFullDuplex() const;
 
    uint32_t GetNumActDevices();
 
    std::size_t GetNDevices() const override;
 
    Ptr<NetDevice> GetDevice(std::size_t i) const override;
 
    Ptr<CsmaNetDevice> GetCsmaDevice(std::size_t i) const;
 
    DataRate GetDataRate();
 
    Time GetDelay();
 
  private:
    DataRate m_bps;
 
    Time m_delay;
 
    bool m_fullDuplex;
 
    std::vector<CsmaDeviceRec> m_deviceList;
 
    Ptr<Packet> m_currentPkt[2];
 
    uint32_t m_currentSrc[2];
 
    WireState m_state[2];
 
    Ptr<Packet> GetCurrentPkt(uint32_t deviceId);
 
    void SetCurrentPkt(uint32_t deviceId, Ptr<Packet> pkt);
 
    uint32_t GetCurrentSrc(uint32_t deviceId);
 
    void SetCurrentSrc(uint32_t deviceId, uint32_t transmitterId);
 
    void SetState(uint32_t deviceId, WireState state);
};
 
} // namespace ns3
 
#endif /* CSMA_CHANNEL_H */