A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::SimpleNetDevice Class Reference

This device does not have a helper and assumes 48-bit mac addressing; the default address assigned to each device is zero, so you must assign a real address to use it. More...

#include <simple-net-device.h>

+ Inheritance diagram for ns3::SimpleNetDevice:
+ Collaboration diagram for ns3::SimpleNetDevice:

Public Member Functions

 SimpleNetDevice ()
 
virtual void AddLinkChangeCallback (Callback< void > callback)
 
virtual Address GetAddress (void) const
 
virtual Address GetBroadcast (void) const
 
virtual Ptr< ChannelGetChannel (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< NodeGetNode (void) const
 
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)
 
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
 
void SetReceiveErrorModel (Ptr< ErrorModel > em)
 Attach a receive ErrorModel to the SimpleNetDevice. More...
 
virtual bool SupportsSendFrom (void) const
 
- Public Member Functions inherited from ns3::NetDevice
virtual ~NetDevice ()
 
- Public Member Functions inherited from ns3::Object
 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...
 
- 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...
 
SimpleRefCountoperator= (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
 
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)
 
- Static Public Member Functions inherited from ns3::NetDevice
static TypeId GetTypeId (void)
 
- 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...
 

Protected Member Functions

virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
- Protected Member Functions inherited from ns3::Object
 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...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Private Attributes

Mac48Address m_address
 
Ptr< SimpleChannelm_channel
 
uint32_t m_ifIndex
 
uint16_t m_mtu
 
Ptr< Nodem_node
 
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...
 
NetDevice::PromiscReceiveCallback m_promiscCallback
 
Ptr< ErrorModelm_receiveErrorModel
 
NetDevice::ReceiveCallback m_rxCallback
 

Additional Inherited Members

- Public Types inherited from ns3::NetDevice
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
 

Detailed Description

This device does not have a helper and assumes 48-bit mac addressing; the default address assigned to each device is zero, so you must assign a real address to use it.

There is also the possibility to add an ErrorModel if you want to force losses on the device.

simple net device for simple things and testing

Config Paths

ns3::SimpleNetDevice is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice

Attributes

  • ReceiveErrorModel: The receiver error model used to simulate packet loss
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::ErrorModel >
    • Initial value: 0
    • Flags: construct write read

TraceSources

  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception

Definition at line 45 of file simple-net-device.h.

Constructor & Destructor Documentation

ns3::SimpleNetDevice::SimpleNetDevice ( )

Definition at line 54 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::SimpleNetDevice::AddLinkChangeCallback ( Callback< void >  callback)
virtual
Parameters
callbackthe 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 167 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::SimpleNetDevice::DoDispose ( void  )
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 260 of file simple-net-device.cc.

References ns3::Object::DoDispose(), m_channel, m_node, m_receiveErrorModel, and NS_LOG_FUNCTION.

Referenced by ns3::LteSimpleNetDevice::DoDispose().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Address ns3::SimpleNetDevice::GetAddress ( void  ) const
virtual
Returns
the current Address of this interface.

Implements ns3::NetDevice.

Definition at line 139 of file simple-net-device.cc.

References m_address, and NS_LOG_FUNCTION.

Address ns3::SimpleNetDevice::GetBroadcast ( void  ) const
virtual
Returns
the broadcast address supported by this netdevice.

Calling this method is invalid if IsBroadcast returns not true.

Implements ns3::NetDevice.

Definition at line 178 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

Ptr< Channel > ns3::SimpleNetDevice::GetChannel ( void  ) const
virtual
Returns
the channel this NetDevice is connected to. The value returned can be zero if the NetDevice is not yet connected to any channel or if the underlying NetDevice has no concept of a channel. i.e., callers must check for zero and be ready to handle it.

Implements ns3::NetDevice.

Definition at line 127 of file simple-net-device.cc.

References m_channel, and NS_LOG_FUNCTION.

uint32_t ns3::SimpleNetDevice::GetIfIndex ( void  ) const
virtual
Returns
index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 121 of file simple-net-device.cc.

References m_ifIndex, and NS_LOG_FUNCTION.

uint16_t ns3::SimpleNetDevice::GetMtu ( void  ) const
virtual
Returns
the link-level MTU in bytes for this interface.

This value is typically used by the IP layer to perform IP fragmentation when needed.

