src/node/node.h
author Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
Wed, 16 Jul 2008 16:06:50 +0100
changeset 3460 99698bc858e8
parent 3450 73e90de6eb47
child 3516 dacc57c5d31f
permissions -rw-r--r--
New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1175
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     2
/*
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     3
 * Copyright (c) 2006 Georgia Tech Research Corporation, INRIA
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     4
 *
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     7
 * published by the Free Software Foundation;
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     8
 *
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    12
 * GNU General Public License for more details.
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    13
 *
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    14
 * You should have received a copy of the GNU General Public License
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    15
 * along with this program; if not, write to the Free Software
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    17
 *
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    18
 * Authors: George F. Riley<riley@ece.gatech.edu>
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    19
 *          Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    20
 */
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    21
#ifndef NODE_H
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
    22
#define NODE_H
232
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    23
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    24
#include <vector>
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    25
710
2a9c061219a7 port code from Interface to Object
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 607
diff changeset
    26
#include "ns3/object.h"
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
    27
#include "ns3/callback.h"
1866
e7dbcc4df546 do not use Packet objects directly. Use Ptr<Packet> instead
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1412
diff changeset
    28
#include "ns3/ptr.h"
3448
0bd851bb1225 Simplify promiscuous mode API: NetDevices always operate in promiscuous mode, normal receive callbacks receive extra destination address and packet type.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3437
diff changeset
    29
#include "ns3/net-device.h"
355
d18da75542c7 Add static node factory methods to class Node
Tom Henderson <tomh@tomh.org>
parents: 345
diff changeset
    30
