traffic-control-layer.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2015 Natale Patriciello <natale.patriciello@gmail.com>
 *               2016 Stefano Avallone <stavallo@unina.it>
 *
 * 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
 */
#ifndef TRAFFICCONTROLLAYER_H
#define TRAFFICCONTROLLAYER_H

#include "ns3/object.h"
#include "ns3/address.h"
#include "ns3/net-device.h"
#include "ns3/node.h"
#include "ns3/queue-item.h"
#include <map>
#include <vector>

namespace ns3 {

class Packet;
class QueueDisc;
class NetDeviceQueueInterface;

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

  virtual TypeId GetInstanceTypeId (void) const;

  TrafficControlLayer ();

  virtual ~TrafficControlLayer ();

  void RegisterProtocolHandler (Node::ProtocolHandler handler,
                                uint16_t protocolType,
                                Ptr<NetDevice> device);

  typedef std::vector<Ptr<QueueDisc> > QueueDiscVector;

  virtual void SetupDevice (Ptr<NetDevice> device);

  virtual void SetRootQueueDiscOnDevice (Ptr<NetDevice> device, Ptr<QueueDisc> qDisc);

  virtual Ptr<QueueDisc> GetRootQueueDiscOnDevice (Ptr<NetDevice> device) const;

  virtual void DeleteRootQueueDiscOnDevice (Ptr<NetDevice> device);

  void SetNode (Ptr<Node> node);

  virtual void Receive (Ptr<NetDevice> device, Ptr<const Packet> p,
                        uint16_t protocol, const Address &from,
                        const Address &to, NetDevice::PacketType packetType);
  virtual void Send (Ptr<NetDevice> device, Ptr<QueueDiscItem> item);

  typedef Callback< uint8_t, Ptr<QueueItem> > SelectQueueCallback;

protected:

  virtual void DoDispose (void);
  virtual void DoInitialize (void);
  virtual void NotifyNewAggregate (void);

private:
  TrafficControlLayer (TrafficControlLayer const &);
  TrafficControlLayer& operator= (TrafficControlLayer const &);
  struct ProtocolHandlerEntry {
    Node::ProtocolHandler handler; 
    Ptr<NetDevice> device;         
    uint16_t protocol;             
    bool promiscuous;              
  };

  class NetDeviceInfo
  {
  public:
    NetDeviceInfo (Ptr<QueueDisc> rootQueueDisc, Ptr<NetDeviceQueueInterface> ndqi,
                   QueueDiscVector queueDiscsToWake, SelectQueueCallback selectQueueCallback);
    virtual ~NetDeviceInfo ();

    Ptr<QueueDisc> m_rootQueueDisc;       
    Ptr<NetDeviceQueueInterface> m_ndqi;  
    QueueDiscVector m_queueDiscsToWake;   
    SelectQueueCallback m_selectQueueCallback;  
  private:
    NetDeviceInfo ();
    NetDeviceInfo (NetDeviceInfo const &);
    NetDeviceInfo& operator= (NetDeviceInfo const &);
  };

  typedef std::vector<struct ProtocolHandlerEntry> ProtocolHandlerList;

  uint32_t GetNDevices (void) const;
  Ptr<QueueDisc> GetRootQueueDiscOnDeviceByIndex (uint32_t index) const;

  Ptr<Node> m_node;
  std::map<Ptr<NetDevice>, NetDeviceInfo> m_netDevices;
  ProtocolHandlerList m_handlers;  
};

} // namespace ns3

#endif // TRAFFICCONTROLLAYER_H