Public Member Functions | Static Public Member Functions

ns3::PointToPointNetDevice Class Reference

A Device for a Point to Point Network Link. More...

#include <point-to-point-net-device.h>

Inheritance diagram for ns3::PointToPointNetDevice:
Inheritance graph
[legend]
Collaboration diagram for ns3::PointToPointNetDevice:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 PointToPointNetDevice ()
virtual ~PointToPointNetDevice ()
void SetDataRate (DataRate bps)
void SetInterframeGap (Time t)
bool Attach (Ptr< PointToPointChannel > ch)
void SetQueue (Ptr< Queue > queue)
Ptr< Queue > GetQueue (void) const
void SetReceiveErrorModel (Ptr< ErrorModel > em)
void Receive (Ptr< Packet > p)
virtual void SetIfIndex (const uint32_t index)
virtual uint32_t GetIfIndex (void) const
virtual Ptr< Channel > GetChannel (void) const
virtual void SetAddress (Address address)
virtual Address GetAddress (void) const
virtual bool SetMtu (const uint16_t mtu)
virtual uint16_t GetMtu (void) const
virtual bool IsLinkUp (void) const
virtual void AddLinkChangeCallback (Callback< void > callback)
virtual bool IsBroadcast (void) const
virtual Address GetBroadcast (void) const
virtual bool IsMulticast (void) const
virtual Address GetMulticast (Ipv4Address multicastGroup) const
 Make and return a MAC multicast address using the provided multicast group.
virtual bool IsPointToPoint (void) const
 Return true if the net device is on a point-to-point link.
virtual bool IsBridge (void) const
 Return true if the net device is acting as a bridge.
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 Ptr< Node > GetNode (void) const
virtual void SetNode (Ptr< Node > node)
virtual bool NeedsArp (void) const
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
virtual Address GetMulticast (Ipv6Address addr) const
 Get the MAC multicast address corresponding to the IPv6 address provided.
virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb)
virtual bool SupportsSendFrom (void) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::PointToPointNetDevice.

Detailed Description

A Device for a Point to Point Network Link.

This PointToPointNetDevice class specializes the NetDevice abstract base class. Together with a PointToPointChannel (and a peer PointToPointNetDevice), the class models, with some level of abstraction, a generic point-to-point or serial link. Key parameters or objects that can be specified for this device include a queue, data rate, and interframe transmission gap (the propagation delay is set in the PointToPointChannel).

Constructor & Destructor Documentation

ns3::PointToPointNetDevice::PointToPointNetDevice (  ) 

Construct a PointToPointNetDevice

This is the constructor for the PointToPointNetDevice. It takes as a parameter a pointer to the Node to which this device is connected, as well as an optional DataRate object.

virtual ns3::PointToPointNetDevice::~PointToPointNetDevice (  )  [virtual]

Destroy a PointToPointNetDevice

This is the destructor for the PointToPointNetDevice.

Member Function Documentation

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

bool ns3::PointToPointNetDevice::Attach ( Ptr< PointToPointChannel >  ch  ) 

Attach the device to a channel.

Parameters:
ch Ptr to the channel to which this object is being attached.
virtual Address ns3::PointToPointNetDevice::GetAddress ( void   )  const [virtual]
Returns:
the current Address of this interface.

Implements ns3::NetDevice.

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

virtual Ptr<Channel> ns3::PointToPointNetDevice::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.

virtual uint32_t ns3::PointToPointNetDevice::GetIfIndex ( void   )  const [virtual]
Returns:
index ifIndex of the device

Implements ns3::NetDevice.

virtual uint16_t ns3::PointToPointNetDevice::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.

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

A default implementation of GetMulticast is provided, but this method simply NS_ASSERTS. 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.

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

virtual Ptr<Node> ns3::PointToPointNetDevice::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.

Ptr<Queue> ns3::PointToPointNetDevice::GetQueue ( void   )  const

Get a copy of the attached Queue.

Returns:
Ptr to the queue.
static TypeId ns3::PointToPointNetDevice::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::PointToPointNetDevice.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::PointToPointNetDevice
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::PointToPointNetDevice

