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

#ifndef INTERNET_STACK_HELPER_H
#define 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 "internet-trace-helper.h"

namespace ns3 {

class Node;
class Ipv4RoutingHelper;
class Ipv6RoutingHelper;

class InternetStackHelper : public PcapHelperForIpv4, public PcapHelperForIpv6, 
                            public AsciiTraceHelperForIpv4, public AsciiTraceHelperForIpv6
{
public:
  InternetStackHelper(void);

  virtual ~InternetStackHelper(void);

  InternetStackHelper (const InternetStackHelper &);

  InternetStackHelper &operator = (const InternetStackHelper &o);

  void Reset (void);

  void SetRoutingHelper (const Ipv4RoutingHelper &routing);

  void SetRoutingHelper (const Ipv6RoutingHelper &routing);

  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 SetIpv4StackInstall (bool enable);

  void SetIpv6StackInstall (bool enable);

  void SetIpv4ArpJitter (bool enable);

  void SetIpv6NsRsJitter (bool enable);

  int64_t AssignStreams (NodeContainer c, int64_t stream);

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);

  virtual void EnablePcapIpv6Internal (std::string prefix, 
                                       Ptr<Ipv6> ipv6, 
                                       uint32_t interface,
                                       bool explicitFilename);

  virtual void EnableAsciiIpv6Internal (Ptr<OutputStreamWrapper> stream, 
                                        std::string prefix, 
                                        Ptr<Ipv6> ipv6, 
                                        uint32_t interface,
                                        bool explicitFilename);

  void Initialize (void);

  ObjectFactory m_tcpFactory;

  const Ipv4RoutingHelper *m_routing;

  const Ipv6RoutingHelper *m_routingv6;

  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 PcapHooked (Ptr<Ipv6> ipv6);

  bool AsciiHooked (Ptr<Ipv6> ipv6);

  bool m_ipv4Enabled;

  bool m_ipv6Enabled;

  bool m_ipv4ArpJitterEnabled;

  bool m_ipv6NsRsJitterEnabled;
};

} // namespace ns3

#endif /* INTERNET_STACK_HELPER_H */