A Device for a Point to Point Network Link. More...
#include <point-to-point-net-device.h>
Public Member Functions | |
| PointToPointNetDevice () | |
| virtual | ~PointToPointNetDevice () |
| void | SetDataRate (DataRate bps) |
| void | SetInterframeGap (Time t) |
| bool | Attach (Ptr< PointToPointChannel > ch) |
| void | SetQueue (Ptr< Queue > queue) |
| void | SetReceiveErrorModel (Ptr< ErrorModel > em) |
| void | Receive (Ptr< Packet > p) |
| void | SetAddress (Mac48Address addr) |
| virtual void | SetName (const std::string name) |
| virtual std::string | GetName (void) const |
| virtual void | SetIfIndex (const uint32_t index) |
| virtual uint32_t | GetIfIndex (void) const |
| virtual Ptr< Channel > | GetChannel (void) const |
| 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 | SetLinkChangeCallback (Callback< void > callback) |
| virtual bool | IsBroadcast (void) const |
| virtual Address | GetBroadcast (void) const |
| virtual bool | IsMulticast (void) const |
| virtual Address | GetMulticast (void) const |
| Return the MAC multicast base address used when mapping multicast groups to MAC multicast addresses. | |
| virtual Address | MakeMulticastAddress (Ipv4Address multicastGroup) const |
| Make and return a MAC multicast address using the provided multicast group. | |
| virtual bool | IsPointToPoint (void) const |
| virtual bool | Send (Ptr< Packet > packet, 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) |
Static Public Member Functions | |
| static TypeId | GetTypeId (void) |
| This method returns the TypeId associated to ns3::PointToPointNetDevice. | |
Private Types | |
| enum | TxMachineState { READY, BUSY } |
Private Member Functions | |
| virtual void | DoDispose (void) |
| Ptr< Queue > | GetQueue (void) const |
| void | AddHeader (Ptr< Packet > p, uint16_t protocolNumber) |
| bool | ProcessHeader (Ptr< Packet > p, uint16_t ¶m) |
| bool | TransmitStart (Ptr< Packet > p) |
| void | TransmitComplete (void) |
Private Attributes | |
| TxMachineState | m_txMachineState |
| DataRate | m_bps |
| Time | m_tInterframeGap |
| Ptr< PointToPointChannel > | m_channel |
| Ptr< Queue > | m_queue |
| TracedCallback< Ptr< const Packet > > | m_rxTrace |
| TracedCallback< Ptr< const Packet > > | m_dropTrace |
| Ptr< ErrorModel > | m_receiveErrorModel |
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).
Member Enumeration Documentation
enum ns3::PointToPointNetDevice::TxMachineState [private] |
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
Adds the necessary headers and trailers to a packet of data in order to respect the protocol implemented by the agent.
| 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 void ns3::PointToPointNetDevice::DoDispose | ( | void | ) | [private, virtual] |
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.
Reimplemented from ns3::Object.
| 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.
- Returns:
- the channel this NetDevice is connected to. The value returned can be zero if the NetDevice is not yet connected to any channel.
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 | ( | void | ) | const [virtual] |
Return the MAC multicast base address used when mapping multicast groups to MAC multicast addresses.
Typically when one constructs a multicast MAC addresses, some bits from the IP multicast group are copied into a corresponding MAC multicast group. In EUI-48, for example, the low order 23 bits of the multicast group are copied to the MAC multicast group base address.
This method allows access to the underlying MAC multicast group base address. It is expected that in most cases, a net device client will allow the net device to perform the actual construction of the multicast address. Use of this method is discouraged unless you have a good reason to perform a custom mapping. You should prefer NetDevice::MakeMulticastAddress which will do the RFC-specified mapping for the net device in question.
- Returns:
- The multicast address supported by this net device.
- Warning:
- Calling this method is invalid if IsMulticast returns not true. The method NS_ASSERTs if the device is not a multicast device.
- See also:
- NetDevice::MakeMulticastAddress
Implements ns3::NetDevice.
| virtual std::string ns3::PointToPointNetDevice::GetName | ( | void | ) | const [virtual] |
- Returns:
- name name of the device (e.g. "eth0")
Implements ns3::NetDevice.
- 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.
| 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]/$ns3PointToPointNetDevice
Attributes defined for this type:
-
Address: The MAC address of this device.
- Set with class: Mac48AddressValue
- Underlying type: Mac48Address
- Initial value: ff:ff:ff:ff:ff:ff
- Flags: construct write read
-
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
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::ErrorModel >
- Initial value: 0
- Flags: construct write read
-
TxQueue: A queue to use as the transmit queue in the device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::Queue >
- Initial value: 0
- Flags: construct write read
- InterframeGap: The time to wait between packet (frame) transmissions
TraceSources defined for this type:
- Rx: Trace source to fire on reception of a MAC packet.
- Drop: Trace source to fire on when a MAC packet is dropped.
Reimplemented from 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] |
- Returns:
- value of m_isPointToPoint flag
Implements ns3::NetDevice.
| virtual Address ns3::PointToPointNetDevice::MakeMulticastAddress | ( | 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 imlementation of MakeMulticastAddress 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 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.
Removes, from a packet of data, all headers and trailers that relate to the protocol implemented by the agent
- Returns:
- Returns true if the packet should be forwarded up the protocol stack.
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.
| void ns3::PointToPointNetDevice::SetAddress | ( | Mac48Address | addr | ) |
| 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 inteframe 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 void ns3::PointToPointNetDevice::SetLinkChangeCallback | ( | Callback< void > | callback | ) | [virtual] |
- Parameters:
-
callback the callback to invoke
Register 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 whenever the link goes up.
Implements ns3::NetDevice.
| 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::SetName | ( | const std::string | name | ) | [virtual] |
- Parameters:
-
name name of the device (e.g. "eth0")
Implements ns3::NetDevice.
- Parameters:
-
node the node associated to this netdevice.
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
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.
| void ns3::PointToPointNetDevice::TransmitComplete | ( | void | ) | [private] |
Stop Sending a Packet Down the Wire and Begin the Interframe Gap.
The TransmitComplete method is used internally to finish the process of sending a packet out on the channel.
Start Sending a Packet Down the Wire.
The TransmitStart method is the method that is used internally in the PointToPointNetDevice to begin the process of sending a packet out on the channel. The corresponding method is called on the channel to let it know that the physical device this class represents has virually started sending signals. An event is scheduled for the time at which the bits have been completely transmitted.
- See also:
- PointToPointChannel::TransmitStart ()
- TransmitCompleteEvent ()
- Parameters:
-
p a reference to the packet to send
- Returns:
- true if success, false on failure
Member Data Documentation
DataRate ns3::PointToPointNetDevice::m_bps [private] |
The data rate that the Net Device uses to simulate packet transmission timing.
- See also:
- class DataRate
The PointToPointChannel to which this PointToPointNetDevice has been attached.
- See also:
- class PointToPointChannel
TracedCallback<Ptr<const Packet> > ns3::PointToPointNetDevice::m_dropTrace [private] |
The trace source for the packet drop events that the device can fire.
- See also:
- class CallBackTraceSource
Ptr<Queue> ns3::PointToPointNetDevice::m_queue [private] |
The Queue which this PointToPointNetDevice uses as a packet source. Management of this Queue has been delegated to the PointToPointNetDevice and it has the responsibility for deletion.
- See also:
- class Queue
- class DropTailQueue
Error model for receive packet events
TracedCallback<Ptr<const Packet> > ns3::PointToPointNetDevice::m_rxTrace [private] |
The trace source for the packet reception events that the device can fire.
- See also:
- class CallBackTraceSource
The interframe gap that the Net Device uses to throttle packet transmission
- See also:
- class Time
The state of the Net Device transmit state machine.
- See also:
- TxMachineState
The documentation for this class was generated from the following files:
- src/devices/point-to-point/point-to-point-net-device.h
- doc/introspected-doxygen.h
