dcf-state.h

Go to the documentation of this file.

/* -*- 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_STATE_H
#define DCF_STATE_H

#include "ns3/nstime.h"
#include "ns3/simulator.h"

namespace ns3 {

class DcaTxop;

class DcfState : public Object
{
public:
  static TypeId GetTypeId (void);

  DcfState (Ptr<DcaTxop> txop);
  virtual ~DcfState ();

  bool IsEdca (void) const;

  void SetAifsn (uint32_t aifsn);
  void SetCwMin (uint32_t minCw);
  void SetCwMax (uint32_t maxCw);
  void SetTxopLimit (Time txopLimit);
  uint32_t GetAifsn (void) const;
  uint32_t GetCwMin (void) const;
  uint32_t GetCwMax (void) const;
  Time GetTxopLimit (void) const;

  void ResetCw (void);
  void UpdateFailedCw (void);
  void StartBackoffNow (uint32_t nSlots);
  uint32_t GetCw (void) const;
  bool IsAccessRequested (void) const;


protected:
  friend class DcfManager;

  // Inherited from ns3::Object
  void DoDispose (void);

  uint32_t GetBackoffSlots (void) const;
  Time GetBackoffStart (void) const;
  void UpdateBackoffSlotsNow (uint32_t nSlots, Time backoffUpdateBound);
  void NotifyAccessRequested (void);
  void NotifyAccessGranted (void);
  void NotifyCollision (void);
  void NotifyInternalCollision (void);
  void NotifyChannelSwitching (void);
  void NotifySleep (void);
  void NotifyOff (void);
  void NotifyWakeUp (void);
  void NotifyOn (void);

  uint32_t m_aifsn;        
  uint32_t m_backoffSlots; 

  Time m_backoffStart;
  uint32_t m_cwMin;       
  uint32_t m_cwMax;       
  uint32_t m_cw;          
  Time m_txopLimit;       
  bool m_accessRequested; 
  Ptr<DcaTxop> m_txop;    
};

} //namespace ns3

#endif /* DCF_STATE_H */