channel-coordinator.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_COORDINATOR_H
#define CHANNEL_COORDINATOR_H
#include "ns3/event-id.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
 
namespace ns3
{
 
class ChannelCoordinationListener : public SimpleRefCount<ChannelCoordinationListener>
{
  public:
    virtual ~ChannelCoordinationListener();
    virtual void NotifyCchSlotStart(Time duration) = 0;
    virtual void NotifySchSlotStart(Time duration) = 0;
    virtual void NotifyGuardSlotStart(Time duration, bool cchi) = 0;
};
 
class ChannelCoordinator : public Object
{
  public:
    static TypeId GetTypeId();
    ChannelCoordinator();
    ~ChannelCoordinator() override;
 
    static Time GetDefaultCchInterval();
    static Time GetDefaultSchInterval();
    static Time GetDefaultSyncInterval();
    static Time GetDefaultGuardInterval();
 
    void SetCchInterval(Time cchi);
    Time GetCchInterval() const;
    void SetSchInterval(Time schi);
    Time GetSchInterval() const;
    Time GetSyncInterval() const;
    void SetGuardInterval(Time guardi);
    Time GetGuardInterval() const;
    bool IsValidConfig() const;
 
    bool IsCchInterval(Time duration = Seconds(0.0)) const;
    bool IsSchInterval(Time duration = Seconds(0.0)) const;
    bool IsGuardInterval(Time duration = Seconds(0.0)) const;
    Time NeedTimeToCchInterval(Time duration = Seconds(0.0)) const;
    Time NeedTimeToSchInterval(Time duration = Seconds(0.0)) const;
    Time NeedTimeToGuardInterval(Time duration = Seconds(0.0)) const;
    Time GetIntervalTime(Time duration = Seconds(0.0)) const;
    Time GetRemainTime(Time duration = Seconds(0.0)) const;
    void RegisterListener(Ptr<ChannelCoordinationListener> listener);
    void UnregisterListener(Ptr<ChannelCoordinationListener> listener);
    void UnregisterAllListeners();
 
  private:
    void DoDispose() override;
    void DoInitialize() override;
 
    void StartChannelCoordination();
    void StopChannelCoordination();
    void NotifySchSlot();
    void NotifyCchSlot();
    void NotifyGuardSlot();
    Time GetSchSlot() const;
    Time GetCchSlot() const;
 
    Time m_cchi; 
    Time m_schi; 
    Time m_gi;   
 
    typedef std::vector<Ptr<ChannelCoordinationListener>> Listeners;
    typedef std::vector<Ptr<ChannelCoordinationListener>>::iterator ListenersI;
    Listeners m_listeners; 
 
    uint32_t m_guardCount;  
    EventId m_coordination; 
};
 
} // namespace ns3
#endif /* CHANNEL_COORDINATOR_H */