Attributes defined for this type:

  • Mtu: The MAC-level Maximum Transmission Unit
  • Address: The MAC address of this device.
  • DataRate: The default data rate for point to point links
    • Set with class: DataRateValue
    • Underlying type: DataRate
    • Initial value: 32768bps
    • Flags: construct write read
  • ReceiveErrorModel: The receiver error model used to simulate packet loss
  • InterframeGap: The time to wait between packet (frame) transmissions
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 0ns
    • Flags: construct write read
  • TxQueue: A queue to use as the transmit queue in the device.

TraceSources defined for this type:

  • 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,
  • PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel
  • PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel
  • PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
  • PhyRxEnd: Trace source indicating a packet has been completely received by the device
  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device

Reimplemented from ns3::NetDevice.

virtual bool ns3::PointToPointNetDevice::IsBridge ( void   )  const [virtual]

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

Returns:
value of m_isBridge flag

Implements ns3::NetDevice.

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

Implements ns3::NetDevice.

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

Implements ns3::NetDevice.

virtual bool ns3::PointToPointNetDevice::IsMulticast ( void   )  const [virtual]
Returns:
value of m_isMulticast flag

Implements ns3::NetDevice.

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

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

void ns3::PointToPointNetDevice::Receive ( Ptr< Packet >  p  ) 

Receive a packet from a connected PointToPointChannel.

The PointToPointNetDevice receives packets from its connected channel and forwards them up the protocol stack. This is the public method used by the channel to indicate that the last bit of a packet has arrived at the device.

See also:
PointToPointChannel
Parameters:
p Ptr to the received packet.
virtual bool ns3::PointToPointNetDevice::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.

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

virtual void ns3::PointToPointNetDevice::SetAddress ( Address  address  )  [virtual]

Set the address of this interface

Parameters:
address address to set

Implements ns3::NetDevice.

void ns3::PointToPointNetDevice::SetDataRate ( DataRate  bps  ) 

Set the Data Rate used for transmission of packets. The data rate is set in the Attach () method from the corresponding field in the channel to which the device is attached. It can be overridden using this method.

See also:
Attach ()
Parameters:
bps the data rate at which this object operates
virtual void ns3::PointToPointNetDevice::SetIfIndex ( const uint32_t  index  )  [virtual]
Parameters:
index ifIndex of the device

Implements ns3::NetDevice.

void ns3::PointToPointNetDevice::SetInterframeGap ( Time  t  ) 

Set the interframe gap used to separate packets. The interframe gap defines the minimum space required between packets sent by this device.

Parameters:
t the interframe gap time
virtual bool ns3::PointToPointNetDevice::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.

Implements ns3::NetDevice.

virtual void ns3::PointToPointNetDevice::SetNode ( Ptr< Node >  node  )  [virtual]
Parameters:
node the node associated to this netdevice.

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

Implements ns3::NetDevice.

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

void ns3::PointToPointNetDevice::SetQueue ( Ptr< Queue >  queue  ) 

Attach a queue to the PointToPointNetDevice.

The PointToPointNetDevice "owns" a queue that implements a queueing method such as DropTail or RED.

See also:
Queue
DropTailQueue
Parameters:
queue Ptr to the new queue.
virtual void ns3::PointToPointNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback  cb  )  [virtual]
Parameters:
cb callback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Implements ns3::NetDevice.

void ns3::PointToPointNetDevice::SetReceiveErrorModel ( Ptr< ErrorModel >  em  ) 

Attach a receive ErrorModel to the PointToPointNetDevice.

The PointToPointNetDevice may optionally include an ErrorModel in the packet receive chain.

See also:
ErrorModel
Parameters:
em Ptr to the ErrorModel.
virtual bool ns3::PointToPointNetDevice::SupportsSendFrom ( void   )  const [virtual]
Returns:
true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

The documentation for this class was generated from the following files:
Generated on Fri Feb 18 2011 15:54:51 for NS-3 by  doxygen 1.7.1