Hold together all Wifi-related objects. More...
#include "wifi-net-device.h"
Public Member Functions | |
WifiNetDevice () | |
virtual | ~WifiNetDevice () |
virtual void | AddLinkChangeCallback (Callback< void > callback) |
virtual Address | GetAddress (void) const |
virtual Address | GetBroadcast (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
virtual uint32_t | GetIfIndex (void) const |
Ptr< WifiMac > | GetMac (void) const |
virtual uint16_t | GetMtu (void) const |
virtual Address | GetMulticast (Ipv4Address multicastGroup) const |
Make and return a MAC multicast address using the provided multicast group. More... | |
virtual Address | GetMulticast (Ipv6Address addr) const |
Get the MAC multicast address corresponding to the IPv6 address provided. More... | |
virtual Ptr< Node > | GetNode (void) const |
Ptr< WifiPhy > | GetPhy (void) const |
Ptr< WifiRemoteStationManager > | GetRemoteStationManager (void) const |
virtual bool | IsBridge (void) const |
Return true if the net device is acting as a bridge. More... | |
virtual bool | IsBroadcast (void) const |
virtual bool | IsLinkUp (void) const |
virtual bool | IsMulticast (void) const |
virtual bool | IsPointToPoint (void) const |
Return true if the net device is on a point-to-point link. More... | |
virtual bool | NeedsArp (void) const |
virtual bool | Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) |
virtual bool | SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) |
virtual void | SetAddress (Address address) |
Set the address of this interface. More... | |
virtual void | SetIfIndex (const uint32_t index) |
void | SetMac (Ptr< WifiMac > mac) |
virtual bool | SetMtu (const uint16_t mtu) |
virtual void | SetNode (Ptr< Node > node) |
void | SetPhy (Ptr< WifiPhy > phy) |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
void | SetRemoteStationManager (Ptr< WifiRemoteStationManager > manager) |
virtual bool | SupportsSendFrom (void) const |
![]() | |
virtual | ~NetDevice () |
![]() | |
Object () | |
Constructor. More... | |
virtual | ~Object () |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose (void) |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator (void) const |
Get an iterator to the Objects aggregated to this one. More... | |
virtual TypeId | GetInstanceTypeId (void) const |
Implement the GetInstanceTypeId method defined in ObjectBase. More... | |
template<typename T > | |
Ptr< T > | GetObject (void) const |
Get a pointer to the requested aggregated Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
void | Initialize (void) |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
![]() | |
SimpleRefCount () | |
Constructor. More... | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising erros. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Protected Member Functions | |
virtual void | DoDispose (void) |
Destructor implementation. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. More... | |
void | ForwardUp (Ptr< Packet > packet, Mac48Address from, Mac48Address to) |
Receive a packet from the lower layer and pass the packet up the stack. More... | |
![]() | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | NotifyNewAggregate (void) |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted (void) |
Notifier called once the ObjectBase is fully constructed. More... | |
Private Member Functions | |
void | CompleteConfig (void) |
Complete the configuration of this Wi-Fi device by connecting all lower components (e.g. More... | |
Ptr< WifiChannel > | DoGetChannel (void) const |
Return the WifiChannel this device is connected to. More... | |
void | LinkDown (void) |
Set that the link is down (i.e. More... | |
void | LinkUp (void) |
Set that the link is up. More... | |
Private Attributes | |
bool | m_configComplete |
NetDevice::ReceiveCallback | m_forwardUp |
uint32_t | m_ifIndex |
TracedCallback | m_linkChanges |
bool | m_linkUp |
Ptr< WifiMac > | m_mac |
uint16_t | m_mtu |
Ptr< Node > | m_node |
Ptr< WifiPhy > | m_phy |
NetDevice::PromiscReceiveCallback | m_promiscRx |
TracedCallback< Ptr< const Packet >, Mac48Address > | m_rxLogger |
Ptr< WifiRemoteStationManager > | m_stationManager |
TracedCallback< Ptr< const Packet >, Mac48Address > | m_txLogger |
Static Private Attributes | |
static const uint16_t | MAX_MSDU_SIZE = 2304 |
Additional Inherited Members | |
![]() | |
typedef void(* | LinkChangeTracedCallback) (void) |
TracedCallback signature for link changed event. More... | |
enum | PacketType { PACKET_HOST = 1, NS3_PACKET_HOST = PACKET_HOST, PACKET_BROADCAST, NS3_PACKET_BROADCAST = PACKET_BROADCAST, PACKET_MULTICAST, NS3_PACKET_MULTICAST = PACKET_MULTICAST, PACKET_OTHERHOST, NS3_PACKET_OTHERHOST = PACKET_OTHERHOST } |
Packet types are used as they are in Linux. More... | |
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, enum PacketType > | PromiscReceiveCallback |
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address & > | ReceiveCallback |
![]() | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Hold together all Wifi-related objects.
This class holds together ns3::WifiChannel, ns3::WifiPhy, ns3::WifiMac, and, ns3::WifiRemoteStationManager.
ns3::WifiNetDevice is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 144 bytes (on a 64-bit architecture).
Definition at line 51 of file wifi-net-device.h.
ns3::WifiNetDevice::WifiNetDevice | ( | ) |
Definition at line 75 of file wifi-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
virtual |
Definition at line 81 of file wifi-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
virtual |
callback | the callback to invoke |
Add a callback invoked whenever the link status changes to UP. This callback is typically used by the IP/ARP layer to flush the ARP cache and by IPv6 stack to flush NDISC cache whenever the link goes up.
Implements ns3::NetDevice.
Definition at line 229 of file wifi-net-device.cc.
References ns3::TracedCallback< T1, T2, T3, T4, T5, T6, T7, T8 >::ConnectWithoutContext(), and m_linkChanges.
|
private |
Complete the configuration of this Wi-Fi device by connecting all lower components (e.g.
MAC, WifiRemoteStation) together.
Definition at line 110 of file wifi-net-device.cc.
References ForwardUp(), LinkDown(), LinkUp(), m_configComplete, m_mac, m_node, m_phy, m_stationManager, ns3::MakeCallback(), ns3::WifiRemoteStationManager::SetupMac(), and ns3::WifiRemoteStationManager::SetupPhy().
Referenced by SetMac(), SetNode(), SetPhy(), and SetRemoteStationManager().
|
protectedvirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.
It is safe to call GetObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 87 of file wifi-net-device.cc.
References ns3::Object::Dispose(), ns3::Object::DoDispose(), m_mac, m_node, m_phy, m_stationManager, and NS_LOG_FUNCTION_NOARGS.
|
private |
Return the WifiChannel this device is connected to.
Definition at line 188 of file wifi-net-device.cc.
References ns3::WifiPhy::GetChannel(), and m_phy.
Referenced by GetTypeId().
|
protectedvirtual |
Initialize() implementation.
This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.
Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 101 of file wifi-net-device.cc.
References ns3::Object::DoInitialize(), ns3::Object::Initialize(), m_mac, m_phy, and m_stationManager.
|
protected |
Receive a packet from the lower layer and pass the packet up the stack.
packet | |
from | |
to |
Definition at line 317 of file wifi-net-device.cc.
References ns3::LlcSnapHeader::GetType(), ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsGroup(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_forwardUp, m_mac, m_promiscRx, ns3::NetDevice::PACKET_BROADCAST, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, ns3::NetDevice::PACKET_OTHERHOST, and ns3::Packet::RemoveHeader().
Referenced by CompleteConfig().
|
virtual |
Implements ns3::NetDevice.
Definition at line 200 of file wifi-net-device.cc.
References m_mac.
Referenced by Bug730TestCase::DoRun(), and OcbWifiMacTestCase::PostDeviceConfiguration().
|
virtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 241 of file wifi-net-device.cc.
References ns3::Mac48Address::GetBroadcast().
Referenced by WifiTest::SendOnePacket(), InterferenceHelperSequenceTest::SendOnePacket(), and Bug555TestCase::SendOnePacket().
Implements ns3::NetDevice.
Definition at line 182 of file wifi-net-device.cc.
References ns3::WifiPhy::GetChannel(), and m_phy.
|
virtual |
Implements ns3::NetDevice.
Definition at line 176 of file wifi-net-device.cc.
References m_ifIndex.
Definition at line 152 of file wifi-net-device.cc.
References m_mac.
Referenced by GetTypeId(), NodeStatistics::NodeStatistics(), and OcbWifiMacTestCase::PostDeviceConfiguration().
|
virtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 217 of file wifi-net-device.cc.
References m_mtu.
Referenced by GetTypeId().
|
virtual |
Make and return a MAC multicast address using the provided multicast group.
RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet multicast address by placing the low-order 23-bits of the IP address into the low-order 23 bits of the Ethernet multicast address 01-00-5E-00-00-00 (hex). Similar RFCs exist for Ipv6 and Eui64 mappings. This method performs the multicast address creation function appropriate to the underlying MAC address of the device. This MAC address is encapsulated in an abstract Address to avoid dependencies on the exact MAC address format.
In the case of net devices that do not support multicast, clients are expected to test NetDevice::IsMulticast and avoid attempting to map multicast packets. Subclasses of NetDevice that do support multicasting are expected to override this method and provide an implementation appropriate to the particular device.
multicastGroup | The IP address for the multicast group destination of the packet. |
Implements ns3::NetDevice.
Definition at line 253 of file wifi-net-device.cc.
References ns3::Mac48Address::GetMulticast().
|
virtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 258 of file wifi-net-device.cc.
References ns3::Mac48Address::GetMulticast().
When a subclass needs to get access to the underlying node base class to print the nodeid for example, it can invoke this method.
Implements ns3::NetDevice.
Definition at line 292 of file wifi-net-device.cc.
References m_node.
Definition at line 158 of file wifi-net-device.cc.
References m_phy.
Referenced by GetTypeId(), NodeStatistics::NodeStatistics(), and InterferenceHelperSequenceTest::SwitchCh().
Ptr< WifiRemoteStationManager > ns3::WifiNetDevice::GetRemoteStationManager | ( | void | ) | const |
Definition at line 164 of file wifi-net-device.cc.
References m_stationManager.
Referenced by GetTypeId(), PowerRateAdaptationTest::TestAparf(), and PowerRateAdaptationTest::TestParf().
|
static |
Definition at line 41 of file wifi-net-device.cc.
References DoGetChannel(), GetMac(), GetMtu(), GetPhy(), GetRemoteStationManager(), ns3::LLC_SNAP_HEADER_LENGTH, ns3::MakePointerAccessor(), ns3::MakeUintegerAccessor(), MAX_MSDU_SIZE, SetMac(), SetMtu(), ns3::TypeId::SetParent(), SetPhy(), and SetRemoteStationManager().
|
virtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 270 of file wifi-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 235 of file wifi-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 223 of file wifi-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 247 of file wifi-net-device.cc.
|
virtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 264 of file wifi-net-device.cc.
|
private |
Set that the link is down (i.e.
STA is not associated).
Definition at line 364 of file wifi-net-device.cc.
References m_linkChanges, and m_linkUp.
Referenced by CompleteConfig().
|
private |
Set that the link is up.
A link is always up in ad-hoc mode. For a STA, a link is up when the STA is associated with an AP.
Definition at line 357 of file wifi-net-device.cc.
References m_linkChanges, and m_linkUp.
Referenced by CompleteConfig().
|
virtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 305 of file wifi-net-device.cc.
|
virtual |
packet | packet sent from above down to Network Device |
dest | mac address of the destination (already resolved) |
protocolNumber | identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received. |
Called from higher layer to send packet into Network Device to the specified destination Address
Implements ns3::NetDevice.
Definition at line 276 of file wifi-net-device.cc.
References ns3::Packet::AddHeader(), ns3::Mac48Address::ConvertFrom(), ns3::Mac48Address::IsMatchingType(), m_mac, NS_ASSERT, and ns3::LlcSnapHeader::SetType().
Referenced by WifiTest::SendOnePacket(), InterferenceHelperSequenceTest::SendOnePacket(), Bug555TestCase::SendOnePacket(), PowerRateAdaptationTest::TestAparf(), and PowerRateAdaptationTest::TestParf().
|
virtual |
packet | packet sent from above down to Network Device |
source | source mac address (so called "MAC spoofing") |
dest | mac address of the destination (already resolved) |
protocolNumber | identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received. |
Called from higher layer to send packet into Network Device with the specified source and destination Addresses.
Implements ns3::NetDevice.
Definition at line 371 of file wifi-net-device.cc.
References ns3::Packet::AddHeader(), ns3::Mac48Address::ConvertFrom(), ns3::Mac48Address::IsMatchingType(), m_mac, NS_ASSERT, and ns3::LlcSnapHeader::SetType().
|
virtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 194 of file wifi-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), and m_mac.
|
virtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 170 of file wifi-net-device.cc.
References m_ifIndex.
mac | the mac layer to use. |
Definition at line 131 of file wifi-net-device.cc.
References CompleteConfig(), m_mac, and third::mac.
Referenced by GetTypeId().
|
virtual |
mtu | MTU value, in bytes, to set for the device |
Override for default MTU defined on a per-type basis.
Implements ns3::NetDevice.
Definition at line 206 of file wifi-net-device.cc.
References ns3::LLC_SNAP_HEADER_LENGTH, m_mtu, and MAX_MSDU_SIZE.
Referenced by GetTypeId().
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 298 of file wifi-net-device.cc.
References CompleteConfig(), and m_node.
phy | the phy layer to use. |
Definition at line 138 of file wifi-net-device.cc.
References CompleteConfig(), m_phy, and third::phy.
Referenced by GetTypeId().
|
virtual |
cb | callback to invoke whenever a packet has been received in promiscuous mode and must be forwarded to the higher layers. |
Enables netdevice promiscuous mode and sets the callback that will handle promiscuous mode packets. Note, promiscuous mode packets means all packets, including those packets that can be sensed by the netdevice but which are intended to be received by other hosts.
Implements ns3::NetDevice.
Definition at line 390 of file wifi-net-device.cc.
References m_mac, and m_promiscRx.
|
virtual |
cb | callback to invoke whenever a packet has been received and must be forwarded to the higher layers. |
Set the callback to be used to notify higher layers when a packet has been received.
Implements ns3::NetDevice.
Definition at line 311 of file wifi-net-device.cc.
References m_forwardUp.
void ns3::WifiNetDevice::SetRemoteStationManager | ( | Ptr< WifiRemoteStationManager > | manager | ) |
manager | the manager to use. |
Definition at line 145 of file wifi-net-device.cc.
References CompleteConfig(), and m_stationManager.
Referenced by GetTypeId().
|
virtual |
Implements ns3::NetDevice.
Definition at line 397 of file wifi-net-device.cc.
References m_mac.
|
private |
Definition at line 167 of file wifi-net-device.h.
Referenced by CompleteConfig().
|
private |
Definition at line 157 of file wifi-net-device.h.
Referenced by ForwardUp(), and SetReceiveCallback().
|
private |
Definition at line 163 of file wifi-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
Definition at line 165 of file wifi-net-device.h.
Referenced by AddLinkChangeCallback(), LinkDown(), and LinkUp().
|
private |
Definition at line 164 of file wifi-net-device.h.
Referenced by IsLinkUp(), LinkDown(), and LinkUp().
Definition at line 155 of file wifi-net-device.h.
Referenced by CompleteConfig(), DoDispose(), DoInitialize(), ForwardUp(), GetAddress(), GetMac(), Send(), SendFrom(), SetAddress(), SetMac(), SetPromiscReceiveCallback(), and SupportsSendFrom().
|
mutableprivate |
Definition at line 166 of file wifi-net-device.h.
Definition at line 153 of file wifi-net-device.h.
Referenced by CompleteConfig(), DoDispose(), GetNode(), and SetNode().
Definition at line 154 of file wifi-net-device.h.
Referenced by CompleteConfig(), DoDispose(), DoGetChannel(), DoInitialize(), GetChannel(), GetPhy(), IsLinkUp(), and SetPhy().
|
private |
Definition at line 158 of file wifi-net-device.h.
Referenced by ForwardUp(), and SetPromiscReceiveCallback().
|
private |
Definition at line 160 of file wifi-net-device.h.
|
private |
Definition at line 156 of file wifi-net-device.h.
Referenced by CompleteConfig(), DoDispose(), DoInitialize(), GetRemoteStationManager(), and SetRemoteStationManager().
|
private |
Definition at line 161 of file wifi-net-device.h.
|
staticprivate |
Definition at line 130 of file wifi-net-device.h.
Referenced by GetTypeId(), and SetMtu().