/* -*-  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 WIFI_NET_DEVICE_H

 #define WIFI_NET_DEVICE_H

 #include "ns3/net-device.h"

 #include "ns3/packet.h"

 #include "ns3/traced-callback.h"

 #include "ns3/mac48-address.h"

 #include "wifi-remote-station-manager.h"

 #include <string>

 namespace ns3 {

 class WifiChannel;

 class WifiPhy;

 class WifiMac;

 /**

  * \brief Hold together all Wifi-related objects.

  *

  * This class holds together ns3::WifiChannel, ns3::WifiPhy,

  * ns3::WifiMac, and, ns3::WifiRemoteStationManager.

  */

 class WifiNetDevice : public NetDevice 

 {

 public:

   static TypeId GetTypeId (void);

   WifiNetDevice ();

   virtual ~WifiNetDevice ();

   /**

    * \param mac the mac layer to use.

    */

   void SetMac (Ptr<WifiMac> mac);

   /**

    * \param phy the phy layer to use.

    */

   void SetPhy (Ptr<WifiPhy> phy);

   /**

    * \param manager the manager to use.

    */

   void SetRemoteStationManager (Ptr<WifiRemoteStationManager> manager);

   /**

    * \param channel the channel to connect to.

    */

   void SetChannel (Ptr<WifiChannel> channel);

   /**

    * \returns the mac we are currently using.

    */

   Ptr<WifiMac> GetMac (void) const;

   /**

    * \returns the phy we are currently using.

    */

   Ptr<WifiPhy> GetPhy (void) const;

   /**

    * \returns the remote station manager we are currently using.

    */

   Ptr<WifiRemoteStationManager> GetRemoteStationManager (void) const;

   // inherited from NetDevice base class.

   virtual void SetName(const std::string name);

   virtual std::string GetName(void) const;

   virtual void SetIfIndex(const uint32_t index);

   virtual uint32_t GetIfIndex(void) const;

   virtual Ptr<Channel> GetChannel (void) const;

   virtual Address GetAddress (void) const;

   virtual bool SetMtu (const uint16_t mtu);

   virtual uint16_t GetMtu (void) const;

   virtual bool IsLinkUp (void) const;

   virtual void SetLinkChangeCallback (Callback<void> callback);

   virtual bool IsBroadcast (void) const;

   virtual Address GetBroadcast (void) const;

   virtual bool IsMulticast (void) const;

   virtual Address GetMulticast (Ipv4Address multicastGroup) const;

   virtual bool IsPointToPoint (void) const;

   virtual bool Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber);

   virtual Ptr<Node> GetNode (void) const;

   virtual void SetNode (Ptr<Node> node);

   virtual bool NeedsArp (void) const;

   virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb);

   virtual Address GetMulticast (Ipv6Address addr) const;

   virtual bool SendFrom(Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber);

   virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb);

   virtual bool SupportsSendFrom (void) const;

 private:

   virtual void DoDispose (void);

   void ForwardUp (Ptr<Packet> packet, Mac48Address from, Mac48Address to);

   void LinkUp (void);

   void LinkDown (void);

   void Setup (void);

   Ptr<WifiChannel> DoGetChannel (void) const;

   Ptr<Node> m_node;

   Ptr<WifiPhy> m_phy;

   Ptr<WifiChannel> m_channel;

   Ptr<WifiMac> m_mac;

   Ptr<WifiRemoteStationManager> m_stationManager;

   NetDevice::ReceiveCallback m_forwardUp;

   NetDevice::PromiscReceiveCallback m_promiscRx;

   TracedCallback<Ptr<const Packet>, Mac48Address> m_rxLogger;

   TracedCallback<Ptr<const Packet>, Mac48Address> m_txLogger;

   uint32_t m_ifIndex;

   std::string m_name;

   bool m_linkUp;

   Callback<void> m_linkChange;

   mutable uint16_t m_mtu;

 };

 } // namespace ns3

 #endif /* WIFI_NET_DEVICE_H */