A Discrete-Event Network Simulator
API
ns3::UanNetDevice Class Reference

Net device for UAN models. More...

#include "uan-net-device.h"

+ Inheritance diagram for ns3::UanNetDevice:
+ Collaboration diagram for ns3::UanNetDevice:

Public Types

typedef void(* RxTxTracedCallback) (Ptr< const Packet > packet, Mac8Address address)
 TracedCallback signature for MAC send/receive events. More...
 
typedef std::list< Ptr< UanPhy > > UanPhyList
 List of UanPhy objects. More...
 
typedef std::list< Ptr< UanTransducer > > UanTransducerList
 List of UanTransducer objects. More...
 
- 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 PacketTypePromiscReceiveCallback
 
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address & > ReceiveCallback
 

Public Member Functions

 UanNetDevice ()
 Default constructor. More...
 
virtual ~UanNetDevice ()
 Dummy destructor, DoDispose. More...
 
virtual void AddLinkChangeCallback (Callback< void > callback)
 
void Clear (void)
 Clear all pointer references. More...
 
virtual Address GetAddress (void) const
 
virtual Address GetBroadcast (void) const
 
virtual Ptr< ChannelGetChannel (void) const
 
virtual uint32_t GetIfIndex (void) const
 
Ptr< UanMacGetMac (void) const
 Get the MAC used by this device. 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< NodeGetNode (void) const
 
Ptr< UanPhyGetPhy (void) const
 Get the Phy used by this device. More...
 
Ptr< UanTransducerGetTransducer (void) const
 Get the transducer associated with this device. More...
 
uint32_t GetTxModeIndex ()
 Get the Tx mode index (Modulation type). 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< UanChannel > channel)
 Attach a channel. More...
 
virtual void SetIfIndex (const uint32_t index)
 
void SetMac (Ptr< UanMac > mac)
 Set the MAC layer for this device. More...
 
virtual bool SetMtu (const uint16_t mtu)
 
virtual void SetNode (Ptr< Node > node)
 
void SetPhy (Ptr< UanPhy > phy)
 Set the Phy layer for this device. More...
 
virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb)
 
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
 
void SetSleepMode (bool sleep)
 Set the Phy SLEEP mode. More...
 
void SetTransducer (Ptr< UanTransducer > trans)
 Set the transdcuer used by this device. More...
 
void SetTxModeIndex (uint32_t txModeIndex)
 Set the Tx mode index (Modulation type). More...
 
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
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. 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)
 Register this type. 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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- 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...
 

Private Member Functions

Ptr< UanChannelDoGetChannel (void) const
 
virtual void ForwardUp (Ptr< Packet > pkt, uint16_t protocolNumber, const Mac8Address &src)
 Forward the packet to a higher level, set with SetReceiveCallback. More...
 

Private Attributes

Ptr< UanChannelm_channel
 The channel attached to this device. More...
 
bool m_cleared
 Flag when we've been cleared. More...
 
ReceiveCallback m_forwardUp
 The receive callback. More...
 
uint32_t m_ifIndex
 The interface index of this device. More...
 
TracedCallback m_linkChanges
 Callback to invoke when the link state changes to UP. More...
 
bool m_linkup
 The link state, true if up. More...
 
Ptr< UanMacm_mac
 The MAC layer attached to this device. More...
 
uint16_t m_mtu
 The device MTU value, in bytes. More...
 
Ptr< Nodem_node
 The node hosting this device. More...
 
Ptr< UanPhym_phy
 The PHY layer attached to this device. More...
 
TracedCallback< Ptr< const Packet >, Mac8Addressm_rxLogger
 Trace source triggered when forwarding up received payload from the MAC layer. More...
 
Ptr< UanTransducerm_trans
 The Transducer attached to this device. More...
 
TracedCallback< Ptr< const Packet >, Mac8Addressm_txLogger
 Trace source triggered when sending to the MAC layer. More...
 

Additional Inherited Members

Detailed Description

Net device for UAN models.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice"

Attributes

TraceSources

Size of this type is 168 bytes (on a 64-bit architecture).

Definition at line 47 of file uan-net-device.h.

Member Typedef Documentation

◆ RxTxTracedCallback

