channel-coordinator.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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/nstime.h"
#include "ns3/object.h"
#include "ns3/event-id.h"

namespace ns3 {

class ChannelCoordinationListener : public SimpleRefCount<ChannelCoordinationListener>
{
public:
  virtual ~ChannelCoordinationListener (void);
  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 (void);
  ChannelCoordinator ();
  virtual ~ChannelCoordinator ();

  static Time GetDefaultCchInterval (void);
  static Time GetDefaultSchInterval (void);
  static Time GetDefaultSyncInterval (void);
  static Time GetDefaultGuardInterval (void);

  void SetCchInterval (Time cchi);
  Time GetCchInterval (void) const;
  void SetSchInterval (Time schi);
  Time GetSchInterval (void) const;
  Time GetSyncInterval (void) const;
  void SetGuardInterval (Time guardi);
  Time GetGuardInterval (void) const;
  bool IsValidConfig (void) 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 (void);

private:
  virtual void DoDispose (void);
  virtual void DoInitialize (void);

  void StartChannelCoordination (void);
  void StopChannelCoordination (void);

  void NotifySchSlot (void);
  void NotifyCchSlot (void);
  void NotifyGuardSlot (void);
  Time GetSchSlot (void) const;
  Time GetCchSlot (void) const;

  Time m_cchi;  // CchInterval
  Time m_schi;  // SchInterval
  Time m_gi;    // GuardInterval

  typedef std::vector<Ptr<ChannelCoordinationListener> > Listeners;
  typedef std::vector<Ptr<ChannelCoordinationListener> >::iterator ListenersI;
  Listeners m_listeners;

  uint32_t m_guardCount;
  EventId m_coordination;
};

}
#endif /* CHANNEL_COORDINATOR_H */