Hold together all Wifi-related objects. More...
#include <wifi-net-device.h>
Public Member Functions | |
WifiNetDevice () | |
virtual | ~WifiNetDevice () |
void | SetMac (Ptr< WifiMac > mac) |
void | SetPhy (Ptr< WifiPhy > phy) |
void | SetRemoteStationManager (Ptr< WifiRemoteStationManager > manager) |
Ptr< WifiMac > | GetMac (void) const |
Ptr< WifiPhy > | GetPhy (void) const |
Ptr< WifiRemoteStationManager > | GetRemoteStationManager (void) const |
virtual void | SetName (const std::string name) |
virtual std::string | GetName (void) const |
virtual void | SetIfIndex (const uint32_t index) |
virtual uint32_t | GetIfIndex (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
virtual Address | GetAddress (void) const |
virtual bool | SetMtu (const uint16_t mtu) |
virtual uint16_t | GetMtu (void) const |
virtual bool | IsLinkUp (void) const |
virtual void | SetLinkChangeCallback (Callback< void > callback) |
virtual bool | IsBroadcast (void) const |
virtual Address | GetBroadcast (void) const |
virtual bool | IsMulticast (void) const |
virtual Address | GetMulticast (Ipv4Address multicastGroup) const |
Make and return a MAC multicast address using the provided multicast group. | |
virtual bool | IsPointToPoint (void) const |
Return true if the net device is on a point-to-point link. | |
virtual bool | IsBridge (void) const |
Return true if the net device is acting as a bridge. | |
virtual bool | Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) |
virtual Ptr< Node > | GetNode (void) const |
virtual void | SetNode (Ptr< Node > node) |
virtual bool | NeedsArp (void) const |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
virtual Address | GetMulticast (Ipv6Address addr) const |
Get the MAC multicast address corresponding to the IPv6 address provided. | |
virtual bool | SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
virtual bool | SupportsSendFrom (void) const |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
This method returns the TypeId associated to ns3::WifiNetDevice. | |
Private Member Functions | |
virtual void | DoDispose (void) |
void | ForwardUp (Ptr< Packet > packet, Mac48Address from, Mac48Address to) |
void | LinkUp (void) |
void | LinkDown (void) |
void | Setup (void) |
Ptr< WifiChannel > | DoGetChannel (void) const |
void | CompleteConfig (void) |
Private Attributes | |
Ptr< Node > | m_node |
Ptr< WifiPhy > | m_phy |
Ptr< WifiMac > | m_mac |
Ptr< WifiRemoteStationManager > | m_stationManager |
NetDevice::ReceiveCallback | m_forwardUp |
NetDevice::PromiscReceiveCallback | m_promiscRx |
TracedCallback< Ptr< const Packet >, Mac48Address > | m_rxLogger |
TracedCallback< Ptr< const Packet >, Mac48Address > | m_txLogger |
uint32_t | m_ifIndex |
std::string | m_name |
bool | m_linkUp |
Callback< void > | m_linkChange |
uint16_t | m_mtu |
bool | m_configComplete |
Hold together all Wifi-related objects.
This class holds together ns3::WifiChannel, ns3::WifiPhy, ns3::WifiMac, and, ns3::WifiRemoteStationManager.
Definition at line 43 of file wifi-net-device.h.
ns3::WifiNetDevice::WifiNetDevice | ( | ) |
Definition at line 68 of file wifi-net-device.cc.
ns3::WifiNetDevice::~WifiNetDevice | ( | ) | [virtual] |
Definition at line 72 of file wifi-net-device.cc.
void ns3::WifiNetDevice::CompleteConfig | ( | void | ) | [private] |
Definition at line 90 of file wifi-net-device.cc.
References ForwardUp(), LinkDown(), LinkUp(), m_configComplete, m_mac, m_node, m_phy, m_stationManager, and ns3::MakeCallback().
Referenced by SetMac(), SetNode(), SetPhy(), and SetRemoteStationManager().
void ns3::WifiNetDevice::DoDispose | ( | void | ) | [private, virtual] |
This method is called by Object::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.
Reimplemented from ns3::Object.
Definition at line 76 of file wifi-net-device.cc.
References m_mac, m_node, m_phy, and m_stationManager.
Ptr< WifiChannel > ns3::WifiNetDevice::DoGetChannel | ( | void | ) | const [private] |
void ns3::WifiNetDevice::ForwardUp | ( | Ptr< Packet > | packet, | |
Mac48Address | from, | |||
Mac48Address | to | |||
) | [private] |
Definition at line 284 of file wifi-net-device.cc.
References ns3::LlcSnapHeader::GetType(), ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsMulticast(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_forwardUp, m_mac, m_promiscRx, m_rxLogger, ns3::NetDevice::PACKET_BROADCAST, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, and ns3::NetDevice::PACKET_OTHERHOST.
Referenced by CompleteConfig().
Address ns3::WifiNetDevice::GetAddress | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 174 of file wifi-net-device.cc.
References m_mac.
Address ns3::WifiNetDevice::GetBroadcast | ( | void | ) | const [virtual] |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 217 of file wifi-net-device.cc.
Implements ns3::NetDevice.
Definition at line 164 of file wifi-net-device.cc.
References m_phy.
uint32_t ns3::WifiNetDevice::GetIfIndex | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 159 of file wifi-net-device.cc.
References m_ifIndex.
Definition at line 128 of file wifi-net-device.cc.
References m_mac.
Referenced by GetTypeId().
uint16_t ns3::WifiNetDevice::GetMtu | ( | void | ) | const [virtual] |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 191 of file wifi-net-device.cc.
References ns3::UintegerValue::Get(), m_mac, and m_mtu.
Address ns3::WifiNetDevice::GetMulticast | ( | Ipv6Address | addr | ) | const [virtual] |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 231 of file wifi-net-device.cc.
References GetMulticast().
Address ns3::WifiNetDevice::GetMulticast | ( | Ipv4Address | multicastGroup | ) | const [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.
A default imlementation of GetMulticast is provided, but this method simply NS_ASSERTS. 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 227 of file wifi-net-device.cc.
Referenced by GetMulticast().
std::string ns3::WifiNetDevice::GetName | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 149 of file wifi-net-device.cc.
References m_name.
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 262 of file wifi-net-device.cc.
References m_node.
Definition at line 133 of file wifi-net-device.cc.
References m_phy.
Referenced by GetTypeId().
Ptr< WifiRemoteStationManager > ns3::WifiNetDevice::GetRemoteStationManager | ( | void | ) | const |
Definition at line 138 of file wifi-net-device.cc.
References m_stationManager.
Referenced by GetTypeId().
TypeId ns3::WifiNetDevice::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::WifiNetDevice.
This object is accessible through the following paths with Config::Set and Config::Connect:
Attributes defined for this type:
Attributes defined in parent class ns3::NetDevice:
TraceSources defined for this type:
Reimplemented from ns3::NetDevice.
Definition at line 37 of file wifi-net-device.cc.
References ns3::TypeId::AddAttribute(), ns3::TypeId::AddTraceSource(), DoGetChannel(), GetMac(), GetPhy(), GetRemoteStationManager(), m_rxLogger, m_txLogger, ns3::MakeTraceSourceAccessor(), SetMac(), ns3::TypeId::SetParent(), SetPhy(), and SetRemoteStationManager().
bool ns3::WifiNetDevice::IsBridge | ( | void | ) | const [virtual] |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 241 of file wifi-net-device.cc.
bool ns3::WifiNetDevice::IsBroadcast | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 212 of file wifi-net-device.cc.
bool ns3::WifiNetDevice::IsLinkUp | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 202 of file wifi-net-device.cc.
bool ns3::WifiNetDevice::IsMulticast | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 222 of file wifi-net-device.cc.
bool ns3::WifiNetDevice::IsPointToPoint | ( | void | ) | const [virtual] |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 236 of file wifi-net-device.cc.
void ns3::WifiNetDevice::LinkDown | ( | void | ) | [private] |
Definition at line 326 of file wifi-net-device.cc.
References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_linkChange, and m_linkUp.
Referenced by CompleteConfig().
void ns3::WifiNetDevice::LinkUp | ( | void | ) | [private] |
Definition at line 317 of file wifi-net-device.cc.
References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_linkChange, and m_linkUp.
Referenced by CompleteConfig().
bool ns3::WifiNetDevice::NeedsArp | ( | void | ) | const [virtual] |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 273 of file wifi-net-device.cc.
bool ns3::WifiNetDevice::Send | ( | Ptr< Packet > | packet, | |
const Address & | dest, | |||
uint16_t | protocolNumber | |||
) | [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 246 of file wifi-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), ns3::Mac48Address::IsMatchingType(), m_mac, m_txLogger, NS_ASSERT, and ns3::LlcSnapHeader::SetType().
bool ns3::WifiNetDevice::SendFrom | ( | Ptr< Packet > | packet, | |
const Address & | source, | |||
const Address & | dest, | |||
uint16_t | protocolNumber | |||
) | [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 336 of file wifi-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), ns3::Mac48Address::IsMatchingType(), m_mac, m_txLogger, NS_ASSERT, and ns3::LlcSnapHeader::SetType().
void ns3::WifiNetDevice::SetIfIndex | ( | const uint32_t | index | ) | [virtual] |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 154 of file wifi-net-device.cc.
References m_ifIndex.
void ns3::WifiNetDevice::SetLinkChangeCallback | ( | Callback< void > | callback | ) | [virtual] |
callback | the callback to invoke |
Register 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 whenever the link goes up.
Implements ns3::NetDevice.
Definition at line 207 of file wifi-net-device.cc.
References m_linkChange.
mac | the mac layer to use. |
Definition at line 110 of file wifi-net-device.cc.
References CompleteConfig(), and m_mac.
Referenced by GetTypeId().
bool ns3::WifiNetDevice::SetMtu | ( | const uint16_t | mtu | ) | [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 179 of file wifi-net-device.cc.
References ns3::UintegerValue::Get(), m_mac, and m_mtu.
void ns3::WifiNetDevice::SetName | ( | const std::string | name | ) | [virtual] |
name | name of the device (e.g. "eth0") |
Implements ns3::NetDevice.
Definition at line 144 of file wifi-net-device.cc.
References m_name.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 267 of file wifi-net-device.cc.
References CompleteConfig(), and m_node.
phy | the phy layer to use. |
Definition at line 116 of file wifi-net-device.cc.
References CompleteConfig(), and m_phy.
Referenced by GetTypeId().
void ns3::WifiNetDevice::SetPromiscReceiveCallback | ( | PromiscReceiveCallback | cb | ) | [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 356 of file wifi-net-device.cc.
References m_promiscRx.
void ns3::WifiNetDevice::SetReceiveCallback | ( | NetDevice::ReceiveCallback | cb | ) | [virtual] |
cb | callback to invoke whenever a packet has been received and must be forwarded to the higher layers. |
Implements ns3::NetDevice.
Definition at line 278 of file wifi-net-device.cc.
References m_forwardUp.
void ns3::WifiNetDevice::SetRemoteStationManager | ( | Ptr< WifiRemoteStationManager > | manager | ) |
manager | the manager to use. |
Definition at line 122 of file wifi-net-device.cc.
References CompleteConfig(), and m_stationManager.
Referenced by GetTypeId().
void ns3::WifiNetDevice::Setup | ( | void | ) | [private] |
bool ns3::WifiNetDevice::SupportsSendFrom | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Definition at line 362 of file wifi-net-device.cc.
References m_mac.
bool ns3::WifiNetDevice::m_configComplete [private] |
Definition at line 128 of file wifi-net-device.h.
Referenced by CompleteConfig().
Definition at line 119 of file wifi-net-device.h.
Referenced by ForwardUp(), and SetReceiveCallback().
uint32_t ns3::WifiNetDevice::m_ifIndex [private] |
Definition at line 123 of file wifi-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
Callback<void> ns3::WifiNetDevice::m_linkChange [private] |
Definition at line 126 of file wifi-net-device.h.
Referenced by LinkDown(), LinkUp(), and SetLinkChangeCallback().
bool ns3::WifiNetDevice::m_linkUp [private] |
Definition at line 125 of file wifi-net-device.h.
Referenced by IsLinkUp(), LinkDown(), and LinkUp().
Ptr<WifiMac> ns3::WifiNetDevice::m_mac [private] |
Definition at line 117 of file wifi-net-device.h.
Referenced by CompleteConfig(), DoDispose(), ForwardUp(), GetAddress(), GetMac(), GetMtu(), Send(), SendFrom(), SetMac(), SetMtu(), and SupportsSendFrom().
uint16_t ns3::WifiNetDevice::m_mtu [mutable, private] |
Definition at line 127 of file wifi-net-device.h.
std::string ns3::WifiNetDevice::m_name [private] |
Definition at line 124 of file wifi-net-device.h.
Ptr<Node> ns3::WifiNetDevice::m_node [private] |
Definition at line 115 of file wifi-net-device.h.
Referenced by CompleteConfig(), DoDispose(), GetNode(), and SetNode().
Ptr<WifiPhy> ns3::WifiNetDevice::m_phy [private] |
Definition at line 116 of file wifi-net-device.h.
Referenced by CompleteConfig(), DoDispose(), DoGetChannel(), GetChannel(), GetPhy(), IsLinkUp(), and SetPhy().
Definition at line 120 of file wifi-net-device.h.
Referenced by ForwardUp(), and SetPromiscReceiveCallback().
TracedCallback<Ptr<const Packet>, Mac48Address> ns3::WifiNetDevice::m_rxLogger [private] |
Definition at line 121 of file wifi-net-device.h.
Referenced by ForwardUp(), and GetTypeId().
Definition at line 118 of file wifi-net-device.h.
Referenced by CompleteConfig(), DoDispose(), GetRemoteStationManager(), and SetRemoteStationManager().
TracedCallback<Ptr<const Packet>, Mac48Address> ns3::WifiNetDevice::m_txLogger [private] |
Definition at line 122 of file wifi-net-device.h.
Referenced by GetTypeId(), Send(), and SendFrom().