/usr/include/ns3.27/ns3/dcf-manager.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2005,2006 INRIA
*
* 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef DCF_MANAGER_H
#define DCF_MANAGER_H
#include "mac-low.h"
#include "ns3/event-id.h"
#include "ns3/nstime.h"
#include <vector>
namespace ns3 {
class WifiPhy;
class PhyListener;
class DcfState;
class MacLow;
/**
* \brief Manage a set of ns3::DcfState
* \ingroup wifi
*
* Handle a set of independent ns3::DcfState, each of which represents
* a single DCF within a MAC stack. Each ns3::DcfState has a priority
* implicitely associated with it (the priority is determined when the
* ns3::DcfState is added to the DcfManager: the first DcfState to be
* added gets the highest priority, the second, the second highest
* priority, and so on.) which is used to handle "internal" collisions.
* i.e., when two local DcfState are expected to get access to the
* medium at the same time, the highest priority local DcfState wins
* access to the medium and the other DcfState suffers a "internal"
* collision.
*/
class DcfManager : public Object
{
public:
DcfManager ();
virtual ~DcfManager ();
/**
* Set up listener for Phy events.
*
* \param phy
*/
void SetupPhyListener (Ptr<WifiPhy> phy);
/**
* Remove current registered listener for Phy events.
*
* \param phy
*/
void RemovePhyListener (Ptr<WifiPhy> phy);
/**
* Set up listener for MacLow events.
*
* \param low
*/
void SetupLow (Ptr<MacLow> low);
/**
* \param slotTime the duration of a slot.
*
* It is a bad idea to call this method after RequestAccess or
* one of the Notify methods has been invoked.
*/
void SetSlot (Time slotTime);
/**
* \param sifs the duration of a SIFS.
*
* It is a bad idea to call this method after RequestAccess or
* one of the Notify methods has been invoked.
*/
void SetSifs (Time sifs);
/**
* \param eifsNoDifs the duration of a EIFS minus the duration of DIFS.
*
* It is a bad idea to call this method after RequestAccess or
* one of the Notify methods has been invoked.
*/
void SetEifsNoDifs (Time eifsNoDifs);
/**
* \return value set previously using SetEifsNoDifs.
*/
Time GetEifsNoDifs () const;
/**
* \param dcf a new DcfState.
*
* The DcfManager does not take ownership of this pointer so, the callee
* must make sure that the DcfState pointer will stay valid as long
* as the DcfManager is valid. Note that the order in which DcfState
* objects are added to a DcfManager matters: the first DcfState added
* has the highest priority, the second DcfState added, has the second
* highest priority, etc.
*/
void Add (Ptr<DcfState> dcf);
/**
* \param state a DcfState
*
* Notify the DcfManager that a specific DcfState needs access to the
* medium. The DcfManager is then responsible for starting an access
* timer and, invoking DcfState::DoNotifyAccessGranted when the access
* is granted if it ever gets granted.
*/
void RequestAccess (Ptr<DcfState> state);
/**
* \param duration expected duration of reception
*
* Notify the DCF that a packet reception started
* for the expected duration.
*/
void NotifyRxStartNow (Time duration);
/**
* Notify the DCF that a packet reception was just
* completed successfully.
*/
void NotifyRxEndOkNow (void);
/**
* Notify the DCF that a packet reception was just
* completed unsuccessfully.
*/
void NotifyRxEndErrorNow (void);
/**
* \param duration expected duration of transmission
*
* Notify the DCF that a packet transmission was
* just started and is expected to last for the specified
* duration.
*/
void NotifyTxStartNow (Time duration);
/**
* \param duration expected duration of cca busy period
*
* Notify the DCF that a CCA busy period has just started.
*/
void NotifyMaybeCcaBusyStartNow (Time duration);
/**
* \param duration expected duration of channel switching period
*
* Notify the DCF that a channel switching period has just started.
* During switching state, new packets can be enqueued in DcaTxop/EdcaTxop
* but they won't access to the medium until the end of the channel switching.
*/
void NotifySwitchingStartNow (Time duration);
/**
* Notify the DCF that the device has been put in sleep mode.
*/
void NotifySleepNow (void);
/**
* Notify the DCF that the device has been resumed from sleep mode.
*/
void NotifyWakeupNow (void);
/**
* \param duration the value of the received NAV.
*
* Called at end of rx
*/
void NotifyNavResetNow (Time duration);
/**
* \param duration the value of the received NAV.
*
* Called at end of rx
*/
void NotifyNavStartNow (Time duration);
/**
* Notify that ACK timer has started for the given duration.
*
* \param duration
*/
void NotifyAckTimeoutStartNow (Time duration);
/**
* Notify that ACK timer has resetted.
*/
void NotifyAckTimeoutResetNow ();
/**
* Notify that CTS timer has started for the given duration.
*
* \param duration
*/
void NotifyCtsTimeoutStartNow (Time duration);
/**
* Notify that CTS timer has resetted.
*/
void NotifyCtsTimeoutResetNow ();
protected:
// Inherited from ns3::Object
void DoDispose (void);
private:
/**
* Update backoff slots for all DcfStates.
*/
void UpdateBackoff (void);
/**
* Return the most recent time.
*
* \param a
* \param b
*
* \return the most recent time
*/
Time MostRecent (Time a, Time b) const;
/**
* Return the most recent time.
*
* \param a
* \param b
* \param c
*
* \return the most recent time
*/
Time MostRecent (Time a, Time b, Time c) const;
/**
* Return the most recent time.
*
* \param a
* \param b
* \param c
* \param d
*
* \return the most recent time
*/
Time MostRecent (Time a, Time b, Time c, Time d) const;
/**
* Return the most recent time.
*
* \param a
* \param b
* \param c
* \param d
* \param e
* \param f
*
* \return the most recent time
*/
Time MostRecent (Time a, Time b, Time c, Time d, Time e, Time f) const;
/**
* Return the most recent time.
*
* \param a
* \param b
* \param c
* \param d
* \param e
* \param f
* \param g
*
* \return the most recent time
*/
Time MostRecent (Time a, Time b, Time c, Time d, Time e, Time f, Time g) const;
/**
* Access will never be granted to the medium _before_
* the time returned by this method.
*
* \returns the absolute time at which access could start to be granted
*/
Time GetAccessGrantStart (void) const;
/**
* Return the time when the backoff procedure
* started for the given DcfState.
*
* \param state
*
* \return the time when the backoff procedure started
*/
Time GetBackoffStartFor (Ptr<DcfState> state);
/**
* Return the time when the backoff procedure
* ended (or will ended) for the given DcfState.
*
* \param state
*
* \return the time when the backoff procedure ended (or will ended)
*/
Time GetBackoffEndFor (Ptr<DcfState> state);
void DoRestartAccessTimeoutIfNeeded (void);
/**
* Called when access timeout should occur
* (e.g. backoff procedure expired).
*/
void AccessTimeout (void);
/**
* Grant access to DCF
*/
void DoGrantAccess (void);
/**
* Check if the device is busy sending or receiving,
* or NAV or CCA busy.
*
* \return true if the device is busy,
* false otherwise
*/
bool IsBusy (void) const;
/**
* Check if the device is between frames (in DIFS or AIFS interval)
*
* \param state the state to check
* \return true if the device is within AIFS,
* false otherwise
*/
bool IsWithinAifs (Ptr<DcfState> state) const;
/**
* typedef for a vector of DcfStates
*/
typedef std::vector<Ptr<DcfState> > States;
States m_states; //!< the DCF states
Time m_lastAckTimeoutEnd; //!< the last ACK timeout end time
Time m_lastCtsTimeoutEnd; //!< the last CTS timeout end time
Time m_lastNavStart; //!< the last NAV start time
Time m_lastNavDuration; //!< the last NAV duration time
Time m_lastRxStart; //!< the last receive start time
Time m_lastRxDuration; //!< the last receive duration time
bool m_lastRxReceivedOk; //!< the last receive OK
Time m_lastRxEnd; //!< the last receive end time
Time m_lastTxStart; //!< the last transmit start time
Time m_lastTxDuration; //!< the last transmit duration time
Time m_lastBusyStart; //!< the last busy start time
Time m_lastBusyDuration; //!< the last busy duration time
Time m_lastSwitchingStart; //!< the last switching start time
Time m_lastSwitchingDuration; //!< the last switching duration time
bool m_rxing; //!< flag whether it is in receiving state
bool m_sleeping; //!< flag whether it is in sleeping state
Time m_eifsNoDifs; //!< EIFS no DIFS time
EventId m_accessTimeout; //!< the access timeout ID
uint32_t m_slotTimeUs; //!< the slot time in microseconds
Time m_sifs; //!< the SIFS time
PhyListener* m_phyListener; //!< the phy listener
};
} //namespace ns3
#endif /* DCF_MANAGER_H */
|