NS-3 first.cc

• 注释过的first.cc

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

//包括头文件，命名空间
#include "ns3/core-module.h"
#include "ns3/network-module.h"
#include "ns3/internet-module.h"
#include "ns3/point-to-point-module.h"
#include "ns3/applications-module.h"

using namespace ns3;

NS_LOG_COMPONENT_DEFINE ("FirstScriptExample");
//声明了一个叫 FirstScriptExample 的日志记录组件，它允许你通过引用这一名称，启用和禁用控制台消息日志。

int
main (int argc, char *argv[])
{
  //用户可用命令行来访问代码中全局变量和NS3的属性
  CommandLine cmd;
  cmd.Parse (argc, argv);
  
  //将时间分辨率设置为1纳秒，恰好是一个默认值：
  Time::SetResolution (Time::NS);
  
  //启用在 Echo Client 和 Echo Server 应用中内置的两个日志组件：
  LogComponentEnable ("UdpEchoClientApplication", LOG_LEVEL_INFO);
  LogComponentEnable ("UdpEchoServerApplication", LOG_LEVEL_INFO);

  //NodeContainer: 创建节点
  NodeContainer nodes;
  nodes.Create (2);

  //创建创建点到点的链路，Attribute属性值，这里是速率和时延
  //PointToPointHelper: 创建、配置和安装设备
  PointToPointHelper pointToPoint;
  pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));//设备属性传输速率5Mbps
  pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));//信道延迟2ms

  
  //NetDeviceContainer: 保存所有我们所创建的 NetDevice 对象
  //NodeContainer: 保存我们创建的节点
  //将完成配置设备和通道。第一行声明上面提到的设备容器，第二行挑起重担。PointToPointHelper 的 Install 方法将 NodeContainer 作为参数。在内部创建了一个 NetDeviceContainer。对于每个 NodeContainer 中的节点（对点对点链路而言必须是两个节点）都会创建一个 PointToPointNetDevice 并保存到设备容器中。创建一个 PointToPointChannel 附加两个 PointToPointNetDevices。当对象被 PointToPointHelper 创建，以前在 helper 中设置的属性被用来初始化被创建对象相应的属性。
  NetDeviceContainer devices;//创建设备
  devices = pointToPoint.Install (nodes);
  //执行 pointToPoint.Install（nodes） 调用后，我们将有两个节点，每个节点都有一个已安装的点对点 net device，他们之间有一个单独点对点信道。而这两个设备将被配置为在两毫秒传输延迟的信道上以五兆比特每秒的速率传输数据。

  //安装协议栈
  InternetStackHelper stack;
  stack.Install (nodes);

  
  Ipv4AddressHelper address;
  address.SetBase ("10.1.1.0", "255.255.255.0");
  //分配IP地址，SetBase（IP地址，子网掩码）

  //执行实际上的地址分配。在 ns-3 中我们使用 IPv4Interface 关联 IP 地址和设备。正如我们有时候需要一列由 helper 创建的 net device 以备后用，我们有时也需要一列 Ipv4Interface 对象。而 Ipv4InterfaceContainer 提供了此功能。
  //我们已经建立了一个点对点网络，安装了协议栈并分配了IP地址。此时我们需要的是产生流量的应用。
  Ipv4InterfaceContainer interfaces = address.Assign (devices);

  //UDP echo server  建立端口为9的UDP Server
  UdpEchoServerHelper echoServer (9);

  ApplicationContainer serverApps = echoServer.Install (nodes.Get (1));
  //仿真start和stop时间设置
  serverApps.Start (Seconds (1.0));
  serverApps.Stop (Seconds (10.0));

  //Udp echo client 建立客户端，连接Node1 地址，连接端口为9）
  UdpEchoClientHelper echoClient (interfaces.GetAddress (1), 9);
  echoClient.SetAttribute ("MaxPackets", UintegerValue (1));
  echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.0)));
  echoClient.SetAttribute ("PacketSize", UintegerValue (1024));

  ApplicationContainer clientApps = echoClient.Install (nodes.Get (0));
  clientApps.Start (Seconds (2.0));
  clientApps.Stop (Seconds (10.0));

  
  Simulator::Run ();//运行仿真
  Simulator::Destroy ();//清理所有
  return 0;
}