Implements ns3::NetDevice.

Definition at line 155 of file simple-net-device.cc.

References m_mtu, and NS_LOG_FUNCTION.

Address ns3::SimpleNetDevice::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.

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.

Parameters
multicastGroupThe IP address for the multicast group destination of the packet.
Returns
The MAC multicast Address used to send packets to the provided multicast group.
Warning
Calling this method is invalid if IsMulticast returns not true.
See also
Ipv4Address
Address
NetDevice::IsMulticast

Implements ns3::NetDevice.

Definition at line 190 of file simple-net-device.cc.

References ns3::Mac48Address::GetMulticast(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Address ns3::SimpleNetDevice::GetMulticast ( Ipv6Address  addr) const
virtual

Get the MAC multicast address corresponding to the IPv6 address provided.

Parameters
addrIPv6 address
Returns
the MAC multicast address
Warning
Calling this method is invalid if IsMulticast returns not true.

Implements ns3::NetDevice.

Definition at line 196 of file simple-net-device.cc.

References ns3::Mac48Address::GetMulticast(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ptr< Node > ns3::SimpleNetDevice::GetNode ( void  ) const
virtual
Returns
the node base class which contains this network interface.

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 235 of file simple-net-device.cc.

References m_node, and NS_LOG_FUNCTION.

TypeId ns3::SimpleNetDevice::GetTypeId ( void  )
static

Definition at line 37 of file simple-net-device.cc.

References m_phyRxDropTrace, m_receiveErrorModel, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

bool ns3::SimpleNetDevice::IsBridge ( void  ) const
virtual

Return true if the net device is acting as a bridge.

Returns
value of m_isBridge flag

Implements ns3::NetDevice.

Definition at line 210 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::SimpleNetDevice::IsBroadcast ( void  ) const
virtual
Returns
true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

Definition at line 172 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::SimpleNetDevice::IsLinkUp ( void  ) const
virtual
Returns
true if link is up; false otherwise

Implements ns3::NetDevice.

Definition at line 161 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::SimpleNetDevice::IsMulticast ( void  ) const
virtual
Returns
value of m_isMulticast flag

Implements ns3::NetDevice.

Definition at line 184 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::SimpleNetDevice::IsPointToPoint ( void  ) const
virtual

Return true if the net device is on a point-to-point link.

Returns
value of m_isPointToPoint flag

Implements ns3::NetDevice.

Definition at line 203 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::SimpleNetDevice::NeedsArp ( void  ) const
virtual
Returns
true if ARP is needed, false otherwise.

Called by higher-layers to check if this NetDevice requires ARP to be used.

Implements ns3::NetDevice.

Definition at line 247 of file simple-net-device.cc.

References 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

Parameters
packetPacket received on the channel
protocolprotocol number
toaddress packet should be sent to
fromaddress packet was sent from

Definition at line 64 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_HOST, ns3::NetDevice::PACKET_MULTICAST, and ns3::NetDevice::PACKET_OTHERHOST.

Referenced by ns3::ErrorChannel::Send(), ns3::ErrorChannelSixlow::Send(), and ns3::SimpleChannel::Send().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::SimpleNetDevice::Send ( Ptr< Packet packet,
const Address dest,
uint16_t  protocolNumber 
)
virtual
Parameters
packetpacket sent from above down to Network Device
destmac address of the destination (already resolved)
protocolNumberidentifies 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

Returns
whether the Send operation succeeded

Implements ns3::NetDevice.

Reimplemented in ns3::LteSimpleNetDevice.

Definition at line 217 of file simple-net-device.cc.

References ns3::Mac48Address::ConvertFrom(), m_address, m_channel, and NS_LOG_FUNCTION.

Referenced by ns3::LteSimpleNetDevice::Send().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::SimpleNetDevice::SendFrom ( Ptr< Packet packet,
const Address source,
const Address dest,
uint16_t  protocolNumber 
)
virtual
Parameters
packetpacket sent from above down to Network Device
sourcesource mac address (so called "MAC spoofing")
destmac address of the destination (already resolved)
protocolNumberidentifies 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.

Returns
whether the Send operation succeeded

Implements ns3::NetDevice.

Definition at line 225 of file simple-net-device.cc.

References ns3::Mac48Address::ConvertFrom(), m_channel, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::SimpleNetDevice::SetIfIndex ( const uint32_t  index)
virtual
Parameters
indexifIndex of the device

Implements ns3::NetDevice.

Definition at line 115 of file simple-net-device.cc.

References m_ifIndex, and NS_LOG_FUNCTION.

bool ns3::SimpleNetDevice::SetMtu ( const uint16_t  mtu)
virtual
Parameters
mtuMTU value, in bytes, to set for the device
Returns
whether the MTU value was within legal bounds

Override for default MTU defined on a per-type basis.

Implements ns3::NetDevice.

Definition at line 148 of file simple-net-device.cc.

References m_mtu, and NS_LOG_FUNCTION.

Referenced by Ipv4FragmentationTest::DoRun(), SixlowpanFragmentationTest::DoRun(), and Ipv6FragmentationTest::DoRun().

+ Here is the caller graph for this function:

void ns3::SimpleNetDevice::SetNode ( Ptr< Node node)
virtual
Parameters
nodethe node associated to this netdevice.

This method is called from ns3::Node::AddDevice.

Implements ns3::NetDevice.

Definition at line 241 of file simple-net-device.cc.

References m_node, and NS_LOG_FUNCTION.

Referenced by BuildSimpleTopology(), and ns3::LteSimpleNetDevice::LteSimpleNetDevice().

+ Here is the caller graph for this function:

void ns3::SimpleNetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback  cb)
virtual
Parameters
cbcallback 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 271 of file simple-net-device.cc.

References m_promiscCallback, and NS_LOG_FUNCTION.

void ns3::SimpleNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback  cb)
virtual
Parameters
cbcallback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Implements ns3::NetDevice.

