Link Layer to device interface The ns3::NetDevice includes IP-specefic API which does not map well with the BLE protocol. More...
#include "ble-netdevice.h"
Public Member Functions | |
BleNetDevice (void) | |
virtual | ~BleNetDevice (void) |
virtual void | AddLinkChangeCallback (Callback< void > callback) |
void | CompleteConfig (void) |
Complete all configurations By using this function, linklayer, PHY, Channel and NetDevice are interconnected. More... | |
virtual Address | GetAddress (void) const |
virtual Address | GetBroadcast (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
virtual uint32_t | GetIfIndex (void) const |
Ptr< BleLinkLayer > | GetLinkLayer (void) const |
Get the LinkLayer used by this Net Device. More... | |
virtual Mac48Address | GetMacAddress (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< BlePhy > | GetPhy (void) const |
Get PHY to be used by the link layer and this Net Device. 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... | |
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... | |
void | SetChannel (Ptr< SpectrumChannel > channel) |
Set Channel to which the Net Device, and therefore the PHY, should be attached to. More... | |
virtual void | SetIfIndex (const uint32_t index) |
void | SetLinkLayer (Ptr< BleLinkLayer > ll) |
Set the LinkLayer to be used by this NetDevice. More... | |
virtual void | SetMacAddress (Mac48Address address) |
Get Addresses in Mac48Address Type. More... | |
virtual bool | SetMtu (const uint16_t mtu) |
virtual void | SetNode (Ptr< Node > node) |
void | SetPhy (Ptr< BlePhy > phy) |
Set PHY to be used by the Link Layer and this NetDevice. More... | |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
virtual bool | SupportsSendFrom (void) const |
Public Member Functions inherited from ns3::NetDevice | |
virtual | ~NetDevice () |
Public Member Functions inherited from ns3::Object | |
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... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
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... | |
Public Member Functions inherited from ns3::ObjectBase | |
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) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::NetDevice | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Noop. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
virtual void | DoDispose (void) |
Destructor implementation. More... | |
Ptr< SpectrumChannel > | DoGetChannel (void) const |
Attribute accessor method for the "Channel" attribute. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. More... | |
Private Attributes | |
Address | m_addr |
BDA Address of this device. More... | |
bool | m_completeConfig |
Whether the configuration is complete or not. More... | |
uint32_t | m_ifIndex |
Ptr< BleLinkLayer > | m_linkLayer |
The Link Layer for this NetDevice. More... | |
bool | m_linkUp |
Is LinkUp? More... | |
Mac48Address | m_macAddr |
BDA address with Mac48Address format. More... | |
Ptr< Node > | m_node |
Node associated with the NetDevice. More... | |
Ptr< BlePhy > | m_phy |
The PHY for this NetDevice. More... | |
Additional Inherited Members | |
Public Types inherited from ns3::NetDevice | |
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 |
Protected Member Functions inherited from ns3::Object | |
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... | |
Protected Member Functions inherited from ns3::ObjectBase | |
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... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Link Layer to device interface The ns3::NetDevice includes IP-specefic API which does not map well with the BLE protocol.
So, this class provides the basic design to provide a connection between Node, PHY, Channel and NetDevice. There is as such no use of this class in the module but it is possible that some inherited function needs a Net Device class as parameter. Other possible requirement is when using other modules like wifi etc. along with BLE. This class can get along with classes with base class NetDevice.
ns3::BleNetDevice is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 96 bytes (on a 64-bit architecture).
Definition at line 49 of file ble-netdevice.h.
ns3::BleNetDevice::BleNetDevice | ( | void | ) |
Definition at line 60 of file ble-netdevice.cc.
References m_completeConfig, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 66 of file ble-netdevice.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 245 of file ble-netdevice.cc.
References NS_ABORT_MSG, and NS_LOG_FUNCTION.
void ns3::BleNetDevice::CompleteConfig | ( | void | ) |
Complete all configurations By using this function, linklayer, PHY, Channel and NetDevice are interconnected.
Set functions of all these components are used
Definition at line 93 of file ble-netdevice.cc.
References ns3::Object::GetObject(), m_completeConfig, m_linkLayer, m_node, m_phy, third::mobility, NS_LOG_FUNCTION, and NS_LOG_WARN.
|
privatevirtual |
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 72 of file ble-netdevice.cc.
References ns3::Object::DoDispose(), m_linkLayer, m_node, m_phy, and NS_LOG_FUNCTION.
|
private |
Attribute accessor method for the "Channel" attribute.
Definition at line 173 of file ble-netdevice.cc.
References m_phy, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
privatevirtual |
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 84 of file ble-netdevice.cc.
References ns3::Object::DoInitialize(), m_linkLayer, m_phy, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 217 of file ble-netdevice.cc.
References m_addr, and NS_LOG_FUNCTION.
|
virtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 259 of file ble-netdevice.cc.
References m_addr, NS_ABORT_MSG, and NS_LOG_FUNCTION.
Implements ns3::NetDevice.
Definition at line 166 of file ble-netdevice.cc.
References m_phy, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 159 of file ble-netdevice.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
Ptr< BleLinkLayer > ns3::BleNetDevice::GetLinkLayer | ( | void | ) | const |
Get the LinkLayer used by this Net Device.
Definition at line 124 of file ble-netdevice.cc.
References m_linkLayer, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
virtual |
Definition at line 203 of file ble-netdevice.cc.
References m_macAddr, and NS_LOG_FUNCTION.
|
virtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 231 of file ble-netdevice.cc.
References NS_LOG_FUNCTION.
|
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 274 of file ble-netdevice.cc.
References m_addr, NS_ABORT_MSG, and NS_LOG_FUNCTION.
|
virtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 282 of file ble-netdevice.cc.
References m_addr, NS_ABORT_MSG, and 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 180 of file ble-netdevice.cc.
References m_node, and NS_LOG_FUNCTION.
Get PHY to be used by the link layer and this Net Device.
Definition at line 138 of file ble-netdevice.cc.
References m_phy, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 36 of file ble-netdevice.cc.
References DoGetChannel(), GetLinkLayer(), GetPhy(), ns3::MakePointerAccessor(), SetLinkLayer(), ns3::TypeId::SetParent(), and SetPhy().
|
virtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 290 of file ble-netdevice.cc.
References NS_ABORT_MSG, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 252 of file ble-netdevice.cc.
References NS_ABORT_MSG, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 238 of file ble-netdevice.cc.
References m_linkUp, m_phy, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 267 of file ble-netdevice.cc.
References NS_ABORT_MSG, and NS_LOG_FUNCTION.
|
virtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 298 of file ble-netdevice.cc.
References NS_ABORT_MSG, and NS_LOG_FUNCTION.
|
virtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 322 of file ble-netdevice.cc.
References NS_ABORT_MSG, and 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 306 of file ble-netdevice.cc.
References NS_LOG_FUNCTION.
|
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 314 of file ble-netdevice.cc.
References NS_ABORT_MSG, and NS_LOG_FUNCTION.
|
virtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 210 of file ble-netdevice.cc.
References first::address, m_addr, and NS_LOG_FUNCTION.
void ns3::BleNetDevice::SetChannel | ( | Ptr< SpectrumChannel > | channel | ) |
Set Channel to which the Net Device, and therefore the PHY, should be attached to.
channel | the channel to be used |
Definition at line 145 of file ble-netdevice.cc.
References m_phy, and NS_LOG_FUNCTION.
|
virtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 152 of file ble-netdevice.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
void ns3::BleNetDevice::SetLinkLayer | ( | Ptr< BleLinkLayer > | ll | ) |
Set the LinkLayer to be used by this NetDevice.
ll | the pointer to Link Layer to be used. |
Definition at line 117 of file ble-netdevice.cc.
References m_linkLayer, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
virtual |
Get Addresses in Mac48Address Type.
Definition at line 194 of file ble-netdevice.cc.
References first::address, m_addr, m_linkLayer, m_macAddr, and NS_LOG_FUNCTION.
|
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 224 of file ble-netdevice.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 187 of file ble-netdevice.cc.
References m_node, and NS_LOG_FUNCTION.
Set PHY to be used by the Link Layer and this NetDevice.
phy | the PHY to be used. |
Definition at line 131 of file ble-netdevice.cc.
References m_phy, NS_LOG_FUNCTION, 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 337 of file ble-netdevice.cc.
References NS_ABORT_MSG, and NS_LOG_FUNCTION.
|
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 330 of file ble-netdevice.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 344 of file ble-netdevice.cc.
References NS_LOG_FUNCTION.
|
private |
BDA Address of this device.
It changes with every connection
Definition at line 178 of file ble-netdevice.h.
Referenced by GetAddress(), GetBroadcast(), GetMulticast(), SetAddress(), and SetMacAddress().
|
private |
Whether the configuration is complete or not.
Definition at line 168 of file ble-netdevice.h.
Referenced by BleNetDevice(), and CompleteConfig().
|
private |
Definition at line 173 of file ble-netdevice.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
The Link Layer for this NetDevice.
Definition at line 153 of file ble-netdevice.h.
Referenced by CompleteConfig(), DoDispose(), DoInitialize(), GetLinkLayer(), SetLinkLayer(), and SetMacAddress().
|
private |
|
private |
BDA address with Mac48Address format.
Definition at line 183 of file ble-netdevice.h.
Referenced by GetMacAddress(), and SetMacAddress().
Node associated with the NetDevice.
Definition at line 163 of file ble-netdevice.h.
Referenced by CompleteConfig(), DoDispose(), GetNode(), and SetNode().
The PHY for this NetDevice.
Definition at line 158 of file ble-netdevice.h.
Referenced by CompleteConfig(), DoDispose(), DoGetChannel(), DoInitialize(), GetChannel(), GetPhy(), IsLinkUp(), SetChannel(), and SetPhy().