author | Gustavo J. A. M. Carneiro <gjc@inescporto.pt> |
Mon, 07 Jul 2008 10:26:00 +0100 | |
changeset 3446 | 8491c6c05d22 |
parent 3445 | ae9f7d5e2d56 |
child 3448 | 0bd851bb1225 |
permissions | -rw-r--r-- |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1 |
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
2 |
/* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
3 |
* Copyright (c) 2005,2006 INRIA |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
4 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
5 |
* This program is free software; you can redistribute it and/or modify |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
6 |
* it under the terms of the GNU General Public License version 2 as |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation; |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
8 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
9 |
* This program is distributed in the hope that it will be useful, |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
10 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
11 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
12 |
* GNU General Public License for more details. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
13 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
14 |
* You should have received a copy of the GNU General Public License |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
15 |
* along with this program; if not, write to the Free Software |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
16 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
17 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
18 |
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr> |
975
98233c6c9c2e
Move LLC encapsulation from NetDevice to subclasses.
Emmanuelle Laprise <emmanuelle.laprise@bluekazoo.ca>
parents:
728
diff
changeset
|
19 |
* Modified by Emmanuelle Laprise to remove dependance on LLC headers |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
20 |
*/ |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
21 |
#ifndef NET_DEVICE_H |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
22 |
#define NET_DEVICE_H |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
23 |
|
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
24 |
#include <string> |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
25 |
#include <stdint.h> |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
26 |
#include "ns3/callback.h" |
710
2a9c061219a7
port code from Interface to Object
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
607
diff
changeset
|
27 |
#include "ns3/object.h" |
582
b10ef84683a5
NetDevice and Channel now derive from Interface rather than Object
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
568
diff
changeset
|
28 |
#include "ns3/ptr.h" |
1161
bb72baff8b26
replace MacAddress by Address
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
728
diff
changeset
|
29 |
#include "address.h" |
1443
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
30 |
#include "ipv4-address.h" |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
31 |
|
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
32 |
namespace ns3 { |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
33 |
|
728
95c426b1cb60
rename INode to Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
710
diff
changeset
|
34 |
class Node; |
402
f47285751901
add NetDevice::GetChannel method and doxygen-document it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
401
diff
changeset
|
35 |
class Channel; |
1866
e7dbcc4df546
do not use Packet objects directly. Use Ptr<Packet> instead
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1451
diff
changeset
|
36 |
class Packet; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
37 |
|
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
38 |
/** |
3183 | 39 |
* \ingroup node |
40 |
* \defgroup netdevice NetDevice |
|
41 |
*/ |
|
42 |
/** |
|
3222
f61c17b62fd1
bug 202: classes disappeared from doxygen output
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
3183
diff
changeset
|
43 |
* \ingroup netdevice |
3183 | 44 |
* |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
45 |
* \brief Network layer to device interface |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
46 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
47 |
* This interface defines the API which the IP and ARP |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
48 |
* layers need to access to manage an instance of a network device |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
49 |
* layer. It currently does not support MAC-level |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
50 |
* multicast but this should not be too hard to add by adding |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
51 |
* extra methods to register MAC multicast addresses to |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
52 |
* filter out unwanted packets before handing them to the |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
53 |
* higher layers. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
54 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
55 |
* In Linux, this interface is analogous to the interface |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
56 |
* just above dev_queue_xmit() (i.e., IP packet is fully |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
57 |
* constructed with destination MAC address already selected). |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
58 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
59 |
* If you want to write a new MAC layer, you need to subclass |
378
32bd402ea5ea
remove unused files, remove notion of PHY, make more realistic p2p-net-device and p2p-channel
Craig Dowell
parents:
345
diff
changeset
|
60 |
* this base class and implement your own version of the |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
61 |
* NetDevice::SendTo method. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
62 |
*/ |
710
2a9c061219a7
port code from Interface to Object
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
607
diff
changeset
|
63 |
class NetDevice : public Object |
469
676b647fc960
derive from Object for proper refcounting
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
465
diff
changeset
|
64 |
{ |
676b647fc960
derive from Object for proper refcounting
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
465
diff
changeset
|
65 |
public: |
2251
04963d8cca51
iid (void) -> GetTypeId (void)
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2250
diff
changeset
|
66 |
static TypeId GetTypeId (void); |
487
04c5878c0a61
apply ref/unref rules consistently for Node
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
469
diff
changeset
|
67 |
virtual ~NetDevice(); |
345
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
247
diff
changeset
|
68 |
|
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
69 |
/** |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
70 |
* \param name name of the device (e.g. "eth0") |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
71 |
*/ |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
72 |
virtual void SetName(const std::string name) = 0; |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
73 |
/** |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
74 |
* \return name name of the device (e.g. "eth0") |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
75 |
*/ |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
76 |
virtual std::string GetName(void) const = 0; |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
77 |
/** |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
78 |
* \param index ifIndex of the device |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
79 |
*/ |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
80 |
virtual void SetIfIndex(const uint32_t index) = 0; |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
81 |
/** |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
82 |
* \return index ifIndex of the device |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
83 |
*/ |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
84 |
virtual uint32_t GetIfIndex(void) const = 0; |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
85 |
|
345
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
247
diff
changeset
|
86 |
|
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
87 |
/** |
402
f47285751901
add NetDevice::GetChannel method and doxygen-document it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
401
diff
changeset
|
88 |
* \return the channel this NetDevice is connected to. The value |
f47285751901
add NetDevice::GetChannel method and doxygen-document it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
401
diff
changeset
|
89 |
* returned can be zero if the NetDevice is not yet connected |
f47285751901
add NetDevice::GetChannel method and doxygen-document it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
401
diff
changeset
|
90 |
* to any channel. |
f47285751901
add NetDevice::GetChannel method and doxygen-document it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
401
diff
changeset
|
91 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
92 |
virtual Ptr<Channel> GetChannel (void) const = 0; |
402
f47285751901
add NetDevice::GetChannel method and doxygen-document it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
401
diff
changeset
|
93 |
|
f47285751901
add NetDevice::GetChannel method and doxygen-document it
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
401
diff
changeset
|
94 |
/** |
1161
bb72baff8b26
replace MacAddress by Address
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
728
diff
changeset
|
95 |
* \return the current Address of this interface. |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
96 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
97 |
virtual Address GetAddress (void) const = 0; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
98 |
/** |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
99 |
* \param mtu MTU value, in bytes, to set for the device |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
100 |
* \return whether the MTU value was within legal bounds |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
101 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
102 |
* Override for default MTU defined on a per-type basis. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
103 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
104 |
virtual bool SetMtu (const uint16_t mtu) = 0; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
105 |
/** |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
106 |
* \return the link-level MTU in bytes for this interface. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
107 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
108 |
* This value is typically used by the IP layer to perform |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
109 |
* IP fragmentation when needed. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
110 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
111 |
virtual uint16_t GetMtu (void) const = 0; |
535
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
112 |
/** |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
113 |
* \return true if link is up; false otherwise |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
114 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
115 |
virtual bool IsLinkUp (void) const = 0; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
116 |
/** |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
117 |
* \param callback the callback to invoke |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
118 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
119 |
* Register a callback invoked whenever the link |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
120 |
* status changes to UP. This callback is typically used |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
121 |
* by the IP/ARP layer to flush the ARP cache |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
122 |
* whenever the link goes up. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
123 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
124 |
virtual void SetLinkChangeCallback (Callback<void> callback) = 0; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
125 |
/** |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
126 |
* \return true if this interface supports a broadcast address, |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
127 |
* false otherwise. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
128 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
129 |
virtual bool IsBroadcast (void) const = 0; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
130 |
/** |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
131 |
* \return the broadcast address supported by |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
132 |
* this netdevice. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
133 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
134 |
* Calling this method is invalid if IsBroadcast returns |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
135 |
* not true. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
136 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
137 |
virtual Address GetBroadcast (void) const = 0; |
1441
d6f8a7546e7f
semi-real multicast hardware addresses
Craig Dowell <craigdo@ee.washington.edu>
parents:
1292
diff
changeset
|
138 |
|
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
139 |
/** |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
140 |
* \return value of m_isMulticast flag |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
141 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
142 |
virtual bool IsMulticast (void) const = 0; |
1441
d6f8a7546e7f
semi-real multicast hardware addresses
Craig Dowell <craigdo@ee.washington.edu>
parents:
1292
diff
changeset
|
143 |
|
d6f8a7546e7f
semi-real multicast hardware addresses
Craig Dowell <craigdo@ee.washington.edu>
parents:
1292
diff
changeset
|
144 |
/** |
1443
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
145 |
* \brief Return the MAC multicast base address used when mapping multicast |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
146 |
* groups to MAC multicast addresses. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
147 |
* |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
148 |
* Typically when one constructs a multicast MAC addresses, some bits from |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
149 |
* the IP multicast group are copied into a corresponding MAC multicast |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
150 |
* group. In EUI-48, for example, the low order 23 bits of the multicast |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
151 |
* group are copied to the MAC multicast group base address. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
152 |
* |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
153 |
* This method allows access to the underlying MAC multicast group base |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
154 |
* address. It is expected that in most cases, a net device client will |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
155 |
* allow the net device to perform the actual construction of the multicast |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
156 |
* address. Use of this method is discouraged unless you have a good reason |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
157 |
* to perform a custom mapping. You should prefer |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
158 |
* NetDevice::MakeMulticastAddress which will do the RFC-specified mapping |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
159 |
* for the net device in question. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
160 |
* |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
161 |
* \return The multicast address supported by this net device. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
162 |
* |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
163 |
* \warning Calling this method is invalid if IsMulticast returns not true. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
164 |
* The method NS_ASSERTs if the device is not a multicast device. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
165 |
* \see NetDevice::MakeMulticastAddress |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
166 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
167 |
virtual Address GetMulticast (void) const = 0; |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
168 |
|
1443
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
169 |
/** |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
170 |
* \brief Make and return a MAC multicast address using the provided |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
171 |
* multicast group |
1441
d6f8a7546e7f
semi-real multicast hardware addresses
Craig Dowell <craigdo@ee.washington.edu>
parents:
1292
diff
changeset
|
172 |
* |
1443
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
173 |
* RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
174 |
* multicast address by placing the low-order 23-bits of the IP address into |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
175 |
* the low-order 23 bits of the Ethernet multicast address |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
176 |
* 01-00-5E-00-00-00 (hex). Similar RFCs exist for Ipv6 and Eui64 mappings. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
177 |
* This method performs the multicast address creation function appropriate |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
178 |
* to the underlying MAC address of the device. This MAC address is |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
179 |
* encapsulated in an abstract Address to avoid dependencies on the exact |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
180 |
* MAC address format. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
181 |
* |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
182 |
* A default imlementation of MakeMulticastAddress is provided, but this |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
183 |
* method simply NS_ASSERTS. In the case of net devices that do not support |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
184 |
* multicast, clients are expected to test NetDevice::IsMulticast and avoid |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
185 |
* attempting to map multicast packets. Subclasses of NetDevice that do |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
186 |
* support multicasting are expected to override this method and provide an |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
187 |
* implementation appropriate to the particular device. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
188 |
* |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
189 |
* \param multicastGroup The IP address for the multicast group destination |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
190 |
* of the packet. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
191 |
* \return The MAC multicast Address used to send packets to the provided |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
192 |
* multicast group. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
193 |
* |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
194 |
* \warning Calling this method is invalid if IsMulticast returns not true. |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
195 |
* \see Ipv4Address |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
196 |
* \see Address |
580ed7a4dd1e
Move MakeMulticastAddress to NetDevice
Craig Dowell <craigdo@ee.washington.edu>
parents:
1441
diff
changeset
|
197 |
* \see NetDevice::IsMulticast |
1441
d6f8a7546e7f
semi-real multicast hardware addresses
Craig Dowell <craigdo@ee.washington.edu>
parents:
1292
diff
changeset
|
198 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
199 |
virtual Address MakeMulticastAddress (Ipv4Address multicastGroup) const = 0; |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
200 |
|
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
201 |
/** |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
202 |
* \return value of m_isPointToPoint flag |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
203 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
204 |
virtual bool IsPointToPoint (void) const = 0; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
205 |
/** |
2191 | 206 |
* \param packet packet sent from above down to Network Device |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
207 |
* \param dest mac address of the destination (already resolved) |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
208 |
* \param protocolNumber identifies the type of payload contained in |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
209 |
* this packet. Used to call the right L3Protocol when the packet |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
210 |
* is received. |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
211 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
212 |
* Called from higher layer to send packet into Network Device |
1161
bb72baff8b26
replace MacAddress by Address
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
728
diff
changeset
|
213 |
* to the specified destination Address |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
214 |
* |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
215 |
* \return whether the Send operation succeeded |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
216 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
217 |
virtual bool Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber) = 0; |
535
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
218 |
/** |
3442
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
219 |
* \param packet packet sent from above down to Network Device |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
220 |
* \param source source mac address (so called "MAC spoofing") |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
221 |
* \param dest mac address of the destination (already resolved) |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
222 |
* \param protocolNumber identifies the type of payload contained in |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
223 |
* this packet. Used to call the right L3Protocol when the packet |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
224 |
* is received. |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
225 |
* |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
226 |
* Called from higher layer to send packet into Network Device |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
227 |
* with the specified source and destination Addresses. |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
228 |
* |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
229 |
* \return whether the Send operation succeeded |
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
230 |
*/ |
3446
8491c6c05d22
Backed out changeset ae9f7d5e2d56
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3445
diff
changeset
|
231 |
virtual bool SendFrom(Ptr<Packet> packet, const Address& source, const Address& dest, uint16_t protocolNumber) = 0; |
3442
8eef02250bc9
Add a NetDevice::SendFrom API, for sending packets with a custom source MAC address (a.k.a. MAC spoofing). Only implemented for CsmaNetDevice for now.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3437
diff
changeset
|
232 |
/** |
535
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
233 |
* \returns the node base class which contains this network |
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
234 |
* interface. |
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
235 |
* |
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
236 |
* When a subclass needs to get access to the underlying node |
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
237 |
* base class to print the nodeid for example, it can invoke |
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
238 |
* this method. |
fb6735f93868
Enable both ascii and pcap tracing
Tom Henderson <tomh@tomh.org>
parents:
517
diff
changeset
|
239 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
240 |
virtual Ptr<Node> GetNode (void) const = 0; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
241 |
|
3310
c16ec3c11045
dox missing SetNode method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
3222
diff
changeset
|
242 |
/** |
c16ec3c11045
dox missing SetNode method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
3222
diff
changeset
|
243 |
* \param node the node associated to this netdevice. |
c16ec3c11045
dox missing SetNode method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
3222
diff
changeset
|
244 |
* |
c16ec3c11045
dox missing SetNode method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
3222
diff
changeset
|
245 |
* This method is called from ns3::Node::AddDevice. |
c16ec3c11045
dox missing SetNode method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
3222
diff
changeset
|
246 |
*/ |
2600
6c389d0c717d
add Application::SetNode and NetDevice::SetNode, use them from Node::AddApplication and Node::AddDevice. kill useless "Node" attributes.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2542
diff
changeset
|
247 |
virtual void SetNode (Ptr<Node> node) = 0; |
6c389d0c717d
add Application::SetNode and NetDevice::SetNode, use them from Node::AddApplication and Node::AddDevice. kill useless "Node" attributes.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2542
diff
changeset
|
248 |
|
597
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
249 |
/** |
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
250 |
* \returns true if ARP is needed, false otherwise. |
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
251 |
* |
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
252 |
* Called by higher-layers to check if this NetDevice requires |
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
253 |
* ARP to be used. |
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
254 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
255 |
virtual bool NeedsArp (void) const = 0; |
445
10cd9049a0ad
add NetDevice::NeedsArp method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
415
diff
changeset
|
256 |
|
597
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
257 |
/** |
1186
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
258 |
* \param device a pointer to the net device which is calling this callback |
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
259 |
* \param packet the packet received |
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
260 |
* \param protocol the 16 bit protocol number associated with this packet. |
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
261 |
* This protocol number is expected to be the same protocol number |
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
262 |
* given to the Send method by the user on the sender side. |
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
263 |
* \param address the address of the sender |
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
264 |
* \returns true if the callback could handle the packet successfully, false |
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
265 |
* otherwise. |
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
266 |
*/ |
1866
e7dbcc4df546
do not use Packet objects directly. Use Ptr<Packet> instead
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1451
diff
changeset
|
267 |
typedef Callback<bool,Ptr<NetDevice>,Ptr<Packet>,uint16_t,const Address &> ReceiveCallback; |
1186
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
268 |
|
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
269 |
/** |
597
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
270 |
* \param cb callback to invoke whenever a packet has been received and must |
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
271 |
* be forwarded to the higher layers. |
1186
909e9eb2124e
rework the NetDevice <-> Node interface
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1167
diff
changeset
|
272 |
* |
597
4c8f1400f629
complete dox doc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
592
diff
changeset
|
273 |
*/ |
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
274 |
virtual void SetReceiveCallback (ReceiveCallback cb) = 0; |
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
275 |
|
3435
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
276 |
/** |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
277 |
* \param device a pointer to the net device which is calling this callback |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
278 |
* \param packet the packet received |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
279 |
* \param protocol the 16 bit protocol number associated with this packet. |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
280 |
* This protocol number is expected to be the same protocol number |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
281 |
* given to the Send method by the user on the sender side. |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
282 |
* \param sourceAddress source address |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
283 |
* \param destinationAddress destination address |
3437
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
284 |
* \param forMe true if the packet is normally picked up also for |
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
285 |
* the non-promiscuous callback, false if it is received exclusively |
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
286 |
* by the promiscuous callback. |
3435
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
287 |
* \returns true if the callback could handle the packet successfully, false |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
288 |
* otherwise. |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
289 |
*/ |
3437
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
290 |
typedef Callback<bool,Ptr<NetDevice>,Ptr<Packet>,uint16_t, |
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
291 |
const Address &, const Address &, bool> PromiscuousReceiveCallback; |
3435
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
292 |
|
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
293 |
/** |
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
294 |
* \param cb callback to invoke whenever a packet has been received |
3437
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
295 |
* in promiscuous mode. Note that PromiscuousReceiveCallback |
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
296 |
* handles both packets for the device and packets not for |
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
297 |
* it. In that sense, it receives a superset of packets |
7cec39fe195c
Changes in the promiscuous mode API: now the callback receives everything, both 'for me' and 'not for me', with an additional 'forMe' parameter.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3435
diff
changeset
|
298 |
* received by the normal ReceivedCallback. |
3435
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
299 |
*/ |
3446
8491c6c05d22
Backed out changeset ae9f7d5e2d56
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3445
diff
changeset
|
300 |
virtual void SetPromiscuousReceiveCallback (PromiscuousReceiveCallback cb) = 0; |
3435
1d704c128f1f
Sketching a new promiscuous mode protocol handlers API; Netdevices implementation missing, though.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
3310
diff
changeset
|
301 |
|
234
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
302 |
}; |
6124bda39cb3
code from all trees.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
303 |
|
2470
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
304 |
} // namespace ns3 |
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
305 |
|
254581fb9e9c
make NetDevice fully virtual.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2251
diff
changeset
|
306 |
#endif /* NET_DEVICE_H */ |