This device assumes 48-bit mac addressing; there is also the possibility to add an ErrorModel if you want to force losses on the device. More...
#include "simple-net-device.h"
Public Member Functions | |
SimpleNetDevice () | |
void | AddLinkChangeCallback (Callback< void > callback) override |
Address | GetAddress () const override |
Address | GetBroadcast () const override |
Ptr< Channel > | GetChannel () const override |
uint32_t | GetIfIndex () const override |
uint16_t | GetMtu () const override |
Address | GetMulticast (Ipv4Address multicastGroup) const override |
Make and return a MAC multicast address using the provided multicast group. | |
Address | GetMulticast (Ipv6Address addr) const override |
Get the MAC multicast address corresponding to the IPv6 address provided. | |
Ptr< Node > | GetNode () const override |
Ptr< Queue< Packet > > | GetQueue () const |
Get a copy of the attached Queue. | |
bool | IsBridge () const override |
Return true if the net device is acting as a bridge. | |
bool | IsBroadcast () const override |
bool | IsLinkUp () const override |
bool | IsMulticast () const override |
bool | IsPointToPoint () const override |
Return true if the net device is on a point-to-point link. | |
bool | NeedsArp () const override |
void | Receive (Ptr< Packet > packet, uint16_t protocol, Mac48Address to, Mac48Address from) |
Receive a packet from a connected SimpleChannel. | |
bool | Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override |
bool | SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) override |
void | SetAddress (Address address) override |
Set the address of this interface. | |
void | SetChannel (Ptr< SimpleChannel > channel) |
Attach a channel to this net device. | |
void | SetIfIndex (const uint32_t index) override |
bool | SetMtu (const uint16_t mtu) override |
void | SetNode (Ptr< Node > node) override |
void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) override |
void | SetQueue (Ptr< Queue< Packet > > queue) |
Attach a queue to the SimpleNetDevice. | |
void | SetReceiveCallback (NetDevice::ReceiveCallback cb) override |
void | SetReceiveErrorModel (Ptr< ErrorModel > em) |
Attach a receive ErrorModel to the SimpleNetDevice. | |
bool | SupportsSendFrom () const override |
Public Member Functions inherited from ns3::NetDevice | |
~NetDevice () override | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::NetDevice | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Member Functions | |
void | FinishTransmission (Ptr< Packet > packet) |
The FinishTransmission method is used internally to finish the process of sending a packet out on the channel. | |
void | StartTransmission () |
The StartTransmission method is used internally to start the process of sending a packet out on the channel, by scheduling the FinishTransmission method at a time corresponding to the transmission delay of the packet. | |
Private Attributes | |
EventId | FinishTransmissionEvent |
the Tx Complete event | |
Mac48Address | m_address |
MAC address. | |
DataRate | m_bps |
The device nominal Data rate. | |
Ptr< SimpleChannel > | m_channel |
the channel the device is connected to | |
uint32_t | m_ifIndex |
Interface index. | |
TracedCallback | m_linkChangeCallbacks |
List of callbacks to fire if the link changes state (up or down). | |
bool | m_linkUp |
Flag indicating whether or not the link is up. | |
uint16_t | m_mtu |
MTU. | |
Ptr< Node > | m_node |
Node this netDevice is associated to. | |
TracedCallback< Ptr< const Packet > > | m_phyRxDropTrace |
The trace source fired when the phy layer drops a packet it has received due to the error model being active. | |
bool | m_pointToPointMode |
Flag indicating whether or not the NetDevice is a Point to Point model. | |
NetDevice::PromiscReceiveCallback | m_promiscCallback |
Promiscuous receive callback. | |
Ptr< Queue< Packet > > | m_queue |
The Queue for outgoing packets. | |
Ptr< ErrorModel > | m_receiveErrorModel |
Receive error model. | |
NetDevice::ReceiveCallback | m_rxCallback |
Receive callback. | |
Additional Inherited Members | |
Public Types inherited from ns3::NetDevice | |
typedef void(* | LinkChangeTracedCallback) () |
TracedCallback signature for link changed event. | |
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 &, PacketType > | PromiscReceiveCallback |
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address & > | ReceiveCallback |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
This device assumes 48-bit mac addressing; there is also the possibility to add an ErrorModel if you want to force losses on the device.
The device can be installed on a node through the SimpleNetDeviceHelper. In case of manual creation, the user is responsible for assigning an unique address to the device.
By default the device is in Broadcast mode, with infinite bandwidth.
simple net device for simple things and testing
ns3::SimpleNetDevice is accessible through the following paths with Config::Set and Config::Connect:
DataRate
Group: Network
Size of this type is 208 bytes (on a 64-bit architecture).
Definition at line 43 of file simple-net-device.h.
ns3::SimpleNetDevice::SimpleNetDevice | ( | ) |
Definition at line 213 of file simple-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
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 355 of file simple-net-device.cc.
References ns3::TracedCallback< Ts >::ConnectWithoutContext(), m_linkChangeCallbacks, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
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 overridden 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 529 of file simple-net-device.cc.
References ns3::EventId::Cancel(), ns3::Object::Dispose(), ns3::Object::DoDispose(), FinishTransmissionEvent, ns3::EventId::IsPending(), m_channel, m_node, m_queue, m_receiveErrorModel, and NS_LOG_FUNCTION.
Referenced by ns3::LteSimpleNetDevice::DoDispose().
The FinishTransmission method is used internally to finish the process of sending a packet out on the channel.
packet | The packet to send on the channel |
Definition at line 484 of file simple-net-device.cc.
References ns3::SimpleTag::GetDst(), ns3::SimpleTag::GetProto(), ns3::SimpleTag::GetSrc(), m_channel, NS_LOG_FUNCTION, and StartTransmission().
Referenced by StartTransmission().
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 323 of file simple-net-device.cc.
References m_address, and NS_LOG_FUNCTION.
|
overridevirtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 369 of file simple-net-device.cc.
References ns3::Mac48Address::GetBroadcast(), and NS_LOG_FUNCTION.
Implements ns3::NetDevice.
Definition at line 309 of file simple-net-device.cc.
References m_channel, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 302 of file simple-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
|
overridevirtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 341 of file simple-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION.
Referenced by SendFrom().
|
overridevirtual |
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 383 of file simple-net-device.cc.
References ns3::Mac48Address::GetMulticast(), and NS_LOG_FUNCTION.
|
overridevirtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 390 of file simple-net-device.cc.
References ns3::Mac48Address::GetMulticast(), 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 501 of file simple-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Get a copy of the attached Queue.
Definition at line 274 of file simple-net-device.cc.
References m_queue, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 178 of file simple-net-device.cc.
References m_bps, m_phyRxDropTrace, m_pointToPointMode, m_queue, m_receiveErrorModel, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDataRateAccessor(), ns3::MakeDataRateChecker(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
|
overridevirtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 404 of file simple-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 362 of file simple-net-device.cc.
References m_pointToPointMode, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 348 of file simple-net-device.cc.
References m_linkUp, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 376 of file simple-net-device.cc.
References m_pointToPointMode, and NS_LOG_FUNCTION.
|
overridevirtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 397 of file simple-net-device.cc.
References m_pointToPointMode, and NS_LOG_FUNCTION.
|
overridevirtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 515 of file simple-net-device.cc.
References m_pointToPointMode, and NS_LOG_FUNCTION.
void ns3::SimpleNetDevice::Receive | ( | Ptr< Packet > | packet, |
uint16_t | protocol, | ||
Mac48Address | to, | ||
Mac48Address | from ) |
Receive a packet from a connected SimpleChannel.
The SimpleNetDevice receives packets from its connected channel and then forwards them by calling its rx callback method
packet | Packet received on the channel |
protocol | protocol number |
to | address packet should be sent to |
from | address packet was sent from |
Definition at line 224 of file simple-net-device.cc.
References ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsGroup(), ns3::Callback< R, UArgs >::IsNull(), m_address, m_phyRxDropTrace, m_promiscCallback, m_receiveErrorModel, m_rxCallback, NS_LOG_FUNCTION, ns3::NetDevice::PACKET_BROADCAST, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, and ns3::NetDevice::PACKET_OTHERHOST.
Referenced by ns3::ErrorChannel::Send(), and ns3::SimpleChannel::Send().
|
overridevirtual |
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 411 of file simple-net-device.cc.
References m_address, NS_LOG_FUNCTION, and SendFrom().
Referenced by ns3::LteSimpleNetDevice::Send().
|
overridevirtual |
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 419 of file simple-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), FinishTransmissionEvent, GetMtu(), ns3::EventId::IsPending(), m_queue, NS_LOG_FUNCTION, ns3::SimpleTag::SetDst(), ns3::SimpleTag::SetProto(), ns3::SimpleTag::SetSrc(), and StartTransmission().
Referenced by Send().
|
overridevirtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 316 of file simple-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), m_address, and NS_LOG_FUNCTION.
void ns3::SimpleNetDevice::SetChannel | ( | Ptr< SimpleChannel > | channel | ) |
Attach a channel to this net device.
This will be the channel the net device sends on
channel | channel to assign to this net device |
Definition at line 264 of file simple-net-device.cc.
References m_channel, m_linkChangeCallbacks, m_linkUp, and NS_LOG_FUNCTION.
|
overridevirtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 295 of file simple-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
|
overridevirtual |
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 333 of file simple-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 508 of file simple-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Referenced by ns3::LteSimpleNetDevice::LteSimpleNetDevice().
|
overridevirtual |
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 544 of file simple-net-device.cc.
References m_promiscCallback, and NS_LOG_FUNCTION.
Attach a queue to the SimpleNetDevice.
queue | Ptr to the new queue. |
Definition at line 281 of file simple-net-device.cc.
References m_queue, and NS_LOG_FUNCTION.
|
overridevirtual |
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 522 of file simple-net-device.cc.
References m_rxCallback, and NS_LOG_FUNCTION.
void ns3::SimpleNetDevice::SetReceiveErrorModel | ( | Ptr< ErrorModel > | em | ) |
Attach a receive ErrorModel to the SimpleNetDevice.
The SimpleNetDevice may optionally include an ErrorModel in the packet receive chain.
em | Ptr to the ErrorModel. |
Definition at line 288 of file simple-net-device.cc.
References m_receiveErrorModel, and NS_LOG_FUNCTION.
|
private |
The StartTransmission method is used internally to start the process of sending a packet out on the channel, by scheduling the FinishTransmission method at a time corresponding to the transmission delay of the packet.
SimpleChannel will deliver the packet to the far end(s) of the link as soon as Send is called (or after its fixed delay, if one is configured). So we have to handle the rate of the link here, which we do by scheduling FinishTransmission (packetSize / linkRate) time in the future. While that event is running, the transmit path of this NetDevice is busy, so we can't send other packets.
SimpleChannel doesn't have a locking mechanism, and doesn't check for collisions, so there's nothing we need to do with the channel until the transmission has "completed" from the perspective of this NetDevice.
Definition at line 453 of file simple-net-device.cc.
References ns3::DataRate::CalculateBytesTxTime(), FinishTransmission(), FinishTransmissionEvent, ns3::EventId::IsPending(), m_bps, m_queue, NS_ASSERT_MSG, and ns3::Simulator::Schedule().
Referenced by FinishTransmission(), and SendFrom().
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 551 of file simple-net-device.cc.
References NS_LOG_FUNCTION.
|
private |
the Tx Complete event
Definition at line 178 of file simple-net-device.h.
Referenced by DoDispose(), SendFrom(), and StartTransmission().
|
private |
MAC address.
Definition at line 140 of file simple-net-device.h.
Referenced by GetAddress(), Receive(), Send(), and SetAddress().
|
private |
The device nominal Data rate.
Zero means infinite
Definition at line 177 of file simple-net-device.h.
Referenced by GetTypeId(), and StartTransmission().
|
private |
the channel the device is connected to
Definition at line 134 of file simple-net-device.h.
Referenced by DoDispose(), FinishTransmission(), GetChannel(), and SetChannel().
|
private |
Interface index.
Definition at line 139 of file simple-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
List of callbacks to fire if the link changes state (up or down).
Definition at line 183 of file simple-net-device.h.
Referenced by AddLinkChangeCallback(), and SetChannel().
|
private |
Flag indicating whether or not the link is up.
Definition at line 168 of file simple-net-device.h.
Referenced by IsLinkUp(), and SetChannel().
|
private |
Node this netDevice is associated to.
Definition at line 137 of file simple-net-device.h.
Referenced by DoDispose(), GetNode(), and SetNode().
|
private |
The trace source fired when the phy layer drops a packet it has received due to the error model being active.
Although SimpleNetDevice doesn't really have a Phy model, we choose this trace source name for alignment with other trace sources.
Definition at line 151 of file simple-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
Flag indicating whether or not the NetDevice is a Point to Point model.
Enabling this will disable Broadcast and Arp.
Definition at line 174 of file simple-net-device.h.
Referenced by GetTypeId(), IsBroadcast(), IsMulticast(), IsPointToPoint(), and NeedsArp().
|
private |
Promiscuous receive callback.
Definition at line 136 of file simple-net-device.h.
Referenced by Receive(), and SetPromiscReceiveCallback().
The Queue for outgoing packets.
Definition at line 176 of file simple-net-device.h.
Referenced by DoDispose(), GetQueue(), GetTypeId(), SendFrom(), SetQueue(), and StartTransmission().
|
private |
Receive error model.
Definition at line 141 of file simple-net-device.h.
Referenced by DoDispose(), GetTypeId(), Receive(), and SetReceiveErrorModel().
|
private |
Receive callback.
Definition at line 135 of file simple-net-device.h.
Referenced by Receive(), and SetReceiveCallback().