typedef void(* ns3::UanNetDevice::RxTxTracedCallback) (Ptr< const Packet > packet, Mac8Address address)

TracedCallback signature for MAC send/receive events.

Parameters
[in]packetThe Packet.
[in]addressThe source address.

Definition at line 168 of file uan-net-device.h.

◆ UanPhyList

List of UanPhy objects.

Definition at line 51 of file uan-net-device.h.

◆ UanTransducerList

List of UanTransducer objects.

Definition at line 53 of file uan-net-device.h.

Constructor & Destructor Documentation

◆ UanNetDevice()

ns3::UanNetDevice::UanNetDevice ( )

Default constructor.

Definition at line 39 of file uan-net-device.cc.

◆ ~UanNetDevice()

ns3::UanNetDevice::~UanNetDevice ( )
virtual

Dummy destructor, DoDispose.

Definition at line 46 of file uan-net-device.cc.

Member Function Documentation

◆ AddLinkChangeCallback()

void ns3::UanNetDevice::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 383 of file uan-net-device.cc.

References ns3::TracedCallback< Ts >::ConnectWithoutContext(), and m_linkChanges.

+ Here is the call graph for this function:

◆ Clear()

void ns3::UanNetDevice::Clear ( void  )

Clear all pointer references.

Definition at line 51 of file uan-net-device.cc.

References m_channel, m_cleared, m_mac, m_node, m_phy, and m_trans.

Referenced by DoDispose().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::UanNetDevice::DoDispose ( void  )
protectedvirtual

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 93 of file uan-net-device.cc.

References Clear(), and ns3::Object::DoDispose().

+ Here is the call graph for this function:

◆ DoGetChannel()

Ptr< UanChannel > ns3::UanNetDevice::DoGetChannel ( void  ) const
private
Returns
The channel attached to this device.

Definition at line 197 of file uan-net-device.cc.

References m_channel.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ DoInitialize()

void ns3::UanNetDevice::DoInitialize ( void  )
protectedvirtual

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 82 of file uan-net-device.cc.

References ns3::Object::DoInitialize(), m_channel, m_mac, m_phy, and m_trans.

+ Here is the call graph for this function:

◆ ForwardUp()

void ns3::UanNetDevice::ForwardUp ( Ptr< Packet pkt,
uint16_t  protocolNumber,
const Mac8Address src 
)
privatevirtual

Forward the packet to a higher level, set with SetReceiveCallback.

Parameters
pktThe packet.
srcThe source address.
protocolNumberThe layer 3 protocol number.

Definition at line 345 of file uan-net-device.cc.

References m_forwardUp, m_rxLogger, and NS_LOG_DEBUG.

Referenced by SetMac().

+ Here is the caller graph for this function:

◆ GetAddress()

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

Implements ns3::NetDevice.

Definition at line 233 of file uan-net-device.cc.

References m_mac.

◆ GetBroadcast()

Address ns3::UanNetDevice::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 266 of file uan-net-device.cc.

References m_mac.

◆ GetChannel()

Ptr< Channel > ns3::UanNetDevice::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 227 of file uan-net-device.cc.

References m_channel.

◆ GetIfIndex()

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

Implements ns3::NetDevice.

Definition at line 221 of file uan-net-device.cc.

References m_ifIndex.

◆ GetMac()

Ptr< UanMac > ns3::UanNetDevice::GetMac ( void  ) const

Get the MAC used by this device.

Returns
The MAC.

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

References m_mac.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetMtu()

uint16_t ns3::UanNetDevice::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 248 of file uan-net-device.cc.

References m_mtu.

◆ GetMulticast() [1/2]

virtual Address ns3::UanNetDevice::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
IsMulticast()

Implements ns3::NetDevice.

◆ GetMulticast() [2/2]

Address ns3::UanNetDevice::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 284 of file uan-net-device.cc.

References m_mac.

◆ GetNode()

Ptr< Node > ns3::UanNetDevice::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 321 of file uan-net-device.cc.

References m_node.

◆ GetPhy()

Ptr< UanPhy > ns3::UanNetDevice::GetPhy ( void  ) const

Get the Phy used by this device.

Returns
The Phy.

Definition at line 209 of file uan-net-device.cc.

References m_phy.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTransducer()