Definition at line 253 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.

See also
ErrorModel
Parameters
emPtr to the ErrorModel.

Definition at line 108 of file simple-net-device.cc.

References m_receiveErrorModel, and NS_LOG_FUNCTION.

Referenced by Ipv4FragmentationTest::DoRun(), SixlowpanFragmentationTest::DoRun(), and Ipv6FragmentationTest::DoRun().

+ Here is the caller graph for this function:

bool ns3::SimpleNetDevice::SupportsSendFrom ( void  ) const
virtual
Returns
true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

Definition at line 278 of file simple-net-device.cc.

References NS_LOG_FUNCTION.

Member Data Documentation

Mac48Address ns3::SimpleNetDevice::m_address
private

Definition at line 121 of file simple-net-device.h.

Referenced by GetAddress(), Receive(), Send(), and SetAddress().

Ptr<SimpleChannel> ns3::SimpleNetDevice::m_channel
private

Definition at line 115 of file simple-net-device.h.

Referenced by DoDispose(), GetChannel(), Send(), SendFrom(), and SetChannel().

uint32_t ns3::SimpleNetDevice::m_ifIndex
private

Definition at line 120 of file simple-net-device.h.

Referenced by GetIfIndex(), and SetIfIndex().

uint16_t ns3::SimpleNetDevice::m_mtu
private

Definition at line 119 of file simple-net-device.h.

Referenced by GetMtu(), and SetMtu().

Ptr<Node> ns3::SimpleNetDevice::m_node
private

Definition at line 118 of file simple-net-device.h.

Referenced by DoDispose(), GetNode(), and SetNode().

TracedCallback<Ptr<const Packet> > ns3::SimpleNetDevice::m_phyRxDropTrace
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.

See also
class CallBackTraceSource

Definition at line 131 of file simple-net-device.h.

Referenced by GetTypeId(), and Receive().

NetDevice::PromiscReceiveCallback ns3::SimpleNetDevice::m_promiscCallback
private

Definition at line 117 of file simple-net-device.h.

Referenced by Receive(), and SetPromiscReceiveCallback().

Ptr<ErrorModel> ns3::SimpleNetDevice::m_receiveErrorModel
private

Definition at line 122 of file simple-net-device.h.

Referenced by DoDispose(), GetTypeId(), Receive(), and SetReceiveErrorModel().

NetDevice::ReceiveCallback ns3::SimpleNetDevice::m_rxCallback
private

Definition at line 116 of file simple-net-device.h.

Referenced by Receive(), and SetReceiveCallback().


The documentation for this class was generated from the following files: