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

#include <aloha-noack-net-device.h>

+ Inheritance diagram for ns3::AlohaNoackNetDevice:

Public Types

enum  State { IDLE, TX, RX }
 
- 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
}
 
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

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 addr) 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< ObjectGetPhy () 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 NotifyReceptionEndError ()
 
void NotifyReceptionEndOk (Ptr< Packet > p)
 
void NotifyReceptionStart ()
 
void NotifyTransmissionEnd (Ptr< const Packet >)
 
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)
 
void SetChannel (Ptr< Channel > c)
 
void SetGenericPhyTxStartCallback (GenericPhyTxStartCallback c)
 
virtual void SetIfIndex (const uint32_t index)
 
virtual bool SetMtu (const uint16_t mtu)
 
virtual void SetNode (Ptr< Node > node)
 
void SetPhy (Ptr< Object > phy)
 
virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb)
 
virtual void SetQueue (Ptr< Queue > queue)
 
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
 
virtual bool SupportsSendFrom (void) const
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
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)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

virtual void DoDispose (void)
 
void NotifyGuardIntervalEnd ()
 
void StartTransmission ()
 

Private Attributes

Mac48Address m_address
 
Ptr< Channelm_channel
 
Ptr< Packetm_currentPkt
 
uint32_t m_ifIndex
 
TracedCallback m_linkChangeCallbacks
 
bool m_linkUp
 
TracedCallback< Ptr< const
Packet > > 
m_macPromiscRxTrace
 
TracedCallback< Ptr< const
Packet > > 
m_macRxTrace
 
TracedCallback< Ptr< const
Packet > > 
m_macTxDropTrace
 
TracedCallback< Ptr< const
Packet > > 
m_macTxTrace
 
uint32_t m_mtu
 
Ptr< Nodem_node
 
Ptr< Objectm_phy
 
GenericPhyTxStartCallback m_phyMacTxStartCallback
 
NetDevice::PromiscReceiveCallback m_promiscRxCallback
 
Ptr< Queuem_queue
 
NetDevice::ReceiveCallback m_rxCallback
 
State m_state
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

This devices implements the following features:

  • layer 3 protocol multiplexing
  • MAC addressing
  • Aloha MAC:
    • packets transmitted as soon as possible
    • a new packet is queued if previous one is still being transmitted
    • no acknowledgements, hence no retransmissions
  • can support any PHY layer compatible with the API defined in generic-phy.h

Config Paths

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

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

Attributes

  • Address: The MAC address of this device.
  • Queue: packets being transmitted get queued here
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::Queue >
    • Initial value: 0
    • Flags: construct write read
  • Mtu: The Maximum Transmission Unit
  • Phy: The PHY layer attached to this device.
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::Object >
    • Initial value: 0
    • Flags: construct write read

TraceSources

  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,

Definition at line 59 of file aloha-noack-net-device.h.

Member Function Documentation

void ns3::AlohaNoackNetDevice::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 297 of file aloha-noack-net-device.cc.

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

void ns3::AlohaNoackNetDevice::DoDispose ( void  )
privatevirtual

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 117 of file aloha-noack-net-device.cc.

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

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

Implements ns3::NetDevice.

Definition at line 176 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

Address ns3::AlohaNoackNetDevice::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 190 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

Ptr< Channel > ns3::AlohaNoackNetDevice::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 275 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

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

Implements ns3::NetDevice.

Definition at line 138 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

uint16_t ns3::AlohaNoackNetDevice::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 153 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

Address ns3::AlohaNoackNetDevice::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 204 of file aloha-noack-net-device.cc.

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

Address ns3::AlohaNoackNetDevice::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 212 of file aloha-noack-net-device.cc.

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

Ptr< Node > ns3::AlohaNoackNetDevice::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 236 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

Ptr< Object > ns3::AlohaNoackNetDevice::GetPhy ( void  ) const
Returns
a reference to the PHY object embedded in this NetDevice.

Definition at line 259 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::AlohaNoackNetDevice::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 228 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

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

Implements ns3::NetDevice.

Definition at line 183 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

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

Implements ns3::NetDevice.

Definition at line 290 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

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

Implements ns3::NetDevice.

Definition at line 197 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::AlohaNoackNetDevice::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 221 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::AlohaNoackNetDevice::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 283 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::NotifyReceptionEndError ( )

Notify the MAC that the PHY finished a reception with an error

Definition at line 439 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::NotifyReceptionEndOk ( Ptr< Packet p)
void ns3::AlohaNoackNetDevice::NotifyReceptionStart ( )

Notify the MAC that the PHY has started a reception

Definition at line 431 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::AdhocAlohaNoackIdealPhyHelper::Install().

void ns3::AlohaNoackNetDevice::NotifyTransmissionEnd ( Ptr< const Packet )

Notify the MAC that the PHY has finished a previously started transmission

Definition at line 414 of file aloha-noack-net-device.cc.

References NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Simulator::ScheduleNow(), and StartTransmission().

Referenced by ns3::AdhocAlohaNoackIdealPhyHelper::Install().

bool ns3::AlohaNoackNetDevice::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 326 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION, and SendFrom().

bool ns3::AlohaNoackNetDevice::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 333 of file aloha-noack-net-device.cc.

References ns3::Packet::AddHeader(), ns3::Mac48Address::ConvertFrom(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and StartTransmission().

Referenced by Send().

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

Set the address of this interface

Parameters
addressaddress to set

Implements ns3::NetDevice.

Definition at line 169 of file aloha-noack-net-device.cc.

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

void ns3::AlohaNoackNetDevice::SetChannel ( Ptr< Channel c)

This class doesn't talk directly with the underlying channel (a dedicated PHY class is expected to do it), however the NetDevice specification features a GetChannel() method. This method here is therefore provide to allow AlohaNoackNetDevice::GetChannel() to have something meaningful to return.

Parameters
cthe underlying channel

Definition at line 267 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::SetGenericPhyTxStartCallback ( GenericPhyTxStartCallback  c)

set the callback used to instruct the lower layer to start a TX

Parameters
c

Definition at line 387 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

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

Implements ns3::NetDevice.

Definition at line 131 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

bool ns3::AlohaNoackNetDevice::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 145 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::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 243 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::SetPhy ( Ptr< Object phy)

Set the Phy object which is attached to this device. This object is needed so that we can set/get attributes and connect to trace sources of the PHY from the net device.

Parameters
phythe Phy object attached to the device. Note that the API between the PHY and the above (this NetDevice which also implements the MAC) is implemented entirely by callbacks, so we do not require that the PHY inherits by any specific class.

Definition at line 251 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::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 311 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::SetQueue ( Ptr< Queue queue)
virtual

set the queue which is going to be used by this device

Parameters
queue

Definition at line 161 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::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 304 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

void ns3::AlohaNoackNetDevice::StartTransmission ( )
private

start the transmission of a packet by contacting the PHY layer

Definition at line 394 of file aloha-noack-net-device.cc.

References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by NotifyTransmissionEnd(), and SendFrom().

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

Implements ns3::NetDevice.

Definition at line 318 of file aloha-noack-net-device.cc.

References NS_LOG_FUNCTION.

Member Data Documentation

TracedCallback ns3::AlohaNoackNetDevice::m_linkChangeCallbacks
private

List of callbacks to fire if the link changes state (up or down).

Definition at line 212 of file aloha-noack-net-device.h.

Referenced by AddLinkChangeCallback().


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