Network layer to device interface. More...
#include <lr-wpan-net-device.h>
Public Member Functions | |
LrWpanNetDevice (void) | |
virtual | ~LrWpanNetDevice (void) |
virtual void | AddLinkChangeCallback (Callback< void > callback) |
int64_t | AssignStreams (int64_t stream) |
Assign a fixed random variable stream number to the random variables used by this model. More... | |
virtual Address | GetAddress (void) const |
This method indirects to LrWpanMac::SetShortAddress () More... | |
virtual Address | GetBroadcast (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
Ptr< LrWpanCsmaCa > | GetCsmaCa (void) const |
Get the CSMA/CA implementation used by this NetDevice. More... | |
virtual uint32_t | GetIfIndex (void) const |
Ptr< LrWpanMac > | GetMac (void) const |
Get the MAC used by this NetDevice. More... | |
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< LrWpanPhy > | GetPhy (void) const |
Get the PHY used by this NetDevice. More... | |
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... | |
void | McpsDataIndication (McpsDataIndicationParams params, Ptr< Packet > pkt) |
The callback used by the MAC to hand over incoming packets to the NetDevice. 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) |
This method indirects to LrWpanMac::SetShortAddress () More... | |
void | SetChannel (Ptr< SpectrumChannel > channel) |
Set the channel to which the NetDevice, and therefore the PHY, should be attached to. More... | |
void | SetCsmaCa (Ptr< LrWpanCsmaCa > csmaca) |
Set the CSMA/CA implementation to be used by the MAC and this NetDevice. More... | |
virtual void | SetIfIndex (const uint32_t index) |
void | SetMac (Ptr< LrWpanMac > mac) |
Set the MAC to be used by this NetDevice. More... | |
virtual bool | SetMtu (const uint16_t mtu) |
virtual void | SetNode (Ptr< Node > node) |
void | SetPhy (Ptr< LrWpanPhy > phy) |
Set the PHY to be used by the MAC and this NetDevice. More... | |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
virtual bool | SupportsSendFrom (void) const |
![]() | |
virtual | ~NetDevice () |
![]() | |
Object () | |
virtual | ~Object () |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
AggregateIterator | GetAggregateIterator (void) const |
virtual TypeId | GetInstanceTypeId (void) const |
template<typename T > | |
Ptr< T > | GetObject (void) const |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
void | Initialize (void) |
This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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 |
bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
void | SetAttribute (std::string name, const AttributeValue &value) |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
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... | |
Private Member Functions | |
void | CompleteConfig (void) |
Configure PHY, MAC and CSMA/CA. More... | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
Ptr< SpectrumChannel > | DoGetChannel (void) const |
Attribute accessor method for the "Channel" attribute. More... | |
virtual void | DoInitialize (void) |
This method is called only once by Object::Initialize. More... | |
void | LinkDown (void) |
Mark NetDevice link as down. More... | |
void | LinkUp (void) |
Mark NetDevice link as up. More... | |
Private Attributes | |
bool | m_configComplete |
True if MAC, PHY and CSMA/CA where successfully configured and the NetDevice is ready for being used. More... | |
Ptr< LrWpanCsmaCa > | m_csmaca |
The CSMA/CA implementation for this NetDevice. More... | |
uint32_t | m_ifIndex |
The interface index of this NetDevice. More... | |
TracedCallback | m_linkChanges |
Trace source for link up/down changes. More... | |
bool | m_linkUp |
Is the link/device currently up and running? More... | |
Ptr< LrWpanMac > | m_mac |
The MAC for this NetDevice. More... | |
Ptr< Node > | m_node |
The node associated with this NetDevice. More... | |
Ptr< LrWpanPhy > | m_phy |
The PHY for this NetDevice. More... | |
ReceiveCallback | m_receiveCallback |
Upper layer callback used for notification of new data packet arrivals. More... | |
bool | m_useAcks |
Configure the NetDevice to request MAC layer acknowledgments when sending packets using the Send() API. More... | |
Additional Inherited Members | |
![]() | |
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 |
![]() | |
Object (const Object &o) | |
virtual void | NotifyNewAggregate (void) |
This method is invoked whenever two sets of objects are aggregated together. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. More... | |
Network layer to device interface.
The ns3::NetDevice includes IP-specific API such as GetMulticast(), Send() and SendTo() methods, which do not map well the the 802.15.4 MAC MCPS DataRequest primitive. So, the basic design is to provide, as much as makes sense, the class ns3::NetDevice API, but rely on the user accessing the LrWpanMac pointer to make 802.15.4-specific API calls. As such, this is really just an encapsulating class.
ns3::LrWpanNetDevice is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Definition at line 49 of file lr-wpan-net-device.h.
ns3::LrWpanNetDevice::LrWpanNetDevice | ( | void | ) |
Definition at line 71 of file lr-wpan-net-device.cc.
References CompleteConfig(), m_csmaca, m_mac, m_phy, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 81 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
|
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 284 of file lr-wpan-net-device.cc.
References ns3::TracedCallback< T1, T2, T3, T4, T5, T6, T7, T8 >::ConnectWithoutContext(), m_linkChanges, and NS_LOG_FUNCTION.
int64_t ns3::LrWpanNetDevice::AssignStreams | ( | int64_t | stream | ) |
Assign a fixed random variable stream number to the random variables used by this model.
Return the number of streams that have been assigned.
stream | first stream index to use |
Definition at line 461 of file lr-wpan-net-device.cc.
References m_csmaca, m_phy, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
|
private |
Configure PHY, MAC and CSMA/CA.
Definition at line 114 of file lr-wpan-net-device.cc.
References ns3::Object::GetObject(), m_configComplete, m_csmaca, m_mac, m_node, m_phy, ns3::MakeCallback(), McpsDataIndication(), NS_LOG_FUNCTION, ns3::LrWpanMac::PdDataConfirm(), ns3::LrWpanMac::PdDataIndication(), ns3::LrWpanCsmaCa::PlmeCcaConfirm(), ns3::LrWpanMac::PlmeEdConfirm(), ns3::LrWpanMac::PlmeGetAttributeConfirm(), ns3::LrWpanMac::PlmeSetAttributeConfirm(), ns3::LrWpanMac::PlmeSetTRXStateConfirm(), and ns3::LrWpanMac::SetLrWpanMacState().
Referenced by LrWpanNetDevice(), SetChannel(), SetCsmaCa(), SetMac(), SetNode(), and SetPhy().
|
privatevirtual |
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.
It is safe to call GetObject from within this method.
Reimplemented from ns3::Object.
Definition at line 88 of file lr-wpan-net-device.cc.
References ns3::Object::DoDispose(), m_csmaca, m_mac, m_node, m_phy, and NS_LOG_FUNCTION.
|
private |
Attribute accessor method for the "Channel" attribute.
Definition at line 238 of file lr-wpan-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
privatevirtual |
This method is called only once by Object::Initialize.
If the user calls Object::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 104 of file lr-wpan-net-device.cc.
References ns3::Object::DoInitialize(), m_mac, m_phy, and NS_LOG_FUNCTION.
|
virtual |
This method indirects to LrWpanMac::SetShortAddress ()
Implements ns3::NetDevice.
Definition at line 252 of file lr-wpan-net-device.cc.
References m_mac, and NS_LOG_FUNCTION.
Referenced by LrWpanAckTestCase::DataConfirm(), and LrWpanAckTestCase::DataIndication().
|
virtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 298 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
Implements ns3::NetDevice.
Definition at line 215 of file lr-wpan-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
Ptr< LrWpanCsmaCa > ns3::LrWpanNetDevice::GetCsmaCa | ( | void | ) | const |
Get the CSMA/CA implementation used by this NetDevice.
Definition at line 195 of file lr-wpan-net-device.cc.
References m_csmaca, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 208 of file lr-wpan-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
Get the MAC used by this NetDevice.
Definition at line 181 of file lr-wpan-net-device.cc.
References m_mac.
Referenced by LrWpanAckTestCase::DataIndication(), ns3::LrWpanHelper::EnableAsciiInternal(), GetTypeId(), LrWpanCcaTestCase::PhyRxBegin(), LrWpanCcaTestCase::PhyRxDrop(), LrWpanCcaTestCase::PhyRxEnd(), LrWpanCcaTestCase::PhyTxBegin(), LrWpanCcaTestCase::PhyTxEnd(), and LrWpanCcaTestCase::PlmeCcaConfirm().
|
virtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 266 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
Referenced by Send().
|
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 312 of file lr-wpan-net-device.cc.
References NS_ABORT_MSG.
|
virtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 319 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
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 406 of file lr-wpan-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Get the PHY used by this NetDevice.
Definition at line 188 of file lr-wpan-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
Referenced by GetTypeId(), and LrWpanCcaTestCase::PhyRxEnd().
|
static |
Get the type ID.
Definition at line 44 of file lr-wpan-net-device.cc.
References DoGetChannel(), GetMac(), GetPhy(), m_useAcks, SetMac(), ns3::TypeId::SetParent(), and SetPhy().
|
virtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 352 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 291 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 277 of file lr-wpan-net-device.cc.
References m_linkUp, m_phy, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 305 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 359 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
|
private |
Mark NetDevice link as down.
Definition at line 230 of file lr-wpan-net-device.cc.
References m_linkChanges, m_linkUp, and NS_LOG_FUNCTION.
|
private |
Mark NetDevice link as up.
Definition at line 222 of file lr-wpan-net-device.cc.
References m_linkChanges, m_linkUp, and NS_LOG_FUNCTION.
void ns3::LrWpanNetDevice::McpsDataIndication | ( | McpsDataIndicationParams | params, |
Ptr< Packet > | pkt | ||
) |
The callback used by the MAC to hand over incoming packets to the NetDevice.
This callback will in turn use the ReceiveCallback set by SetReceiveCallback() to notify upper layers.
params | 802.15.4 specific parameters, including source and destination addresses |
pkt | the packet do be delivered |
Definition at line 446 of file lr-wpan-net-device.cc.
References m_receiveCallback, ns3::McpsDataIndicationParams::m_srcAddr, and NS_LOG_FUNCTION.
Referenced by CompleteConfig().
|
virtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 421 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION.
|
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 366 of file lr-wpan-net-device.cc.
References ns3::Mac16Address::ConvertFrom(), GetMtu(), ns3::Packet::GetSize(), ns3::McpsDataRequestParams::m_dstAddr, ns3::McpsDataRequestParams::m_dstAddrMode, ns3::McpsDataRequestParams::m_dstPanId, m_mac, ns3::McpsDataRequestParams::m_msduHandle, ns3::McpsDataRequestParams::m_srcAddrMode, ns3::McpsDataRequestParams::m_txOptions, m_useAcks, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::SHORT_ADDR, and ns3::TX_OPTION_ACK.
|
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 398 of file lr-wpan-net-device.cc.
References NS_ABORT_MSG.
|
virtual |
This method indirects to LrWpanMac::SetShortAddress ()
Implements ns3::NetDevice.
Definition at line 245 of file lr-wpan-net-device.cc.
References ns3::Mac16Address::ConvertFrom(), m_mac, and NS_LOG_FUNCTION.
void ns3::LrWpanNetDevice::SetChannel | ( | Ptr< SpectrumChannel > | channel | ) |
Set the channel to which the NetDevice, and therefore the PHY, should be attached to.
channel | the channel to be used |
Definition at line 172 of file lr-wpan-net-device.cc.
References CompleteConfig(), m_phy, and NS_LOG_FUNCTION.
void ns3::LrWpanNetDevice::SetCsmaCa | ( | Ptr< LrWpanCsmaCa > | csmaca | ) |
Set the CSMA/CA implementation to be used by the MAC and this NetDevice.
csmaca | the CSMA/CA implementation to be used |
Definition at line 164 of file lr-wpan-net-device.cc.
References CompleteConfig(), m_csmaca, and NS_LOG_FUNCTION.
|
virtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 201 of file lr-wpan-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
Set the MAC to be used by this NetDevice.
mac | the MAC to be used |
Definition at line 148 of file lr-wpan-net-device.cc.
References CompleteConfig(), m_mac, and NS_LOG_FUNCTION.
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 259 of file lr-wpan-net-device.cc.
References NS_ABORT_MSG.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 413 of file lr-wpan-net-device.cc.
References CompleteConfig(), m_node, and NS_LOG_FUNCTION.
Set the PHY to be used by the MAC and this NetDevice.
phy | the PHY to be used |
Definition at line 156 of file lr-wpan-net-device.cc.
References CompleteConfig(), m_phy, and NS_LOG_FUNCTION.
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 435 of file lr-wpan-net-device.cc.
References NS_LOG_WARN.
|
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 428 of file lr-wpan-net-device.cc.
References m_receiveCallback, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 454 of file lr-wpan-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
private |
True if MAC, PHY and CSMA/CA where successfully configured and the NetDevice is ready for being used.
Definition at line 215 of file lr-wpan-net-device.h.
Referenced by CompleteConfig().
|
private |
The CSMA/CA implementation for this NetDevice.
Definition at line 204 of file lr-wpan-net-device.h.
Referenced by AssignStreams(), CompleteConfig(), DoDispose(), GetCsmaCa(), LrWpanNetDevice(), and SetCsmaCa().
|
private |
The interface index of this NetDevice.
Definition at line 231 of file lr-wpan-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
Trace source for link up/down changes.
Definition at line 236 of file lr-wpan-net-device.h.
Referenced by AddLinkChangeCallback(), LinkDown(), and LinkUp().
|
private |
Is the link/device currently up and running?
Definition at line 226 of file lr-wpan-net-device.h.
Referenced by IsLinkUp(), LinkDown(), and LinkUp().
The MAC for this NetDevice.
Definition at line 194 of file lr-wpan-net-device.h.
Referenced by CompleteConfig(), DoDispose(), DoInitialize(), GetAddress(), GetMac(), LrWpanNetDevice(), Send(), SetAddress(), and SetMac().
The node associated with this NetDevice.
Definition at line 209 of file lr-wpan-net-device.h.
Referenced by CompleteConfig(), DoDispose(), GetNode(), and SetNode().
The PHY for this NetDevice.
Definition at line 199 of file lr-wpan-net-device.h.
Referenced by AssignStreams(), CompleteConfig(), DoDispose(), DoGetChannel(), DoInitialize(), GetChannel(), GetPhy(), IsLinkUp(), LrWpanNetDevice(), SetChannel(), and SetPhy().
|
private |
Upper layer callback used for notification of new data packet arrivals.
Definition at line 241 of file lr-wpan-net-device.h.
Referenced by McpsDataIndication(), and SetReceiveCallback().
|
private |
Configure the NetDevice to request MAC layer acknowledgments when sending packets using the Send() API.
Definition at line 221 of file lr-wpan-net-device.h.
Referenced by GetTypeId(), and Send().