A Device for a Point to Point Network Link. More...
#include "point-to-point-net-device.h"
Public Member Functions | |
PointToPointNetDevice () | |
Construct a PointToPointNetDevice. More... | |
virtual | ~PointToPointNetDevice () |
Destroy a PointToPointNetDevice. More... | |
virtual void | AddLinkChangeCallback (Callback< void > callback) |
bool | Attach (Ptr< PointToPointChannel > ch) |
Attach the device to a channel. More... | |
virtual Address | GetAddress (void) const |
virtual Address | GetBroadcast (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
virtual uint32_t | GetIfIndex (void) const |
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< Queue< Packet > > | GetQueue (void) const |
Get a copy of the attached Queue. 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 |
void | Receive (Ptr< Packet > p) |
Receive a packet from a connected PointToPointChannel. More... | |
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 | SetDataRate (DataRate bps) |
Set the Data Rate used for transmission of packets. More... | |
virtual void | SetIfIndex (const uint32_t index) |
void | SetInterframeGap (Time t) |
Set the interframe gap used to separate packets. More... | |
virtual bool | SetMtu (const uint16_t mtu) |
virtual void | SetNode (Ptr< Node > node) |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
void | SetQueue (Ptr< Queue< Packet > > queue) |
Attach a queue to the PointToPointNetDevice. More... | |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
void | SetReceiveErrorModel (Ptr< ErrorModel > em) |
Attach a receive ErrorModel to the PointToPointNetDevice. 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< Object > | GetObject () 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< Object > | GetObject (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... | |
SimpleRefCount & | operator= ([[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) |
Get the TypeId. 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 | |
void | DoMpiReceive (Ptr< Packet > p) |
Handler for MPI receive event. More... | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. 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 Types | |
enum | TxMachineState { READY , BUSY } |
Enumeration of the states of the transmit machine of the net device. More... | |
Private Member Functions | |
PointToPointNetDevice (const PointToPointNetDevice &o) | |
Copy constructor. More... | |
void | AddHeader (Ptr< Packet > p, uint16_t protocolNumber) |
Adds the necessary headers and trailers to a packet of data in order to respect the protocol implemented by the agent. More... | |
virtual void | DoDispose (void) |
Dispose of the object. More... | |
Address | GetRemote (void) const |
void | NotifyLinkUp (void) |
Make the link up and running. More... | |
PointToPointNetDevice & | operator= (const PointToPointNetDevice &o) |
Assign operator. More... | |
bool | ProcessHeader (Ptr< Packet > p, uint16_t ¶m) |
Removes, from a packet of data, all headers and trailers that relate to the protocol implemented by the agent. More... | |
void | TransmitComplete (void) |
Stop Sending a Packet Down the Wire and Begin the Interframe Gap. More... | |
bool | TransmitStart (Ptr< Packet > p) |
Start Sending a Packet Down the Wire. More... | |
Static Private Member Functions | |
static uint16_t | EtherToPpp (uint16_t protocol) |
Ethernet to PPP protocol number mapping. More... | |
static uint16_t | PppToEther (uint16_t protocol) |
PPP to Ethernet protocol number mapping. More... | |
Private Attributes | |
Mac48Address | m_address |
Mac48Address of this NetDevice. More... | |
DataRate | m_bps |
The data rate that the Net Device uses to simulate packet transmission timing. More... | |
Ptr< PointToPointChannel > | m_channel |
The PointToPointChannel to which this PointToPointNetDevice has been attached. More... | |
Ptr< Packet > | m_currentPkt |
Current packet processed. More... | |
uint32_t | m_ifIndex |
Index of the interface. More... | |
TracedCallback | m_linkChangeCallbacks |
Callback for the link change event. More... | |
bool | m_linkUp |
Identify if the link is up or not. More... | |
TracedCallback< Ptr< const Packet > > | m_macPromiscRxTrace |
The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). More... | |
TracedCallback< Ptr< const Packet > > | m_macRxDropTrace |
The trace source fired for packets successfully received by the device but are dropped before being forwarded up to higher layers (at the L2/L3 transition). More... | |
TracedCallback< Ptr< const Packet > > | m_macRxTrace |
The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). More... | |
TracedCallback< Ptr< const Packet > > | m_macTxDropTrace |
The trace source fired when packets coming into the "top" of the device at the L3/L2 transition are dropped before being queued for transmission. More... | |
TracedCallback< Ptr< const Packet > > | m_macTxTrace |
The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission. More... | |
uint32_t | m_mtu |
The Maximum Transmission Unit. More... | |
Ptr< Node > | m_node |
Node owning this NetDevice. More... | |
TracedCallback< Ptr< const Packet > > | m_phyRxBeginTrace |
The trace source fired when a packet begins the reception process from the medium – when the simulated first bit(s) arrive. More... | |
TracedCallback< Ptr< const Packet > > | m_phyRxDropTrace |
The trace source fired when the phy layer drops a packet it has received. More... | |
TracedCallback< Ptr< const Packet > > | m_phyRxEndTrace |
The trace source fired when a packet ends the reception process from the medium. More... | |
TracedCallback< Ptr< const Packet > > | m_phyTxBeginTrace |
The trace source fired when a packet begins the transmission process on the medium. More... | |
TracedCallback< Ptr< const Packet > > | m_phyTxDropTrace |
The trace source fired when the phy layer drops a packet before it tries to transmit it. More... | |
TracedCallback< Ptr< const Packet > > | m_phyTxEndTrace |
The trace source fired when a packet ends the transmission process on the medium. More... | |
NetDevice::PromiscReceiveCallback | m_promiscCallback |
Receive callback. More... | |
TracedCallback< Ptr< const Packet > > | m_promiscSnifferTrace |
A trace source that emulates a promiscuous mode protocol sniffer connected to the device. More... | |
Ptr< Queue< Packet > > | m_queue |
The Queue which this PointToPointNetDevice uses as a packet source. More... | |
Ptr< ErrorModel > | m_receiveErrorModel |
Error model for receive packet events. More... | |
NetDevice::ReceiveCallback | m_rxCallback |
Receive callback. More... | |
TracedCallback< Ptr< const Packet > > | m_snifferTrace |
A trace source that emulates a non-promiscuous protocol sniffer connected to the device. More... | |
Time | m_tInterframeGap |
The interframe gap that the Net Device uses to throttle packet transmission. More... | |
TxMachineState | m_txMachineState |
The state of the Net Device transmit state machine. More... | |
Static Private Attributes | |
static const uint16_t | DEFAULT_MTU = 1500 |
Default MTU. More... | |
Additional Inherited Members | |
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 PacketType > | PromiscReceiveCallback |
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address & > | ReceiveCallback |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
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).
ns3::PointToPointNetDevice is accessible through the following paths with Config::Set and Config::Connect:
Size of this type is 464 bytes (on a 64-bit architecture).
Definition at line 62 of file point-to-point-net-device.h.
|
private |
Enumeration of the states of the transmit machine of the net device.
Enumerator | |
---|---|
READY | The transmitter is ready to begin transmission of a packet. |
BUSY | The transmitter is busy transmitting a packet. |
Definition at line 288 of file point-to-point-net-device.h.
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.
Definition at line 175 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Destroy a PointToPointNetDevice.
This is the destructor for the PointToPointNetDevice.
Definition at line 185 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
private |
Adds the necessary headers and trailers to a packet of data in order to respect the protocol implemented by the agent.
p | packet |
protocolNumber | protocol number |
Definition at line 191 of file point-to-point-net-device.cc.
References ns3::Packet::AddHeader(), EtherToPpp(), NS_LOG_FUNCTION, and ns3::PppHeader::SetProtocol().
Referenced by Send().
|
virtual |
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 442 of file point-to-point-net-device.cc.
References ns3::TracedCallback< Ts >::ConnectWithoutContext(), m_linkChangeCallbacks, and NS_LOG_FUNCTION.
bool ns3::PointToPointNetDevice::Attach | ( | Ptr< PointToPointChannel > | ch | ) |
Attach the device to a channel.
ch | Ptr to the channel to which this object is being attached. |
Definition at line 300 of file point-to-point-net-device.cc.
References m_channel, NotifyLinkUp(), and NS_LOG_FUNCTION.
|
privatevirtual |
Dispose of the object.
Reimplemented from ns3::Object.
Definition at line 210 of file point-to-point-net-device.cc.
References ns3::Object::DoDispose(), m_channel, m_currentPkt, m_node, m_queue, m_receiveErrorModel, and NS_LOG_FUNCTION.
Handler for MPI receive event.
p | Packet received |
Definition at line 609 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION, and Receive().
|
staticprivate |
Ethernet to PPP protocol number mapping.
protocol | An Ethernet protocol number |
Definition at line 662 of file point-to-point-net-device.cc.
References NS_ASSERT_MSG, and NS_LOG_FUNCTION_NOARGS.
Referenced by AddHeader().
|
virtual |
Implements ns3::NetDevice.
Definition at line 429 of file point-to-point-net-device.cc.
References m_address.
Referenced by Receive().
|
virtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 465 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
Implements ns3::NetDevice.
Definition at line 410 of file point-to-point-net-device.cc.
References m_channel.
|
virtual |
Implements ns3::NetDevice.
Definition at line 404 of file point-to-point-net-device.cc.
References m_ifIndex.
|
virtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 642 of file point-to-point-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
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.
multicastGroup | The IP address for the multicast group destination of the packet. |
Implements ns3::NetDevice.
Definition at line 479 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 486 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
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 570 of file point-to-point-net-device.cc.
References m_node.
Get a copy of the attached Queue.
Definition at line 382 of file point-to-point-net-device.cc.
References m_queue, and NS_LOG_FUNCTION.
Referenced by ns3::PointToPointHelper::EnableAsciiInternal().
|
private |
Definition at line 616 of file point-to-point-net-device.cc.
References ns3::NetDevice::GetAddress(), m_channel, NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by Receive().
|
static |
Get the TypeId.
Definition at line 39 of file point-to-point-net-device.cc.
References DEFAULT_MTU, GetMtu(), m_address, m_bps, m_macPromiscRxTrace, m_macRxDropTrace, m_macRxTrace, m_macTxDropTrace, m_macTxTrace, m_phyRxBeginTrace, m_phyRxDropTrace, m_phyRxEndTrace, m_phyTxBeginTrace, m_phyTxDropTrace, m_phyTxEndTrace, m_promiscSnifferTrace, m_queue, m_receiveErrorModel, m_snifferTrace, m_tInterframeGap, ns3::MakeDataRateAccessor(), ns3::MakeDataRateChecker(), ns3::MakeMac48AddressAccessor(), ns3::MakeMac48AddressChecker(), ns3::MakePointerAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::Seconds(), SetMtu(), and ns3::TypeId::SetParent().
|
virtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 500 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 453 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 435 of file point-to-point-net-device.cc.
References m_linkUp, and NS_LOG_FUNCTION.
Referenced by Send().
|
virtual |
Implements ns3::NetDevice.
Definition at line 472 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 493 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 583 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
private |
Make the link up and running.
It calls also the linkChange callback.
Definition at line 389 of file point-to-point-net-device.cc.
References m_linkChangeCallbacks, m_linkUp, and NS_LOG_FUNCTION.
Referenced by Attach().
|
private |
|
staticprivate |
PPP to Ethernet protocol number mapping.
protocol | A PPP protocol number |
Definition at line 649 of file point-to-point-net-device.cc.
References NS_ASSERT_MSG, and NS_LOG_FUNCTION_NOARGS.
Referenced by ProcessHeader().
Removes, from a packet of data, all headers and trailers that relate to the protocol implemented by the agent.
p | Packet whose headers need to be processed |
param | An integer parameter that can be set by the function |
Definition at line 200 of file point-to-point-net-device.cc.
References ns3::PppHeader::GetProtocol(), NS_LOG_FUNCTION, PppToEther(), and ns3::Packet::RemoveHeader().
Referenced by Receive().
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.
p | Ptr to the received packet. |
Definition at line 332 of file point-to-point-net-device.cc.
References ns3::Packet::Copy(), GetAddress(), GetRemote(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_macPromiscRxTrace, m_macRxTrace, m_phyRxDropTrace, m_phyRxEndTrace, m_promiscCallback, m_promiscSnifferTrace, m_receiveErrorModel, m_rxCallback, m_snifferTrace, NS_LOG_FUNCTION, ns3::NetDevice::PACKET_HOST, and ProcessHeader().
Referenced by DoMpiReceive(), ns3::PointToPointHelper::Install(), and ns3::PointToPointChannel::TransmitStart().
|
virtual |
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
Implements ns3::NetDevice.
Definition at line 507 of file point-to-point-net-device.cc.
References AddHeader(), ns3::Packet::GetUid(), IsLinkUp(), m_macTxDropTrace, m_macTxTrace, m_promiscSnifferTrace, m_queue, m_snifferTrace, m_txMachineState, NS_LOG_FUNCTION, NS_LOG_LOGIC, READY, and TransmitStart().
|
virtual |
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.
Implements ns3::NetDevice.
Definition at line 560 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 422 of file point-to-point-net-device.cc.
References first::address, ns3::Mac48Address::ConvertFrom(), m_address, and NS_LOG_FUNCTION.
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.
bps | the data rate at which this object operates |
Definition at line 222 of file point-to-point-net-device.cc.
References m_bps, and NS_LOG_FUNCTION.
|
virtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 397 of file point-to-point-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
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.
t | the interframe gap time |
Definition at line 229 of file point-to-point-net-device.cc.
References ns3::Time::As(), m_tInterframeGap, NS_LOG_FUNCTION, and ns3::Time::S.
|
virtual |
mtu | MTU value, in bytes, to set for the device |
Override for default MTU defined on a per-type basis.
Implements ns3::NetDevice.
Definition at line 634 of file point-to-point-net-device.cc.
References m_mtu, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 576 of file point-to-point-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
|
virtual |
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 596 of file point-to-point-net-device.cc.
References m_promiscCallback.
Attach a queue to the PointToPointNetDevice.
The PointToPointNetDevice "owns" a queue that implements a queueing method such as DropTailQueue or RedQueue
queue | Ptr to the new queue. |
Definition at line 318 of file point-to-point-net-device.cc.
References m_queue, and NS_LOG_FUNCTION.
|
virtual |
cb | callback 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 590 of file point-to-point-net-device.cc.
References m_rxCallback.
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.
em | Ptr to the ErrorModel. |
Definition at line 325 of file point-to-point-net-device.cc.
References m_receiveErrorModel, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 602 of file point-to-point-net-device.cc.
References NS_LOG_FUNCTION.
|
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.
Definition at line 266 of file point-to-point-net-device.cc.
References BUSY, m_currentPkt, m_phyTxEndTrace, m_promiscSnifferTrace, m_queue, m_snifferTrace, m_txMachineState, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, READY, and TransmitStart().
Referenced by TransmitStart().
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 virtually started sending signals. An event is scheduled for the time at which the bits have been completely transmitted.
p | a reference to the packet to send |
Definition at line 236 of file point-to-point-net-device.cc.
References ns3::Time::As(), BUSY, ns3::DataRate::CalculateBytesTxTime(), ns3::Packet::GetSize(), ns3::Packet::GetUid(), m_bps, m_channel, m_currentPkt, m_phyTxBeginTrace, m_phyTxDropTrace, m_tInterframeGap, m_txMachineState, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, READY, test-ns3::result, ns3::Time::S, ns3::Simulator::Schedule(), and TransmitComplete().
Referenced by Send(), and TransmitComplete().
|
staticprivate |
|
private |
Mac48Address of this NetDevice.
Definition at line 438 of file point-to-point-net-device.h.
Referenced by GetAddress(), GetTypeId(), and SetAddress().
|
private |
The data rate that the Net Device uses to simulate packet transmission timing.
Definition at line 302 of file point-to-point-net-device.h.
Referenced by GetTypeId(), SetDataRate(), and TransmitStart().
|
private |
The PointToPointChannel to which this PointToPointNetDevice has been attached.
Definition at line 314 of file point-to-point-net-device.h.
Referenced by Attach(), DoDispose(), GetChannel(), GetRemote(), and TransmitStart().
Current packet processed.
Definition at line 458 of file point-to-point-net-device.h.
Referenced by DoDispose(), TransmitComplete(), and TransmitStart().
|
private |
Index of the interface.
Definition at line 442 of file point-to-point-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
Callback for the link change event.
Definition at line 444 of file point-to-point-net-device.h.
Referenced by AddLinkChangeCallback(), and NotifyLinkUp().
|
private |
Identify if the link is up or not.
Definition at line 443 of file point-to-point-net-device.h.
Referenced by IsLinkUp(), and NotifyLinkUp().
|
private |
The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition).
This is a promiscuous trace (which doesn't mean a lot here in the point-to-point device).
Definition at line 347 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
The trace source fired for packets successfully received by the device but are dropped before being forwarded up to higher layers (at the L2/L3 transition).
Definition at line 362 of file point-to-point-net-device.h.
Referenced by GetTypeId().
|
private |
The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition).
This is a non-promiscuous trace (which doesn't mean a lot here in the point-to-point device).
Definition at line 355 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
The trace source fired when packets coming into the "top" of the device at the L3/L2 transition are dropped before being queued for transmission.
Definition at line 339 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and Send().
|
private |
The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission.
Definition at line 333 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and Send().
|
private |
The Maximum Transmission Unit.
This corresponds to the maximum number of bytes that can be transmitted as seen from higher layers. This corresponds to the 1500 byte MTU size often seen on IP over Ethernet.
Definition at line 456 of file point-to-point-net-device.h.
Definition at line 437 of file point-to-point-net-device.h.
Referenced by DoDispose(), GetNode(), and SetNode().
|
private |
The trace source fired when a packet begins the reception process from the medium – when the simulated first bit(s) arrive.
Definition at line 386 of file point-to-point-net-device.h.
Referenced by GetTypeId().
|
private |
The trace source fired when the phy layer drops a packet it has received.
This happens if the receiver is not enabled or the error model is active and indicates that the packet is corrupt.
Definition at line 399 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
The trace source fired when a packet ends the reception process from the medium.
Definition at line 392 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and Receive().
|
private |
The trace source fired when a packet begins the transmission process on the medium.
Definition at line 368 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and TransmitStart().
|
private |
The trace source fired when the phy layer drops a packet before it tries to transmit it.
Definition at line 380 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and TransmitStart().
|
private |
The trace source fired when a packet ends the transmission process on the medium.
Definition at line 374 of file point-to-point-net-device.h.
Referenced by GetTypeId(), and TransmitComplete().
|
private |
Receive callback.
Definition at line 440 of file point-to-point-net-device.h.
Referenced by Receive(), and SetPromiscReceiveCallback().
|
private |
A trace source that emulates a promiscuous mode protocol sniffer connected to the device.
This trace source fire on packets destined for any host just like your average everyday packet sniffer.
On the transmit size, this trace hook will fire after a packet is dequeued from the device queue for transmission. In Linux, for example, this would correspond to the point just before a device hard_start_xmit
where dev_queue_xmit_nit
is called to dispatch the packet to the PF_PACKET ETH_P_ALL handlers.
On the receive side, this trace hook will fire when a packet is received, just before the receive callback is executed. In Linux, for example, this would correspond to the point at which the packet is dispatched to packet sniffers in netif_receive_skb
.
Definition at line 435 of file point-to-point-net-device.h.
Referenced by GetTypeId(), Receive(), Send(), and TransmitComplete().
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.
Definition at line 322 of file point-to-point-net-device.h.
Referenced by DoDispose(), GetQueue(), GetTypeId(), Send(), SetQueue(), and TransmitComplete().
|
private |
Error model for receive packet events.
Definition at line 327 of file point-to-point-net-device.h.
Referenced by DoDispose(), GetTypeId(), Receive(), and SetReceiveErrorModel().
|
private |
Receive callback.
Definition at line 439 of file point-to-point-net-device.h.
Referenced by Receive(), and SetReceiveCallback().
|
private |
A trace source that emulates a non-promiscuous protocol sniffer connected to the device.
Unlike your average everyday sniffer, this trace source will not fire on PACKET_OTHERHOST events.
On the transmit size, this trace hook will fire after a packet is dequeued from the device queue for transmission. In Linux, for example, this would correspond to the point just before a device hard_start_xmit
where dev_queue_xmit_nit
is called to dispatch the packet to the PF_PACKET ETH_P_ALL handlers.
On the receive side, this trace hook will fire when a packet is received, just before the receive callback is executed. In Linux, for example, this would correspond to the point at which the packet is dispatched to packet sniffers in netif_receive_skb
.
Definition at line 417 of file point-to-point-net-device.h.
Referenced by GetTypeId(), Receive(), Send(), and TransmitComplete().
|
private |
The interframe gap that the Net Device uses to throttle packet transmission.
Definition at line 308 of file point-to-point-net-device.h.
Referenced by GetTypeId(), SetInterframeGap(), and TransmitStart().
|
private |
The state of the Net Device transmit state machine.
Definition at line 296 of file point-to-point-net-device.h.
Referenced by Send(), TransmitComplete(), and TransmitStart().