Net device for UAN models. More...

#include <uan-net-device.h>

Inheritance diagram for ns3::UanNetDevice:

Collaboration diagram for ns3::UanNetDevice:

Public Types
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
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

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< Channel >	GetChannel (void) const

virtual uint32_t	GetIfIndex (void) const

Ptr< UanMac >	GetMac (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< Node >	GetNode (void) const

Ptr< UanPhy >	GetPhy (void) const
	Get the Phy used by this device. More...

Ptr< UanTransducer >	GetTransducer (void) const
	Get the transducer associated with this device. More...

virtual bool	IsBridge (void) const
	Return true if the net device is acting as a bridge. More...

virtual bool	IsBroadcast (void) const

virtual bool	IsLinkUp (void) const

virtual bool	IsMulticast (void) const

virtual bool	IsPointToPoint (void) const
	Return true if the net device is on a point-to-point link. More...

virtual bool	NeedsArp (void) const

virtual bool	Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)

virtual bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)

virtual void	SetAddress (Address address)
	Set the address of this interface. More...

void	SetChannel (Ptr< 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...

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...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const

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)
	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::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 ()
	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 Member Functions
Ptr< UanChannel >	DoGetChannel (void) const

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

Private Attributes
Ptr< UanChannel >	m_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< UanMac >	m_mac
	The MAC layer attached to this device. More...

uint16_t	m_mtu
	The device MTU value, in bytes. More...

Ptr< Node >	m_node
	The node hosting this device. More...

Ptr< UanPhy >	m_phy
	The PHY layer attached to this device. More...

TracedCallback< Ptr< const Packet >, UanAddress >	m_rxLogger
	Trace source triggered when forwarding up received payload from the MAC layer. More...

Ptr< UanTransducer >	m_trans
	The Transducer attached to this device. More...

TracedCallback< Ptr< const Packet >, UanAddress >	m_txLogger
	Trace source triggered when sending to the MAC layer. More...

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

Channel: The channel attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::UanChannel>
- Initial value: 0
- Flags: construct write read
Phy: The PHY layer attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::UanPhy>
- Initial value: 0
- Flags: construct write read
Mac: The MAC layer attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::UanMac>
- Initial value: 0
- Flags: construct write read
Transducer: The Transducer attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::UanTransducer>
- Initial value: 0
- Flags: construct write read

TraceSources

Rx: Received payload from the MAC layer.
Tx: Send payload to the MAC layer.

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

Member Typedef Documentation

typedef std::list<Ptr<UanPhy> > ns3::UanNetDevice::UanPhyList

List of UanPhy objects.

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

typedef std::list<Ptr<UanTransducer> > ns3::UanNetDevice::UanTransducerList

List of UanTransducer objects.

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

Constructor & Destructor Documentation

ns3::UanNetDevice::UanNetDevice ( )

Default constructor.

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

ns3::UanNetDevice::~UanNetDevice ( )

virtual

Dummy destructor, DoDispose.

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

Member Function Documentation

void ns3::UanNetDevice::AddLinkChangeCallback ( Callback< void > callback )

virtual

Parameters

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

References ns3::TracedCallback< T1, T2, T3, T4, T5, T6, T7, T8 >::ConnectWithoutContext(), and m_linkChanges.

Here is the call graph for this function:

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:

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

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

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

Here is the call graph for this function:

Ptr< UanChannel > ns3::UanNetDevice::DoGetChannel ( void ) const

private

Returns: The channel attached to this device.

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

References m_channel.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::UanNetDevice::ForwardUp	(	Ptr< Packet >	pkt,
		const UanAddress &	src
	)

privatevirtual

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

Parameters

pkt	The packet.
src	The source address.

Definition at line 328 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:

Address ns3::UanNetDevice::GetAddress ( void ) const

virtual

Returns: the current Address of this interface.

Implements ns3::NetDevice.

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

References m_mac.

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

References m_mac.

Referenced by UanTest::SendOnePacket().

Here is the caller graph for this function:

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

References m_channel.

uint32_t ns3::UanNetDevice::GetIfIndex ( void ) const

virtual

Returns: index ifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex.

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

Get the MAC used by this device.

Returns: The MAC.

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

References m_mac.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

References m_mtu.

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

multicastGroup The 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 266 of file uan-net-device.cc.

References m_mac, and NS_FATAL_ERROR.

Address ns3::UanNetDevice::GetMulticast ( Ipv6Address addr ) const

virtual

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

Parameters

addr	IPv6 address

Returns: the MAC multicast address

Warning: Calling this method is invalid if IsMulticast returns not true.

Implements ns3::NetDevice.

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

References m_mac, and NS_FATAL_ERROR.

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

References m_node.

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

Get the Phy used by this device.

Returns: The Phy.

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

References m_phy.

Referenced by AcousticModemEnergyTestCase::DoRun(), and GetTypeId().

Here is the caller graph for this function:

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

Get the transducer associated with this device.

Returns: The transducer.

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

References m_trans.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::UanNetDevice::GetTypeId ( void )

static

Register this type.

Returns: The TypeId.

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

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

Here is the call graph for this function:

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

bool ns3::UanNetDevice::IsBroadcast ( void ) const

virtual

Returns: true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

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

bool ns3::UanNetDevice::IsLinkUp ( void ) const

virtual

Returns: true if link is up; false otherwise

Implements ns3::NetDevice.

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

References m_linkup, and m_phy.

bool ns3::UanNetDevice::IsMulticast ( void ) const

virtual

Returns: value of m_isMulticast flag

Implements ns3::NetDevice.

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

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

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

bool ns3::UanNetDevice::Send	(	Ptr< Packet >	packet,
		const Address &	dest,
		uint16_t	protocolNumber
	)

virtual

Parameters

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

Returns: whether the Send operation succeeded

Implements ns3::NetDevice.

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

References m_mac.

Referenced by UanTest::SendOnePacket(), AcousticModemEnergyTestCase::SendOnePacket(), and AcousticModemEnergyDepletionTestCase::SendOnePacket().

Here is the caller graph for this function:

bool ns3::UanNetDevice::SendFrom	(	Ptr< Packet >	packet,
		const Address &	source,
		const Address &	dest,
		uint16_t	protocolNumber
	)

virtual

Parameters

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.

Returns: whether the Send operation succeeded

Implements ns3::NetDevice.

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

References NS_ASSERT_MSG.

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

virtual

Set the address of this interface.

Parameters

address address to set

Implements ns3::NetDevice.

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

References ns3::UanAddress::ConvertFrom(), m_mac, and NS_ASSERT_MSG.

Here is the call graph for this function:

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

Attach a channel.

Parameters

channel The channel.

Definition at line 163 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:

void ns3::UanNetDevice::SetIfIndex ( const uint32_t index )

virtual

Parameters

index ifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex.

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

Set the MAC layer for this device.

Parameters

mac	The MAC layer.

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

References ForwardUp(), m_mac, m_phy, 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:

bool ns3::UanNetDevice::SetMtu ( const uint16_t mtu )

virtual

Parameters

mtu	MTU 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 227 of file uan-net-device.cc.

References m_mtu, and NS_LOG_WARN.

void ns3::UanNetDevice::SetNode ( Ptr< Node > node )

virtual

Parameters

node	the node associated to this netdevice.

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

Implements ns3::NetDevice.

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

References m_node.

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

Set the Phy layer for this device.

Parameters

phy	The PHY layer.

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

References m_mac, m_phy, m_trans, and NS_LOG_DEBUG.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::UanNetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback cb )

virtual

Parameters

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

References NS_ASSERT_MSG.

void ns3::UanNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback cb )

virtual

Parameters