click-internet-stack-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008 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>
 * Author: Lalith Suresh  <suresh.lalith@gmail.com>
 */

#ifdef NS3_CLICK

#ifndef CLICK_INTERNET_STACK_HELPER_H
#define CLICK_INTERNET_STACK_HELPER_H

#include "ns3/node-container.h"
#include "ns3/net-device-container.h"
#include "ns3/packet.h"
#include "ns3/ptr.h"
#include "ns3/object-factory.h"
#include "ns3/ipv4-l3-protocol.h"
#include "ns3/ipv6-l3-protocol.h"
#include "ns3/internet-trace-helper.h"
#include <map>

namespace ns3 {

class Node;
class Ipv4RoutingHelper;

class ClickInternetStackHelper : public PcapHelperForIpv4,
                                 public AsciiTraceHelperForIpv4
{
public:
  ClickInternetStackHelper (void);

  virtual ~ClickInternetStackHelper (void);
  ClickInternetStackHelper (const ClickInternetStackHelper &);
  ClickInternetStackHelper &operator = (const ClickInternetStackHelper &o);

  void Reset (void);

  void Install (std::string nodeName) const;

  void Install (Ptr<Node> node) const;

  void Install (NodeContainer c) const;

  void InstallAll (void) const;

  void SetTcp (std::string tid);

  void SetTcp (std::string tid, std::string attr, const AttributeValue &val);

  void SetClickFile (NodeContainer c, std::string clickfile);

  void SetClickFile (Ptr<Node> node, std::string clickfile);

  void SetDefines (NodeContainer c, std::map<std::string, std::string> defines);

  void SetDefines (Ptr<Node> node, std::map<std::string, std::string> defines);

  void SetRoutingTableElement (NodeContainer c, std::string rt);

  void SetRoutingTableElement (Ptr<Node> node, std::string rt);
private:
  virtual void EnablePcapIpv4Internal (std::string prefix,
                                       Ptr<Ipv4> ipv4,
                                       uint32_t interface,
                                       bool explicitFilename);

  virtual void EnableAsciiIpv4Internal (Ptr<OutputStreamWrapper> stream,
                                        std::string prefix,
                                        Ptr<Ipv4> ipv4,
                                        uint32_t interface,
                                        bool explicitFilename);

  void Initialize (void);
  ObjectFactory m_tcpFactory;

  static void CreateAndAggregateObjectFromTypeId (Ptr<Node> node, const std::string typeId);

  static void Cleanup (void);

  bool PcapHooked (Ptr<Ipv4> ipv4);

  bool AsciiHooked (Ptr<Ipv4> ipv4);

  bool m_ipv4Enabled;

  std::map < Ptr<Node>, std::string  > m_nodeToClickFileMap;

  std::map < Ptr<Node>, std::map<std::string, std::string>  > m_nodeToDefinesMap;

  std::map < Ptr<Node>, std::string  > m_nodeToRoutingTableElementMap;
};

} // namespace ns3

#endif /* CLICK_INTERNET_STACK_HELPER_H */

#endif /* NS3_CLICK */