channel-scheduler.h

Go to the documentation of this file.

/*
 * 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: Junling Bu <linlinjavaer@gmail.com>
 */
#ifndef CHANNEL_SCHEDULER_H
#define CHANNEL_SCHEDULER_H
 
#include "wave-net-device.h"
 
#include "ns3/qos-utils.h"
 
#include <map>
 
namespace ns3
{
class WaveNetDevice;
 
struct EdcaParameter
{
    uint32_t cwmin; 
    uint32_t cwmax; 
    uint32_t aifsn; 
};
 
typedef std::map<AcIndex, EdcaParameter> EdcaParameters;
 
typedef std::map<AcIndex, EdcaParameter>::const_iterator EdcaParametersI;
 
#define EXTENDED_ALTERNATING 0x00
#define EXTENDED_CONTINUOUS 0xff
 
struct SchInfo
{
    uint32_t channelNumber; 
    // OperationalRateSet  operationalRateSet;  // not supported
    bool immediateAccess;          
    uint8_t extendedAccess;        
    EdcaParameters edcaParameters; 
 
    SchInfo()
        : channelNumber(SCH1),
          immediateAccess(false),
          extendedAccess(EXTENDED_ALTERNATING)
    {
    }
 
    SchInfo(uint32_t channel, bool immediate, uint32_t channelAccess)
        : channelNumber(channel),
          immediateAccess(immediate),
          extendedAccess(channelAccess)
    {
    }
 
    SchInfo(uint32_t channel, bool immediate, uint32_t channelAccess, EdcaParameters edca)
        : channelNumber(channel),
          immediateAccess(immediate),
          extendedAccess(channelAccess),
          edcaParameters(edca)
    {
    }
};
 
enum ChannelAccess
{
    ContinuousAccess,  // continuous access for SCHs
    AlternatingAccess, // alternating CCH and SCH access
    ExtendedAccess,    // extended access in SCHs
    DefaultCchAccess,  // default continuous CCH access
    NoAccess,          // no channel access assigned
};
 
class ChannelScheduler : public Object
{
  public:
    static TypeId GetTypeId();
    ChannelScheduler();
    ~ChannelScheduler() override;
 
    virtual void SetWaveNetDevice(Ptr<WaveNetDevice> device);
    bool IsCchAccessAssigned() const;
    bool IsSchAccessAssigned() const;
    bool IsChannelAccessAssigned(uint32_t channelNumber) const;
    bool IsContinuousAccessAssigned(uint32_t channelNumber) const;
    bool IsAlternatingAccessAssigned(uint32_t channelNumber) const;
    bool IsExtendedAccessAssigned(uint32_t channelNumber) const;
    bool IsDefaultCchAccessAssigned() const;
    virtual ChannelAccess GetAssignedAccessType(uint32_t channelNumber) const = 0;
 
    bool StartSch(const SchInfo& schInfo);
    bool StopSch(uint32_t channelNumber);
 
  protected:
    void DoInitialize() override;
    void DoDispose() override;
 
    virtual bool AssignAlternatingAccess(uint32_t channelNumber, bool immediate) = 0;
    virtual bool AssignContinuousAccess(uint32_t channelNumber, bool immediate) = 0;
    virtual bool AssignExtendedAccess(uint32_t channelNumber, uint32_t extends, bool immediate) = 0;
    virtual bool AssignDefaultCchAccess() = 0;
    virtual bool ReleaseAccess(uint32_t channelNumber) = 0;
 
    Ptr<WaveNetDevice> m_device; 
};
 
} // namespace ns3
#endif /* CHANNEL_SCHEDULER_H */