A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
24 #include <vector>
25 #include <algorithm>
26 #include "ns3/event-id.h"
27 #include "ns3/nstime.h"
29 namespace ns3 {
31 class WifiPhy;
32 class PhyListener;
33 class Txop;
34 class MacLow;
52 {
53 public:
55  virtual ~ChannelAccessManager ();
74  void SetupLow (Ptr<MacLow> low);
82  void SetSlot (Time slotTime);
89  void SetSifs (Time sifs);
96  void SetEifsNoDifs (Time eifsNoDifs);
101  Time GetEifsNoDifs (void) const;
113  void Add (Ptr<Txop> dcf);
124  void RequestAccess (Ptr<Txop> state, bool isCfPeriod = false);
132  void NotifyRxStartNow (Time duration);
137  void NotifyRxEndOkNow (void);
142  void NotifyRxEndErrorNow (void);
150  void NotifyTxStartNow (Time duration);
156  void NotifyMaybeCcaBusyStartNow (Time duration);
164  void NotifySwitchingStartNow (Time duration);
168  void NotifySleepNow (void);
172  void NotifyOffNow (void);
176  void NotifyWakeupNow (void);
180  void NotifyOnNow (void);
186  void NotifyNavResetNow (Time duration);
192  void NotifyNavStartNow (Time duration);
198  void NotifyAckTimeoutStartNow (Time duration);
202  void NotifyAckTimeoutResetNow (void);
208  void NotifyCtsTimeoutStartNow (Time duration);
212  void NotifyCtsTimeoutResetNow (void);
221  bool IsBusy (void) const;
224 protected:
225  // Inherited from ns3::Object
226  void DoDispose (void);
229 private:
233  void UpdateBackoff (void);
241  Time MostRecent (std::initializer_list<Time> list) const;
250  Time GetAccessGrantStart (bool ignoreNav = false) const;
270  void DoRestartAccessTimeoutIfNeeded (void);
276  void AccessTimeout (void);
280  void DoGrantDcfAccess (void);
288  bool IsWithinAifs (Ptr<Txop> state) const;
292  void DoGrantPcfAccess (Ptr<Txop> state);
297  typedef std::vector<Ptr<Txop> > States;
314  bool m_sleeping;
315  bool m_off;
322 };
324 } //namespace ns3
Time GetBackoffEndFor(Ptr< Txop > state)
Return the time when the backoff procedure ended (or will ended) for the given Txop.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Time m_eifsNoDifs
EIFS no DIFS time.
void UpdateBackoff(void)
Update backoff slots for all Txops.
bool m_off
flag whether it is in off state
Time m_lastRxDuration
the last receive duration time
Time m_lastCtsTimeoutEnd
the last CTS timeout end time
void NotifyOnNow(void)
Notify the DCF that the device has been resumed from off mode.
void SetupPhyListener(Ptr< WifiPhy > phy)
Set up listener for Phy events.
void NotifyMaybeCcaBusyStartNow(Time duration)
Time m_lastBusyStart
the last busy start time
bool IsBusy(void) const
Check if the device is busy sending or receiving, or NAV or CCA busy.
EventId m_accessTimeout
the access timeout ID
Time MostRecent(std::initializer_list< Time > list) const
Return the most recent time.
void RemovePhyListener(Ptr< WifiPhy > phy)
Remove current registered listener for Phy events.
Manage a set of ns3::TxopHandle a set of independent ns3::Txop, each of which represents a single DCF...
bool m_sleeping
flag whether it is in sleeping state
Time m_lastTxDuration
the last transmit duration time
void NotifyRxStartNow(Time duration)
Time m_lastRxStart
the last receive start time
Time m_lastBusyDuration
the last busy duration time
Definition: third.py:86
void NotifyRxEndErrorNow(void)
Notify the DCF that a packet reception was just completed unsuccessfully.
Time m_lastNavDuration
the last NAV duration time
void NotifyCtsTimeoutStartNow(Time duration)
Notify that CTS timer has started for the given duration.
Ptr< WifiPhy > m_phy
Ptr to the PHY.
void SetEifsNoDifs(Time eifsNoDifs)
void NotifyOffNow(void)
Notify the DCF that the device has been put in off mode.
Time m_lastRxEnd
the last receive end time
Time m_lastSwitchingStart
the last switching start time
void NotifySleepNow(void)
Notify the DCF that the device has been put in sleep mode.
Listener for PHY events.
#define list
Time m_lastTxStart
the last transmit start time
void NotifyNavResetNow(Time duration)
void NotifyAckTimeoutStartNow(Time duration)
Notify that ACK timer has started for the given duration.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void NotifyRxEndOkNow(void)
Notify the DCF that a packet reception was just completed successfully.
Time GetAccessGrantStart(bool ignoreNav=false) const
Access will never be granted to the medium before the time returned by this method.
bool m_lastRxReceivedOk
the last receive OK
PhyListener * m_phyListener
the phy listener
void NotifyCtsTimeoutResetNow(void)
Notify that CTS timer has reset.
void DoGrantPcfAccess(Ptr< Txop > state)
Grant access to PCF.
void DoGrantDcfAccess(void)
Grant access to DCF.
An identifier for simulation events.
Definition: event-id.h:53
std::vector< Ptr< Txop > > States
typedef for a vector of Txops
Time m_lastNavStart
the last NAV start time
void NotifySwitchingStartNow(Time duration)
void NotifyNavStartNow(Time duration)
States m_states
the DCF states
Time m_lastSwitchingDuration
the last switching duration time
void AccessTimeout(void)
Called when access timeout should occur (e.g.
void NotifyTxStartNow(Time duration)
A base class which provides memory management and object aggregation.
Definition: object.h:87
Time GetBackoffStartFor(Ptr< Txop > state)
Return the time when the backoff procedure started for the given Txop.
void SetupLow(Ptr< MacLow > low)
Set up listener for MacLow events.
void NotifyWakeupNow(void)
Notify the DCF that the device has been resumed from sleep mode.
void RequestAccess(Ptr< Txop > state, bool isCfPeriod=false)
Time m_lastAckTimeoutEnd
the last ACK timeout end time
bool IsWithinAifs(Ptr< Txop > state) const
Check if the device is between frames (in DIFS or AIFS interval)
void DoDispose(void)
Destructor implementation.
void NotifyAckTimeoutResetNow(void)
Notify that ACK timer has reset.