csma-channel.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007 Emmanuelle Laprise
 *
 * 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: Emmanuelle Laprise<emmanuelle.laprise@bluekazoo.ca>
 */

#ifndef CSMA_CHANNEL_H
#define CSMA_CHANNEL_H

#include "ns3/channel.h"
#include "ns3/ptr.h"
#include "ns3/nstime.h"
#include "ns3/data-rate.h"

namespace ns3 {

class Packet;

class CsmaNetDevice;

class CsmaDeviceRec {
public:
  Ptr< CsmaNetDevice > devicePtr; 
  bool                       active;    

  CsmaDeviceRec();
  CsmaDeviceRec(Ptr< CsmaNetDevice > device);
  CsmaDeviceRec (CsmaDeviceRec const &);

  bool IsActive ();
};

enum WireState
{
  IDLE,            
  TRANSMITTING,    
  PROPAGATING      
};

class CsmaChannel : public Channel 
{
public:
  static TypeId GetTypeId (void);

  CsmaChannel ();
  virtual ~CsmaChannel ();

  int32_t Attach (Ptr<CsmaNetDevice> device);

  bool Detach (Ptr<CsmaNetDevice> device);

  bool Detach (uint32_t deviceId);

  bool Reattach (uint32_t deviceId);

  bool Reattach (Ptr<CsmaNetDevice> device);

  bool TransmitStart (Ptr<Packet> p, uint32_t srcId);

  bool TransmitEnd ();

  void PropagationCompleteEvent ();

  int32_t GetDeviceNum (Ptr<CsmaNetDevice> device);

  WireState GetState ();

  bool IsBusy ();

  bool IsActive (uint32_t deviceId);

  uint32_t GetNumActDevices (void);

  virtual uint32_t GetNDevices (void) const;

  virtual Ptr<NetDevice> GetDevice (uint32_t i) const;

  Ptr<CsmaNetDevice> GetCsmaDevice (uint32_t i) const;

  DataRate GetDataRate (void);

  Time GetDelay (void);

private:
  // Avoid implicit copy constructor and assignment (python bindings issues)
  CsmaChannel (CsmaChannel const &);
  CsmaChannel &operator = (CsmaChannel const &);

  DataRate      m_bps;

  Time          m_delay;

  std::vector<CsmaDeviceRec> m_deviceList;

  Ptr<Packet> m_currentPkt;

  uint32_t                            m_currentSrc;

  WireState          m_state;
};

} // namespace ns3

#endif /* CSMA_CHANNEL_H */