Ptr< UanTransducer > ns3::UanNetDevice::GetTransducer ( void  ) const

Get the transducer associated with this device.

Returns
The transducer.

Definition at line 354 of file uan-net-device.cc.

References m_trans.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTxModeIndex()

uint32_t ns3::UanNetDevice::GetTxModeIndex ( )

Get the Tx mode index (Modulation type).

Returns
the Tx mode index

Definition at line 422 of file uan-net-device.cc.

References m_mac.

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

Definition at line 100 of file uan-net-device.cc.

References DoGetChannel(), GetMac(), GetPhy(), GetTransducer(), m_rxLogger, m_txLogger, ns3::MakePointerAccessor(), ns3::MakeTraceSourceAccessor(), SetChannel(), SetMac(), ns3::TypeId::SetParent(), SetPhy(), and SetTransducer().

+ Here is the call graph for this function:

◆ IsBridge()

bool ns3::UanNetDevice::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 290 of file uan-net-device.cc.

◆ IsBroadcast()

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

Implements ns3::NetDevice.

Definition at line 260 of file uan-net-device.cc.

◆ IsLinkUp()

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

Implements ns3::NetDevice.

Definition at line 254 of file uan-net-device.cc.

References m_linkup, and m_phy.

◆ IsMulticast()

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

Implements ns3::NetDevice.

Definition at line 272 of file uan-net-device.cc.

◆ IsPointToPoint()

bool ns3::UanNetDevice::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 295 of file uan-net-device.cc.

◆ NeedsArp()

bool ns3::UanNetDevice::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 333 of file uan-net-device.cc.

◆ Send()

bool ns3::UanNetDevice::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.

Definition at line 301 of file uan-net-device.cc.

References ns3::Address::CopyTo(), and m_mac.

+ Here is the call graph for this function:

◆ SendFrom()

bool ns3::UanNetDevice::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 311 of file uan-net-device.cc.

References NS_ASSERT_MSG.

◆ SetAddress()

void ns3::UanNetDevice::SetAddress ( Address  address)
virtual

Set the address of this interface.

Parameters
addressaddress to set

Implements ns3::NetDevice.

Definition at line 403 of file uan-net-device.cc.

References first::address, ns3::Mac8Address::ConvertFrom(), m_mac, and NS_ASSERT_MSG.

+ Here is the call graph for this function:

◆ SetChannel()

void ns3::UanNetDevice::SetChannel ( Ptr< UanChannel channel)

Attach a channel.

Parameters
channelThe channel.

Definition at line 175 of file uan-net-device.cc.

References third::channel, m_channel, m_phy, m_trans, and NS_LOG_DEBUG.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetIfIndex()

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

Implements ns3::NetDevice.

Definition at line 215 of file uan-net-device.cc.

References m_ifIndex.

◆ SetMac()

void ns3::UanNetDevice::SetMac ( Ptr< UanMac mac)

Set the MAC layer for this device.

Parameters
macThe MAC layer.

Definition at line 133 of file uan-net-device.cc.

References ForwardUp(), m_mac, m_phy, third::mac, ns3::MakeCallback(), and NS_LOG_DEBUG.

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetMtu()

bool ns3::UanNetDevice::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.

Todo:
Check this in MAC

Implements ns3::NetDevice.

Definition at line 239 of file uan-net-device.cc.

References m_mtu, and NS_LOG_WARN.

◆ SetNode()

void ns3::UanNetDevice::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 327 of file uan-net-device.cc.

References m_node.

◆ SetPhy()

void ns3::UanNetDevice::SetPhy ( Ptr< UanPhy phy)

Set the Phy layer for this device.

Parameters
phyThe PHY layer.

Definition at line 152 of file uan-net-device.cc.

References m_mac, m_phy, m_trans, NS_LOG_DEBUG, and third::phy.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetPromiscReceiveCallback()

void ns3::UanNetDevice::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 390 of file uan-net-device.cc.

References NS_ASSERT_MSG.

◆ SetReceiveCallback()

void ns3::UanNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback  cb)
virtual
Parameters
cbcallback 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 339 of file uan-net-device.cc.

References m_forwardUp.

◆ SetSleepMode()

void ns3::UanNetDevice::SetSleepMode ( bool  sleep)

Set the Phy SLEEP mode.