232
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    31
namespace ns3 {
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    32
585
a009b03b720a remove ApplicationList. Move functionality to Node class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 580
diff changeset
    33
class Application;
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
    34
class Packet;
1186
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    35
class Address;
232
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    36
2182
13c8ebd1a19e add application tracing support
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1866
diff changeset
    37
13c8ebd1a19e add application tracing support
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1866
diff changeset
    38
/**
3183
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 3021
diff changeset
    39
 * \ingroup node
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 3021
diff changeset
    40
 *
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    41
 * \brief A network Node.
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    42
 *
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    43
 * This class holds together:
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    44
 *   - a list of NetDevice objects which represent the network interfaces
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    45
 *     of this node which are connected to other Node instances through
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    46
 *     Channel instances.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    47
 *   - a list of Application objects which represent the userspace
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    48
 *     traffic generation applications which interact with the Node
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    49
 *     through the Socket API.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    50
 *   - a node Id: a unique per-node identifier.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    51
 *   - a system Id: a unique Id used for parallel simulations.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    52
 *
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    53
 * Every Node created is added to the NodeList automatically.
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    54
 */
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    55
class Node : public Object
484
cf7fbb84d74b rework the Node and NodeList classes to manage reference counts correctly
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 482
diff changeset
    56
{
512
5404e1e41f82 make Node derive from NsUnknown rather than Object
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 484
diff changeset
    57
public:
2251
04963d8cca51 iid (void) -> GetTypeId (void)
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2250
diff changeset
    58
  static TypeId GetTypeId (void);
361
9b159ff6dbcb Clean up parameter passing per TOm's request
George F. Riley<riley@ece.gatech.edu>
parents: 359
diff changeset
    59
1186
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    60
  /**
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    61
   * Must be invoked by subclasses only.
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    62
   */
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    63
  Node();
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    64
  /**
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    65
   * \param systemId a unique integer used for parallel simulations.
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    66
   *
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    67
   * Must be invoked by subclasses only.
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    68
   */
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    69
  Node(uint32_t systemId);
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    70
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    71
  virtual ~Node();
244
caff04d90a66 remove SetNodeId and implement GetId and GetSystemId
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 242
diff changeset
    72
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    73
  /**
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    74
   * \returns the unique id of this node.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    75
   * 
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    76
   * This unique id happens to be also the index of the Node into
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    77
   * the NodeList. 
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    78
   */
244
caff04d90a66 remove SetNodeId and implement GetId and GetSystemId
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 242
diff changeset
    79
  uint32_t GetId (void) const;
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    80
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    81
  /**
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    82
   * \returns the system id for parallel simulations associated
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    83
   *          to this node.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    84
   */
244
caff04d90a66 remove SetNodeId and implement GetId and GetSystemId
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 242
diff changeset
    85
  uint32_t GetSystemId (void) const;
232
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    86
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    87
  /**
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    88
   * \param device NetDevice to associate to this node.
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    89
   * \returns the index of the NetDevice into the Node's list of
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    90
   *          NetDevice.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    91
   *
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    92
   * Associate this device to this node.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    93
   */
568
e1660959ecbb use Ptr<> everywhere Object or NsUnknown are used
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 525
diff changeset
    94
  uint32_t AddDevice (Ptr<NetDevice> device);
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    95
  /**
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
    96
   * \param index the index of the requested NetDevice
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
    97
   * \returns the requested NetDevice associated to this Node.
1186
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    98
   *
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
    99
   * The indexes used by the GetDevice method start at one and
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
   100
   * end at GetNDevices ()
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   101
   */
568
e1660959ecbb use Ptr<> everywhere Object or NsUnknown are used
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 525
diff changeset
   102
  Ptr<NetDevice> GetDevice (uint32_t index) const;
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   103
  /**
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   104
   * \returns the number of NetDevice instances associated
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   105
   *          to this Node.
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   106
   */
447
180117abfb04 add NetDevice list into Node base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 381
diff changeset
   107
  uint32_t GetNDevices (void) const;
180117abfb04 add NetDevice list into Node base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 381
diff changeset
   108
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   109
  /**
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   110
   * \param application Application to associate to this node.
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   111
   * \returns the index of the Application within the Node's list
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   112
   *          of Application.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   113
   *
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   114
   * Associated this Application to this Node. This method is called
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   115
   * automatically from Application::Application so the user
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   116
   * has little reasons to call this method directly.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   117
   */
585
a009b03b720a remove ApplicationList. Move functionality to Node class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 580
diff changeset
   118
  uint32_t AddApplication (Ptr<Application> application);
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   119
  /**
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   120
   * \param index
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   121
   * \returns the application associated to this requested index
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   122
   *          within this Node.
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   123
   */
585
a009b03b720a remove ApplicationList. Move functionality to Node class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 580
diff changeset
   124
  Ptr<Application> GetApplication (uint32_t index) const;
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   125
  /**
3380
38b8549b1ad3 Minor doc notes added to ipv4.h
tjkopena@cs.drexel.edu
parents: 3308
diff changeset
   126
   * \param index
38b8549b1ad3 Minor doc notes added to ipv4.h
tjkopena@cs.drexel.edu
parents: 3308
diff changeset
   127
   * \returns the application associated to this requested index
38b8549b1ad3 Minor doc notes added to ipv4.h
tjkopena@cs.drexel.edu
parents: 3308
diff changeset
   128
   *          within this Node.
38b8549b1ad3 Minor doc notes added to ipv4.h
tjkopena@cs.drexel.edu
parents: 3308
diff changeset
   129
   */
38b8549b1ad3 Minor doc notes added to ipv4.h
tjkopena@cs.drexel.edu
parents: 3308
diff changeset
   130
  Ptr<Application> GetFirstApplication (TypeId tid);
38b8549b1ad3 Minor doc notes added to ipv4.h
tjkopena@cs.drexel.edu
parents: 3308
diff changeset
   131
38b8549b1ad3 Minor doc notes added to ipv4.h
tjkopena@cs.drexel.edu
parents: 3308
diff changeset
   132
  /**
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   133
   * \returns the number of applications associated to this Node.
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   134
   */
585
a009b03b720a remove ApplicationList. Move functionality to Node class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 580
diff changeset
   135
  uint32_t GetNApplications (void) const;
a009b03b720a remove ApplicationList. Move functionality to Node class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 580
diff changeset
   136
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   137
  /**
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   138
   * A protocol handler
3460
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   139
   *
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   140
   * \param device a pointer to the net device which received the packet
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   141
   * \param packet the packet received
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   142
   * \param protocol the 16 bit protocol number associated with this packet.
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   143
   *        This protocol number is expected to be the same protocol number
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   144
   *        given to the Send method by the user on the sender side.
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   145
   * \param sender the address of the sender
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   146
   * \param receiver the address of the receiver; Note: this value is
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   147
   *                 only valid for promiscuous mode protocol
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   148
   *                 handlers.
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   149
   * \param packetType type of packet received
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   150
   *                   (broadcast/multicast/unicast/otherhost); Note:
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   151
   *                   this value is only valid for promiscuous mode
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   152
   *                   protocol handlers.
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   153
   */
3448
0bd851bb1225 Simplify promiscuous mode API: NetDevices always operate in promiscuous mode, normal receive callbacks receive extra destination address and packet type.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3437
diff changeset
   154
  typedef Callback<void,Ptr<NetDevice>, Ptr<Packet>,uint16_t,const Address &,
0bd851bb1225 Simplify promiscuous mode API: NetDevices always operate in promiscuous mode, normal receive callbacks receive extra destination address and packet type.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3437
diff changeset
   155
                   const Address &, NetDevice::PacketType> ProtocolHandler;
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   156
  /**
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   157
   * \param handler the handler to register
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   158
   * \param protocolType the type of protocol this handler is 
1186
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
   159
   *        interested in. This protocol type is a so-called
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
   160
   *        EtherType, as registered here:
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
   161
   *        http://standards.ieee.org/regauth/ethertype/eth.txt
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
   162
   *        the value zero is interpreted as matching all
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
   163
   *        protocols.
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   164
   * \param device the device attached to this handler. If the
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   165
   *        value is zero, the handler is attached to all
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   166
   *        devices on this node.
3460
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   167
   * \param promiscuous whether to register a promiscuous mode handler
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   168
   */
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   169
  void RegisterProtocolHandler (ProtocolHandler handler, 
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   170
                                uint16_t protocolType,
3460
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   171
                                Ptr<NetDevice> device,
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   172
                                bool promiscuous=false);
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   173
  /**
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   174
   * \param handler the handler to unregister
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   175
   *
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   176
   * After this call returns, the input handler will never
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   177
   * be invoked anymore.
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   178
   */
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   179
  void UnregisterProtocolHandler (ProtocolHandler handler);
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   180
3435
1d704c128f1f Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3308
diff changeset
   181
513
b7c7ea629de9 make L3Demux an NsUnknown object.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 512
diff changeset
   182
protected:
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   183
  /**
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   184
   * The dispose method. Subclasses must override this method
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   185
   * and must chain up to it by calling Node::DoDispose at the
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   186
   * end of their own DoDispose method.
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   187
   */
513
b7c7ea629de9 make L3Demux an NsUnknown object.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 512
diff changeset
   188
  virtual void DoDispose (void);
447
180117abfb04 add NetDevice list into Node base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 381
diff changeset
   189
private:
1341
f685d4bf320f use the Object::GetTraceResolver tracing support rather than the old adhoc tracing code
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1333
diff changeset
   190
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   191
  /**
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   192
   * \param device the device added to this Node.
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   193
   *
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   194
   * This method is invoked whenever a user calls Node::AddDevice.
595
3e77d7b90b9c add dox documentation for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 594
diff changeset
   195
   */
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   196
  virtual void NotifyDeviceAdded (Ptr<NetDevice> device);
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   197
3460
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   198
  bool NonPromiscReceiveFromDevice (Ptr<NetDevice> device, Ptr<Packet>, uint16_t protocol, const Address &from);
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   199
  bool PromiscReceiveFromDevice (Ptr<NetDevice> device, Ptr<Packet>, uint16_t protocol,
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   200
                                 const Address &from, const Address &to, NetDevice::PacketType packetType);
3448
0bd851bb1225 Simplify promiscuous mode API: NetDevices always operate in promiscuous mode, normal receive callbacks receive extra destination address and packet type.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3437
diff changeset
   201
  bool ReceiveFromDevice (Ptr<NetDevice> device, Ptr<Packet>, uint16_t protocol,
3460
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   202
                          const Address &from, const Address &to, NetDevice::PacketType packetType, bool promisc);
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   203
1186
909e9eb2124e rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1176
diff changeset
   204
  void Construct (void);
447
180117abfb04 add NetDevice list into Node base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 381
diff changeset
   205
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   206
  struct ProtocolHandlerEntry {
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   207
    ProtocolHandler handler;
3460
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   208
    Ptr<NetDevice> device;
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   209
    uint16_t protocol;
3460
99698bc858e8 New API considering comments from Craig: NetDevice->Node uses two callbacks; Node->ProtocolHandlers uses a single API with a promiscuous flag.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3450
diff changeset
   210
    bool promiscuous;
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   211
  };
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   212
  typedef std::vector<struct Node::ProtocolHandlerEntry> ProtocolHandlerList;
728
95c426b1cb60 rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 710
diff changeset
   213
  uint32_t    m_id;         // Node id for this node
244
caff04d90a66 remove SetNodeId and implement GetId and GetSystemId
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 242
diff changeset
   214
  uint32_t    m_sid;        // System id for this node
568
e1660959ecbb use Ptr<> everywhere Object or NsUnknown are used
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 525
diff changeset
   215
  std::vector<Ptr<NetDevice> > m_devices;
585
a009b03b720a remove ApplicationList. Move functionality to Node class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 580
diff changeset
   216
  std::vector<Ptr<Application> > m_applications;
1176
4894ea885c0f implement the Node::ProtocolHandler support.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1175
diff changeset
   217
  ProtocolHandlerList m_handlers;
3435
1d704c128f1f Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3308
diff changeset
   218
232
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   219
};
8cd08910f9a1 initial node base class from george's repo.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   220
355
d18da75542c7 Add static node factory methods to class Node
Tom Henderson <tomh@tomh.org>
parents: 345
diff changeset
   221
} //namespace ns3
605
3a62e5c4de75 rename internet-node.h to i-node-impl.h
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 604
diff changeset
   222
1175
00ad4ec69939 small cleanups
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 936
diff changeset
   223
#endif /* NODE_H */