/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * 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

 */

// Network topology

//

//                     Lan1

//                 ===========

//                 |    |    | 

//       n0   n1   n2   n3   n4

//       |    |    |

//       ===========

//           Lan0

//

// - Multicast source is at node n0;

// - Multicast forwarded by node n2 onto LAN1;

// - Nodes n0, n1, n2, n3, and n4 receive the multicast frame.

// - Node n4 listens for the data 

#include <iostream>

#include <fstream>

#include "ns3/core-module.h"

#include "ns3/simulator-module.h"

#include "ns3/node-module.h"

#include "ns3/helper-module.h"

using namespace ns3;

NS_LOG_COMPONENT_DEFINE ("CsmaMulticastExample");

int 

main (int argc, char *argv[])

{

  //

  // Users may find it convenient to turn on explicit debugging

  // for selected modules; the below lines suggest how to do this

  //

  // LogComponentEnable ("CsmaMulticastExample", LOG_LEVEL_INFO);

  //

  // Make the random number generators generate reproducible results.

  //

  RandomVariable::UseGlobalSeed (1, 1, 2, 3, 5, 8);

  //

  // Set up default values for the simulation.  

  //

  // Select Ethernet II-style encapsulation (no LLC/Snap header)

  Config::SetDefault ("ns3::CsmaNetDevice::EncapsulationMode", StringValue ("IpArp"));  

  // Allow the user to override any of the defaults at

  // run-time, via command-line arguments

  CommandLine cmd;

  cmd.Parse (argc, argv);

  NS_LOG_INFO ("Create nodes.");

  NodeContainer c;

  c.Create (5);

  // We will later want two subcontainers of these nodes, for the two LANs

  NodeContainer c0 = NodeContainer (c.Get (0), c.Get (1), c.Get (2));

  NodeContainer c1 = NodeContainer (c.Get (2), c.Get (3), c.Get (4));

  NS_LOG_INFO ("Build Topology.");

  CsmaHelper csma;

  // We will use these NetDevice containers later, for IP addressing

  NetDeviceContainer nd0 = csma.Install (c0);  // First LAN

  NetDeviceContainer nd1 = csma.Install (c1);  // Second LAN

  NS_LOG_INFO ("Add IP Stack.");

  InternetStackHelper internet;

  internet.Install (c);

  NS_LOG_INFO ("Assign IP Addresses.");

  Ipv4AddressHelper ipv4Addr;

  ipv4Addr.SetBase ("10.1.1.0", "255.255.255.0");

  ipv4Addr.Assign (nd0);

  ipv4Addr.SetBase ("10.1.2.0", "255.255.255.0");

  ipv4Addr.Assign (nd1);

  NS_LOG_INFO ("Configure multicasting.");

  //

  // Now we can configure multicasting.  As described above, the multicast 

  // source is at node zero, which we assigned the IP address of 10.1.1.1 

  // earlier.  We need to define a multicast group to send packets to.  This

  // can be any multicast address from 224.0.0.0 through 239.255.255.255

  // (avoiding the reserved routing protocol addresses).  

  //

  Ipv4Address multicastSource ("10.1.1.1");

  Ipv4Address multicastGroup ("225.1.2.4");

  // Now, we will set up multicast routing.  We need to do three things:

  // 1) Configure a (static) multicast route on node n2

  // 2) Set up a default multicast route on the sender n0 

  // 3) Have node n4 join the multicast group

  // We have a helper that can help us with static multicast

  StaticMulticastRouteHelper multicast;

  // 1) Configure a (static) multicast route on node n2 (multicastRouter)

  Ptr<Node> multicastRouter = c.Get (2);  // The node in question

  Ptr<NetDevice> inputIf = nd0.Get (2);  // The input NetDevice

  NetDeviceContainer outputDevices;  // A container of output NetDevices

  outputDevices.Add (nd1.Get (0));  // (we only need one NetDevice here)

  multicast.AddMulticastRoute (multicastRouter, multicastSource, 

    multicastGroup, inputIf, outputDevices);

  // 2) Set up a default multicast route on the sender n0 

  Ptr<Node> sender = c.Get (0);

  Ptr<NetDevice> senderIf = nd0.Get(0);

  multicast.SetDefaultMulticastRoute (sender, senderIf);

  // 3) Have node n4 join the multicast group

  Ptr<Node> receiver = c.Get (4);

  multicast.JoinMulticastGroup (receiver, multicastSource, multicastGroup);

  //

  // Create an OnOff application to send UDP datagrams from node zero to the

  // multicast group (node four will be listening).

  //

  NS_LOG_INFO ("Create Applications.");

  uint16_t multicastPort = 9;   // Discard port (RFC 863)

  // Configure a multicast packet generator that generates a packet

  // every few seconds

  OnOffHelper onoff ("ns3::UdpSocketFactory", 

    Address (InetSocketAddress (multicastGroup, multicastPort)));

  onoff.SetAttribute ("OnTime", RandomVariableValue (ConstantVariable (1)));

  onoff.SetAttribute ("OffTime", RandomVariableValue (ConstantVariable (0)));

  onoff.SetAttribute ("DataRate", DataRateValue (DataRate ("255b/s")));

  onoff.SetAttribute ("PacketSize", UintegerValue (128));

  ApplicationContainer srcC = onoff.Install (c0.Get (0));

  //

  // Tell the application when to start and stop.

  //

  srcC.Start(Seconds(1.));

  srcC.Stop (Seconds(10.));

  // Create an optional packet sink to receive these packets

  PacketSinkHelper sink ("ns3::UdpSocketFactory",

                         InetSocketAddress (Ipv4Address::GetAny(), multicastPort));

  ApplicationContainer sinkC = sink.Install (c1.Get (2)); // Node n4 

  // Start the sink

  sinkC.Start (Seconds (1.0));

  sinkC.Stop (Seconds (10.0));

  //

  // Configure tracing of all enqueue, dequeue, and NetDevice receive events.

  NS_LOG_INFO ("Configure Tracing.");

  //

  // Ascii trace output will be sent to the file "csma-multicast.tr"

  //

  std::ofstream ascii;

  ascii.open ("csma-multicast.tr");

  CsmaHelper::EnableAsciiAll (ascii);

  // Also configure some tcpdump traces; each interface will be traced.

  // The output files will be named:

  //     csma-multicast.pcap-<nodeId>-<interfaceId>

  // and can be read by the "tcpdump -r" command (use "-tt" option to

  // display timestamps correctly)

  CsmaHelper::EnablePcapAll ("csma-multicast");

  //

  // Now, do the actual simulation.

  //

  NS_LOG_INFO ("Run Simulation.");

  Simulator::Run ();

  Simulator::Destroy ();

  NS_LOG_INFO ("Done.");

}