Parameters
sleepSLEEP on or off.

Definition at line 410 of file uan-net-device.cc.

References m_phy.

◆ SetTransducer()

void ns3::UanNetDevice::SetTransducer ( Ptr< UanTransducer trans)

Set the transdcuer used by this device.

Parameters
transThe transducer.

Definition at line 359 of file uan-net-device.cc.

References m_channel, m_phy, m_trans, and NS_LOG_DEBUG.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetTxModeIndex()

void ns3::UanNetDevice::SetTxModeIndex ( uint32_t  txModeIndex)

Set the Tx mode index (Modulation type).

Parameters
txModeIndexthe Tx mode index

Definition at line 416 of file uan-net-device.cc.

References m_mac.

◆ SupportsSendFrom()

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

Implements ns3::NetDevice.

Definition at line 397 of file uan-net-device.cc.

Member Data Documentation

◆ m_channel

Ptr<UanChannel> ns3::UanNetDevice::m_channel
private

The channel attached to this device.

Definition at line 186 of file uan-net-device.h.

Referenced by Clear(), DoGetChannel(), DoInitialize(), GetChannel(), SetChannel(), and SetTransducer().

◆ m_cleared

bool ns3::UanNetDevice::m_cleared
private

Flag when we've been cleared.

Definition at line 203 of file uan-net-device.h.

Referenced by Clear().

◆ m_forwardUp

ReceiveCallback ns3::UanNetDevice::m_forwardUp
private

The receive callback.

Definition at line 195 of file uan-net-device.h.

Referenced by ForwardUp(), and SetReceiveCallback().

◆ m_ifIndex

uint32_t ns3::UanNetDevice::m_ifIndex
private

The interface index of this device.

Definition at line 191 of file uan-net-device.h.

Referenced by GetIfIndex(), and SetIfIndex().

◆ m_linkChanges

TracedCallback ns3::UanNetDevice::m_linkChanges
private

Callback to invoke when the link state changes to UP.

Definition at line 194 of file uan-net-device.h.

Referenced by AddLinkChangeCallback().

◆ m_linkup

bool ns3::UanNetDevice::m_linkup
private

The link state, true if up.

Definition at line 193 of file uan-net-device.h.

Referenced by IsLinkUp().

◆ m_mac

Ptr<UanMac> ns3::UanNetDevice::m_mac
private

The MAC layer attached to this device.

Definition at line 187 of file uan-net-device.h.

Referenced by Clear(), DoInitialize(), GetAddress(), GetBroadcast(), GetMac(), GetMulticast(), GetTxModeIndex(), Send(), SetAddress(), SetMac(), SetPhy(), and SetTxModeIndex().

◆ m_mtu

uint16_t ns3::UanNetDevice::m_mtu
private

The device MTU value, in bytes.

Definition at line 192 of file uan-net-device.h.

Referenced by GetMtu(), and SetMtu().

◆ m_node

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

The node hosting this device.

Definition at line 185 of file uan-net-device.h.

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

◆ m_phy

Ptr<UanPhy> ns3::UanNetDevice::m_phy
private

The PHY layer attached to this device.

Definition at line 188 of file uan-net-device.h.

Referenced by Clear(), DoInitialize(), GetPhy(), IsLinkUp(), SetChannel(), SetMac(), SetPhy(), SetSleepMode(), and SetTransducer().

◆ m_rxLogger

TracedCallback<Ptr<const Packet>, Mac8Address> ns3::UanNetDevice::m_rxLogger
private

Trace source triggered when forwarding up received payload from the MAC layer.

Definition at line 198 of file uan-net-device.h.

Referenced by ForwardUp(), and GetTypeId().

◆ m_trans

Ptr<UanTransducer> ns3::UanNetDevice::m_trans
private

The Transducer attached to this device.

Definition at line 184 of file uan-net-device.h.

Referenced by Clear(), DoInitialize(), GetTransducer(), SetChannel(), SetPhy(), and SetTransducer().

◆ m_txLogger

TracedCallback<Ptr<const Packet>, Mac8Address> ns3::UanNetDevice::m_txLogger
private

Trace source triggered when sending to the MAC layer.

Definition at line 200 of file uan-net-device.h.

Referenced by GetTypeId().


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