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 () | |
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 |
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< Queue > | GetQueue (void) const |
Get a copy of the attached Queue. 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 |
void | Receive (Ptr< Packet > packet, uint16_t protocol, Mac48Address to, Mac48Address from) |
Receive a packet from a connected SimpleChannel. More... | |
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< SimpleChannel > channel) |
Attach a channel to this net device. More... | |
virtual void | SetIfIndex (const uint32_t index) |
virtual bool | SetMtu (const uint16_t mtu) |
virtual void | SetNode (Ptr< Node > node) |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
void | SetQueue (Ptr< Queue > queue) |
Attach a queue to the SimpleNetDevice. More... | |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
void | SetReceiveErrorModel (Ptr< ErrorModel > em) |
Attach a receive ErrorModel to the SimpleNetDevice. More... | |
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... | |
Protected Member Functions | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
![]() | |
Object (const Object &o) | |
virtual void | DoInitialize (void) |
This method is called only once by Object::Initialize. More... | |
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... | |
Private Member Functions | |
void | TransmitComplete (void) |
The TransmitComplete method is used internally to finish the process of sending a packet out on the channel. More... | |
Private Attributes | |
Mac48Address | m_address |
MAC address. More... | |
DataRate | m_bps |
The device nominal Data rate. More... | |
Ptr< SimpleChannel > | m_channel |
the channel the device is connected to More... | |
uint32_t | m_ifIndex |
Interface index. More... | |
TracedCallback | m_linkChangeCallbacks |
List of callbacks to fire if the link changes state (up or down). More... | |
bool | m_linkUp |
Flag indicating whether or not the link is up. More... | |
uint16_t | m_mtu |
MTU. More... | |
Ptr< Node > | m_node |
Node this netDevice is associated to. More... | |
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. More... | |
bool | m_pointToPointMode |
Flag indicating whether or not the NetDevice is a Point to Point model. More... | |
NetDevice::PromiscReceiveCallback | m_promiscCallback |
Promiscuous receive callback. More... | |
Ptr< Queue > | m_queue |
The Queue for outgoing packets. More... | |
Ptr< ErrorModel > | m_receiveErrorModel |
Receive error model. More... | |
NetDevice::ReceiveCallback | m_rxCallback |
Receive callback. More... | |
EventId | TransmitCompleteEvent |
the Tx Complete event 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 |
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:
Definition at line 55 of file simple-net-device.h.
ns3::SimpleNetDevice::SimpleNetDevice | ( | ) |
Definition at line 189 of file simple-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 324 of file simple-net-device.cc.
References ns3::TracedCallback< T1, T2, T3, T4, T5, T6, T7, T8 >::ConnectWithoutContext(), m_linkChangeCallbacks, and NS_LOG_FUNCTION.
|
protectedvirtual |
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.
Reimplemented in ns3::LteSimpleNetDevice.
Definition at line 501 of file simple-net-device.cc.
References ns3::EventId::Cancel(), ns3::Object::DoDispose(), ns3::EventId::IsRunning(), m_channel, m_node, m_queue, m_receiveErrorModel, NS_LOG_FUNCTION, and TransmitCompleteEvent.
Referenced by ns3::LteSimpleNetDevice::DoDispose().
|
virtual |
Implements ns3::NetDevice.
Definition at line 296 of file simple-net-device.cc.
References m_address, and NS_LOG_FUNCTION.
Referenced by PacketSocketAppsTest::DoRun(), and main().
|
virtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 340 of file simple-net-device.cc.
References NS_LOG_FUNCTION.
Implements ns3::NetDevice.
Definition at line 284 of file simple-net-device.cc.
References m_channel, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 278 of file simple-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
Referenced by PacketSocketAppsTest::DoRun(), and main().
|
virtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 312 of file simple-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION.
Referenced by SendFrom().
|
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 356 of file simple-net-device.cc.
References ns3::Mac48Address::GetMulticast(), 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 362 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 472 of file simple-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Get a copy of the attached Queue.
Definition at line 251 of file simple-net-device.cc.
References m_queue, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 157 of file simple-net-device.cc.
References m_bps, m_phyRxDropTrace, m_pointToPointMode, m_queue, m_receiveErrorModel, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
|
virtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 380 of file simple-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 330 of file simple-net-device.cc.
References m_pointToPointMode, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 318 of file simple-net-device.cc.
References m_linkUp, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 346 of file simple-net-device.cc.
References m_pointToPointMode, and NS_LOG_FUNCTION.
|
virtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 369 of file simple-net-device.cc.
References m_pointToPointMode, 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 484 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 200 of file simple-net-device.cc.
References ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsGroup(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::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(), ns3::ErrorChannelSixlow::Send(), and ns3::SimpleChannel::Send().
|
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.
Reimplemented in ns3::LteSimpleNetDevice.
Definition at line 387 of file simple-net-device.cc.
References m_address, NS_LOG_FUNCTION, and SendFrom().
Referenced by ns3::LteSimpleNetDevice::Send().
|
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 395 of file simple-net-device.cc.
References ns3::Packet::AddPacketTag(), ns3::DataRate::CalculateTxTime(), ns3::Mac48Address::ConvertFrom(), ns3::Packet::Copy(), GetMtu(), ns3::Packet::GetSize(), m_bps, m_channel, m_queue, NS_LOG_FUNCTION, ns3::Packet::RemovePacketTag(), ns3::Simulator::Schedule(), ns3::Seconds(), ns3::SimpleTag::SetDst(), ns3::SimpleTag::SetProto(), ns3::SimpleTag::SetSrc(), TransmitComplete(), and TransmitCompleteEvent.
Referenced by Send().
|
virtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 290 of file simple-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), m_address, and NS_LOG_FUNCTION.
Referenced by TcpTestCase::AddSimpleNetDevice(), AddSimpleNetDevice(), TcpTestCase::AddSimpleNetDevice6(), BuildSimpleTopology(), IpAddressHelperTestCasev6::DoRun(), Ipv4StaticRoutingSlash32TestCase::DoRun(), Ipv6RipngTest::DoRun(), Ipv4ForwardingTest::DoRun(), SixlowpanIphcImplTest::DoRun(), SixlowpanHc1ImplTest::DoRun(), Ipv4HeaderTest::DoRun(), SixlowpanFragmentationTest::DoRun(), Ipv6FragmentationTest::DoRun(), Ipv6RipngCountToInfinityTest::DoRun(), Ipv4GlobalRoutingSlash32TestCase::DoRun(), and Ipv6RipngSplitHorizonStrategyTest::DoRun().
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 241 of file simple-net-device.cc.
References m_channel, m_linkChangeCallbacks, m_linkUp, and NS_LOG_FUNCTION.
Referenced by BuildSimpleTopology(), PacketSocketAppsTest::DoRun(), UdpClientServerTestCase::DoRun(), Ipv6RipngTest::DoRun(), Ipv4ForwardingTest::DoRun(), SixlowpanHc1ImplTest::DoRun(), SixlowpanIphcImplTest::DoRun(), Ipv4HeaderTest::DoRun(), SixlowpanFragmentationTest::DoRun(), UdpTraceClientServerTestCase::DoRun(), Ipv6FragmentationTest::DoRun(), Ipv6RipngCountToInfinityTest::DoRun(), UdpEchoClientSetFillTestCase::DoRun(), Ipv6RipngSplitHorizonStrategyTest::DoRun(), main(), TcpTestCase::SetupDefaultSim(), TcpTestCase::SetupDefaultSim6(), and DualStackTestCase::SetUpSim().
|
virtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 272 of file simple-net-device.cc.
References m_ifIndex, 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 305 of file simple-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION.
Referenced by SixlowpanFragmentationTest::DoRun(), and Ipv6FragmentationTest::DoRun().
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 478 of file simple-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Referenced by BuildSimpleTopology(), PacketSocketAppsTest::DoRun(), ns3::LteSimpleNetDevice::LteSimpleNetDevice(), and main().
|
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 517 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 258 of file simple-net-device.cc.
References m_queue, 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 494 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 265 of file simple-net-device.cc.
References m_receiveErrorModel, and NS_LOG_FUNCTION.
Referenced by SixlowpanFragmentationTest::DoRun(), and Ipv6FragmentationTest::DoRun().
|
virtual |
Implements ns3::NetDevice.
Definition at line 524 of file simple-net-device.cc.
References NS_LOG_FUNCTION.
|
private |
The TransmitComplete method is used internally to finish the process of sending a packet out on the channel.
Definition at line 438 of file simple-net-device.cc.
References ns3::DataRate::CalculateTxTime(), ns3::SimpleTag::GetDst(), ns3::SimpleTag::GetProto(), ns3::Packet::GetSize(), ns3::SimpleTag::GetSrc(), m_bps, m_channel, m_queue, NS_LOG_FUNCTION, ns3::Packet::RemovePacketTag(), ns3::Simulator::Schedule(), ns3::Seconds(), and TransmitCompleteEvent.
Referenced by SendFrom().
|
private |
MAC address.
Definition at line 148 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 176 of file simple-net-device.h.
Referenced by GetTypeId(), SendFrom(), and TransmitComplete().
|
private |
the channel the device is connected to
Definition at line 142 of file simple-net-device.h.
Referenced by DoDispose(), GetChannel(), SendFrom(), SetChannel(), and TransmitComplete().
|
private |
Interface index.
Definition at line 147 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 182 of file simple-net-device.h.
Referenced by AddLinkChangeCallback(), and SetChannel().
|
private |
Flag indicating whether or not the link is up.
Definition at line 167 of file simple-net-device.h.
Referenced by IsLinkUp(), and SetChannel().
|
private |
Node this netDevice is associated to.
Definition at line 145 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 159 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 173 of file simple-net-device.h.
Referenced by GetTypeId(), IsBroadcast(), IsMulticast(), IsPointToPoint(), and NeedsArp().
|
private |
Promiscuous receive callback.
Definition at line 144 of file simple-net-device.h.
Referenced by Receive(), and SetPromiscReceiveCallback().
The Queue for outgoing packets.
Definition at line 175 of file simple-net-device.h.
Referenced by DoDispose(), GetQueue(), GetTypeId(), SendFrom(), SetQueue(), and TransmitComplete().
|
private |
Receive error model.
Definition at line 149 of file simple-net-device.h.
Referenced by DoDispose(), GetTypeId(), Receive(), and SetReceiveErrorModel().
|
private |
Receive callback.
Definition at line 143 of file simple-net-device.h.
Referenced by Receive(), and SetReceiveCallback().
|
private |
the Tx Complete event
Definition at line 177 of file simple-net-device.h.
Referenced by DoDispose(), SendFrom(), and TransmitComplete().