A Device for a Csma Network Link. More...

#include "csma-net-device.h"

Inheritance diagram for ns3::CsmaNetDevice:

Collaboration diagram for ns3::CsmaNetDevice:

Public Types
enum	EncapsulationMode { ILLEGAL , DIX , LLC }
	Enumeration of the types of packets supported in the class. More...

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

Public Member Functions
	CsmaNetDevice ()
	Construct a CsmaNetDevice. More...

virtual	~CsmaNetDevice ()
	Destroy a CsmaNetDevice. More...

virtual void	AddLinkChangeCallback (Callback< void > callback)

int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model. More...

bool	Attach (Ptr< CsmaChannel > ch)
	Attach the device to a channel. More...

virtual Address	GetAddress (void) const

virtual Address	GetBroadcast (void) const

virtual Ptr< Channel >	GetChannel (void) const

CsmaNetDevice::EncapsulationMode	GetEncapsulationMode (void)
	Get the encapsulation mode of this device. More...

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
	Get the node to which this device is attached. More...

Ptr< Queue< Packet > >	GetQueue (void) const
	Get a copy of the attached Queue. More...

virtual bool	IsBridge (void) const
	Is this a bridge? More...

virtual bool	IsBroadcast (void) const

virtual bool	IsLinkUp (void) const

virtual bool	IsMulticast (void) const

virtual bool	IsPointToPoint (void) const
	Is this a point to point link? More...

bool	IsReceiveEnabled (void)
	Is the receive side of the network device enabled? More...

bool	IsSendEnabled (void)
	Is the send side of the network device enabled? More...

virtual bool	NeedsArp (void) const
	Does this device need to use the address resolution protocol? More...

void	Receive (Ptr< Packet > p, Ptr< CsmaNetDevice > sender)
	Receive a packet from a connected CsmaChannel. More...

virtual bool	Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
	Start sending a packet down the channel. More...

virtual bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
	Start sending a packet down the channel, with MAC spoofing. More...

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

void	SetBackoffParams (Time slotTime, uint32_t minSlots, uint32_t maxSlots, uint32_t maxRetries, uint32_t ceiling)
	Set the backoff parameters used to determine the wait to retry transmitting a packet when the channel is busy. More...

void	SetEncapsulationMode (CsmaNetDevice::EncapsulationMode mode)
	Set the encapsulation mode of this device. 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)
	Set the node to which this device is being attached. More...

virtual void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)

void	SetQueue (Ptr< Queue< Packet > > queue)
	Attach a queue to the CsmaNetDevice. More...

virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)
	Set the callback to be used to notify higher layers when a packet has been received. More...

void	SetReceiveEnable (bool enable)
	Enable or disable the receive side of the network device. More...

void	SetReceiveErrorModel (Ptr< ErrorModel > em)
	Attach a receive ErrorModel to the CsmaNetDevice. More...

void	SetSendEnable (bool enable)
	Enable or disable the send side of the network device. 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 type ID. 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	AddHeader (Ptr< Packet > p, Mac48Address source, Mac48Address dest, uint16_t protocolNumber)
	Adds the necessary headers and trailers to a packet of data in order to respect the packet type. More...

virtual void	DoDispose (void)
	Perform any object release functionality required to break reference cycles in reference counted objects held by the device. 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 , GAP , BACKOFF }
	Enumeration of the states of the transmit machine of the net device. More...

Private Member Functions
	CsmaNetDevice (const CsmaNetDevice &o)
	Copy constructor is declared but not implemented. More...

void	Init (bool sendEnable, bool receiveEnable)
	Initialization function used during object construction. More...

void	NotifyLinkUp (void)
	Notify any interested parties that the link has come up. More...

CsmaNetDevice &	operator= (const CsmaNetDevice &o)
	Operator = is declared but not implemented. More...

void	TransmitAbort (void)
	Aborts the transmission of the current packet. More...

void	TransmitCompleteEvent (void)
	Stop Sending a Packet Down the Wire and Begin the Interframe Gap. More...

void	TransmitReadyEvent (void)
	Cause the Transmitter to Become Ready to Send Another Packet. More...

void	TransmitStart ()
	Start Sending a Packet Down the Wire. More...

Private Attributes
Mac48Address	m_address
	The MAC address which has been assigned to this device. More...

Backoff	m_backoff
	Holds the backoff parameters and is used to calculate the next backoff time to use when the channel is busy and the net device is ready to transmit. More...

DataRate	m_bps
	The data rate that the Net Device uses to simulate packet transmission timing. More...

Ptr< CsmaChannel >	m_channel
	The CsmaChannel to which this CsmaNetDevice has been attached. More...

Ptr< Packet >	m_currentPkt
	Next packet that will be transmitted (if transmitter is not currently transmitting) or packet that is currently being transmitted. More...

uint32_t	m_deviceId
	Device ID returned by the attached functions. More...

EncapsulationMode	m_encapMode
	The type of packet that should be created by the AddHeader function and that should be processed by the ProcessHeader function. More...

uint32_t	m_ifIndex
	The interface index (really net evice index) that has been assigned to this network device. More...

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

bool	m_linkUp
	Flag indicating whether or not the link is up. 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 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_macTxBackoffTrace
	The trace source fired when the mac layer is forced to begin the backoff process for a packet. 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
	The Node to which this device is attached. More...

TracedCallback< Ptr< const Packet > >	m_phyRxBeginTrace
	The trace source fired when a packet begins the reception process from the medium. 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 as 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_promiscRxCallback
	The callback used to notify higher layers that a packet has been received in promiscuous mode. 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 CsmaNetDevice uses as a packet source. More...

bool	m_receiveEnable
	Enable net device to receive packets. More...

Ptr< ErrorModel >	m_receiveErrorModel
	Error model for receive packet events. More...

NetDevice::ReceiveCallback	m_rxCallback
	The callback used to notify higher layers that a packet has been received. More...

bool	m_sendEnable
	Enable net device to send packets. 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 insert time between 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 Maximum Transmission Unit (MTU) for the CsmaNetDevice. More...

Additional Inherited Members
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...

Detailed Description

A Device for a Csma Network Link.

The Csma net device class is analogous to layer 1 and 2 of the TCP stack. The NetDevice takes a raw packet of bytes and creates a protocol specific packet from them.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice"

Attributes

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
Mtu: The MAC-level Maximum Transmission Unit
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 1500
- Flags: construct write read
EncapsulationMode: The link-layer encapsulation type to use.
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: Dix
- Flags: construct write
SendEnable: Enable or disable the transmitter section of the device.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
ReceiveEnable: Enable or disable the receiver section of the device.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- 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<Packet>>
- Initial value: 0
- Flags: construct write read

TraceSources

MacTx: Trace source indicating a packet has arrived for transmission by this device
Callback signature: ns3::Packet::TracedCallback
MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
Callback signature: ns3::Packet::TracedCallback
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,
Callback signature: ns3::Packet::TracedCallback
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,
Callback signature: ns3::Packet::TracedCallback
MacTxBackoff: Trace source indicating a packet has been delayed by the CSMA backoff process
Callback signature: ns3::Packet::TracedCallback
PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel
Callback signature: ns3::Packet::TracedCallback
PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel
Callback signature: ns3::Packet::TracedCallback
PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
Callback signature: ns3::Packet::TracedCallback
PhyRxEnd: Trace source indicating a packet has been completely received by the device
Callback signature: ns3::Packet::TracedCallback
PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception
Callback signature: ns3::Packet::TracedCallback
Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
Callback signature: ns3::Packet::TracedCallback
PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device
Callback signature: ns3::Packet::TracedCallback

Size of this type is 544 bytes (on a 64-bit architecture).

Definition at line 58 of file csma-net-device.h.

Member Enumeration Documentation

◆ EncapsulationMode

enum ns3::CsmaNetDevice::EncapsulationMode

Enumeration of the types of packets supported in the class.

Enumerator
ILLEGAL	Encapsulation mode not set.
DIX	DIX II / Ethernet II packet.
LLC	802.2 LLC/SNAP Packet

Definition at line 71 of file csma-net-device.h.

◆ TxMachineState

enum ns3::CsmaNetDevice::TxMachineState

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.
GAP	The transmitter is in the interframe gap time.
BACKOFF	The transmitter is waiting for the channel to be free.

Definition at line 470 of file csma-net-device.h.

Constructor & Destructor Documentation

◆ CsmaNetDevice() [1/2]

ns3::CsmaNetDevice::CsmaNetDevice ( )

Construct a CsmaNetDevice.

This is the default constructor for a CsmaNetDevice.

Definition at line 186 of file csma-net-device.cc.

References DIX, m_channel, m_encapMode, m_tInterframeGap, m_txMachineState, NS_LOG_FUNCTION, READY, and ns3::Seconds().

Here is the call graph for this function:

◆ ~CsmaNetDevice()

ns3::CsmaNetDevice::~CsmaNetDevice ( )

virtual

Destroy a CsmaNetDevice.

This is the destructor for a CsmaNetDevice.

Definition at line 208 of file csma-net-device.cc.

References m_queue, and NS_LOG_FUNCTION_NOARGS.

◆ CsmaNetDevice() [2/2]

ns3::CsmaNetDevice::CsmaNetDevice ( const CsmaNetDevice & o )

private

Copy constructor is declared but not implemented.

This disables the copy constructor for CsmaNetDevice objects.

Parameters

o	object to copy

Member Function Documentation

◆ AddHeader()

void ns3::CsmaNetDevice::AddHeader	(	Ptr< Packet >	p,
		Mac48Address	source,
		Mac48Address	dest,
		uint16_t	protocolNumber
	)

protected

Adds the necessary headers and trailers to a packet of data in order to respect the packet type.

Parameters

p	Packet to which header should be added
source	MAC source address from which packet should be sent
dest	MAC destination address to which packet should be sent
protocolNumber	In some protocols, identifies the type of payload contained in this packet.

Definition at line 309 of file csma-net-device.cc.

References ns3::Packet::AddAtEnd(), ns3::Packet::AddHeader(), ns3::Packet::AddTrailer(), ns3::EthernetTrailer::CalcFcs(), ns3::Node::ChecksumEnabled(), DIX, ns3::EthernetTrailer::EnableFcs(), GetMtu(), ns3::Packet::GetSize(), ILLEGAL, LLC, m_encapMode, m_mtu, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::EthernetHeader::SetDestination(), ns3::EthernetHeader::SetLengthType(), ns3::EthernetHeader::SetSource(), and ns3::LlcSnapHeader::SetType().

Referenced by SendFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddLinkChangeCallback()

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

virtual

Parameters

callback the callback to invoke

Add a callback invoked whenever the link status changes to UP. This callback is typically used by the IP/ARP layer to flush the ARP cache and by IPv6 stack to flush NDISC cache whenever the link goes up.

Implements ns3::NetDevice.

Definition at line 881 of file csma-net-device.cc.

References ns3::TracedCallback< Ts >::ConnectWithoutContext(), m_linkChangeCallbacks, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AssignStreams()

int64_t ns3::CsmaNetDevice::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 1052 of file csma-net-device.cc.

References ns3::Backoff::AssignStreams(), and m_backoff.

Here is the call graph for this function:

◆ Attach()

bool ns3::CsmaNetDevice::Attach ( Ptr< CsmaChannel > ch )

Attach the device to a channel.

The function Attach is used to add a CsmaNetDevice to a CsmaChannel.

See also: SetDataRate (); SetInterframeGap ()

Parameters

ch	a pointer to the channel to which this object is being attached.

Returns: true if no error

Definition at line 647 of file csma-net-device.cc.

References ns3::DataRate::CalculateBytesTxTime(), m_bps, m_channel, m_deviceId, m_tInterframeGap, NotifyLinkUp(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoDispose()

void ns3::CsmaNetDevice::DoDispose ( void )

protectedvirtual

Perform any object release functionality required to break reference cycles in reference counted objects held by the device.

Reimplemented from ns3::Object.

Definition at line 215 of file csma-net-device.cc.

References ns3::Object::DoDispose(), m_channel, m_node, m_queue, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

◆ GetAddress()

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

virtual

Returns: the current Address of this interface.

Implements ns3::NetDevice.

Definition at line 867 of file csma-net-device.cc.

References m_address, and NS_LOG_FUNCTION_NOARGS.

◆ GetBroadcast()

Address ns3::CsmaNetDevice::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 895 of file csma-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ GetChannel()

Ptr< Channel > ns3::CsmaNetDevice::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 853 of file csma-net-device.cc.

References m_channel, and NS_LOG_FUNCTION_NOARGS.

◆ GetEncapsulationMode()

CsmaNetDevice::EncapsulationMode ns3::CsmaNetDevice::GetEncapsulationMode ( void )

Get the encapsulation mode of this device.

Returns: The encapsulation mode of this device.

Definition at line 236 of file csma-net-device.cc.

References m_encapMode, and NS_LOG_FUNCTION_NOARGS.

◆ GetIfIndex()

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

virtual

Returns: index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 846 of file csma-net-device.cc.

References m_ifIndex, and NS_LOG_FUNCTION_NOARGS.

◆ GetMtu()

uint16_t ns3::CsmaNetDevice::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 255 of file csma-net-device.cc.

References m_mtu, and NS_LOG_FUNCTION_NOARGS.

Referenced by AddHeader(), and GetTypeId().

Here is the caller graph for this function:

◆ GetMulticast() [1/2]

Address ns3::CsmaNetDevice::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).

This method performs the multicast address creation function appropriate to an EUI-48-based CSMA device. This MAC address is encapsulated in an abstract Address to avoid dependencies on the exact address format.

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.

See also: Ipv4Address; Mac48Address; Address

Implements ns3::NetDevice.

Definition at line 909 of file csma-net-device.cc.

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

Here is the call graph for this function:

◆ GetMulticast() [2/2]

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

virtual

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

Parameters

addr	IPv6 address

Returns: the MAC multicast address

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

Implements ns3::NetDevice.

Definition at line 1029 of file csma-net-device.cc.

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

Here is the call graph for this function:

◆ GetNode()

Ptr< Node > ns3::CsmaNetDevice::GetNode ( void ) const

virtual

Get the node to which this device is attached.

Returns: Ptr to the Node to which the device is attached.

Implements ns3::NetDevice.

Definition at line 1001 of file csma-net-device.cc.

References m_node, and NS_LOG_FUNCTION_NOARGS.

◆ GetQueue()

Ptr< Queue< Packet > > ns3::CsmaNetDevice::GetQueue ( void ) const

Get a copy of the attached Queue.

Returns: a pointer to the queue.

Definition at line 824 of file csma-net-device.cc.

References m_queue, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::CsmaHelper::EnableAsciiInternal().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::CsmaNetDevice::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 43 of file csma-net-device.cc.

References DEFAULT_MTU, DIX, GetMtu(), LLC, m_address, m_macPromiscRxTrace, m_macRxDropTrace, m_macRxTrace, m_macTxBackoffTrace, m_macTxDropTrace, m_macTxTrace, m_phyRxBeginTrace, m_phyRxDropTrace, m_phyRxEndTrace, m_phyTxBeginTrace, m_phyTxDropTrace, m_phyTxEndTrace, m_promiscSnifferTrace, m_queue, m_receiveEnable, m_receiveErrorModel, m_sendEnable, m_snifferTrace, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeMac48AddressAccessor(), ns3::MakeMac48AddressChecker(), ns3::MakePointerAccessor(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), SetEncapsulationMode(), SetMtu(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Init()

void ns3::CsmaNetDevice::Init	(	bool	sendEnable,
		bool	receiveEnable
	)

private

Initialization function used during object construction.

Parameters

sendEnable	if device will be allowed to send
receiveEnable	if device will be allowed to receive

◆ IsBridge()

bool ns3::CsmaNetDevice::IsBridge ( void ) const

virtual

Is this a bridge?

Returns: false.

Implements ns3::NetDevice.

Definition at line 933 of file csma-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ IsBroadcast()

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

virtual

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

Implements ns3::NetDevice.

Definition at line 888 of file csma-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ IsLinkUp()

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

virtual

Returns: true if link is up; false otherwise

Implements ns3::NetDevice.

Definition at line 874 of file csma-net-device.cc.

References m_linkUp, and NS_LOG_FUNCTION_NOARGS.

Referenced by SendFrom().

Here is the caller graph for this function:

◆ IsMulticast()

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

virtual

Returns: value of m_isMulticast flag

Implements ns3::NetDevice.

Definition at line 902 of file csma-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ IsPointToPoint()

bool ns3::CsmaNetDevice::IsPointToPoint ( void ) const

virtual

Is this a point to point link?

Returns: false.

Implements ns3::NetDevice.

Definition at line 926 of file csma-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ IsReceiveEnabled()

bool ns3::CsmaNetDevice::IsReceiveEnabled ( void )

Is the receive side of the network device enabled?

Returns: True if the receiver side is enabled, otherwise false.

Definition at line 284 of file csma-net-device.cc.

References m_receiveEnable, and NS_LOG_FUNCTION_NOARGS.

Referenced by Receive().

Here is the caller graph for this function:

◆ IsSendEnabled()

bool ns3::CsmaNetDevice::IsSendEnabled ( void )

Is the send side of the network device enabled?

Returns: True if the send side is enabled, otherwise false.

Definition at line 277 of file csma-net-device.cc.

References m_sendEnable, and NS_LOG_FUNCTION_NOARGS.

Referenced by SendFrom(), and TransmitStart().

Here is the caller graph for this function:

◆ NeedsArp()

bool ns3::CsmaNetDevice::NeedsArp ( void ) const

virtual

Does this device need to use the address resolution protocol?

Returns: True if the encapsulation mode is set to a value that requires ARP (IP_ARP or LLC).

Implements ns3::NetDevice.

Definition at line 1016 of file csma-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ NotifyLinkUp()

void ns3::CsmaNetDevice::NotifyLinkUp ( void )

private

Notify any interested parties that the link has come up.

Definition at line 831 of file csma-net-device.cc.

References m_linkChangeCallbacks, m_linkUp, and NS_LOG_FUNCTION_NOARGS.

Referenced by Attach().

Here is the caller graph for this function:

◆ operator=()

CsmaNetDevice& ns3::CsmaNetDevice::operator= ( const CsmaNetDevice & o )

private

Operator = is declared but not implemented.

This disables the assignment operator for CsmaNetDevice objects.

Parameters

o	object to copy

Returns: the copied object

◆ Receive()

void ns3::CsmaNetDevice::Receive	(	Ptr< Packet >	p,
		Ptr< CsmaNetDevice >	sender
	)

Receive a packet from a connected CsmaChannel.

The CsmaNetDevice 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: CsmaChannel

Parameters

p	a reference to the received packet
sender	the CsmaNetDevice that transmitted the packet in the first place

Definition at line 687 of file csma-net-device.cc.

References ns3::EthernetTrailer::CheckFcs(), ns3::Node::ChecksumEnabled(), ns3::Packet::Copy(), ns3::EthernetTrailer::EnableFcs(), ns3::EthernetHeader::GetDestination(), ns3::EthernetHeader::GetLengthType(), ns3::Packet::GetSize(), ns3::EthernetHeader::GetSource(), ns3::LlcSnapHeader::GetType(), ns3::Packet::GetUid(), ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsGroup(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), IsReceiveEnabled(), m_address, m_macPromiscRxTrace, m_macRxTrace, m_phyRxDropTrace, m_phyRxEndTrace, m_promiscRxCallback, m_promiscSnifferTrace, m_receiveErrorModel, m_rxCallback, m_snifferTrace, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::NetDevice::PACKET_BROADCAST, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, ns3::NetDevice::PACKET_OTHERHOST, ns3::Packet::RemoveAtEnd(), ns3::Packet::RemoveHeader(), and ns3::Packet::RemoveTrailer().

Referenced by ns3::CsmaChannel::TransmitEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Send()

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

virtual

Start sending a packet down the channel.

Parameters

packet	packet to send
dest	layer 2 destination address
protocolNumber	protocol number

Returns: true if successful, false otherwise (drop, ...)

Implements ns3::NetDevice.

Definition at line 940 of file csma-net-device.cc.

References m_address, NS_LOG_FUNCTION, and SendFrom().

Here is the call graph for this function:

◆ SendFrom()

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

virtual

Start sending a packet down the channel, with MAC spoofing.

Parameters

packet	packet to send
source	layer 2 source address
dest	layer 2 destination address
protocolNumber	protocol number

Returns: true if successful, false otherwise (drop, ...)

Implements ns3::NetDevice.

Definition at line 947 of file csma-net-device.cc.

References AddHeader(), ns3::Mac48Address::ConvertFrom(), ns3::Packet::GetUid(), IsLinkUp(), IsSendEnabled(), m_currentPkt, m_macTxDropTrace, m_macTxTrace, m_promiscSnifferTrace, m_queue, m_snifferTrace, m_txMachineState, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, READY, and TransmitStart().

Referenced by Send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAddress()

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

virtual

Set the address of this interface.

Parameters

address address to set

Implements ns3::NetDevice.

Definition at line 860 of file csma-net-device.cc.

References first::address, ns3::Mac48Address::ConvertFrom(), m_address, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

◆ SetBackoffParams()

void ns3::CsmaNetDevice::SetBackoffParams	(	Time	slotTime,
		uint32_t	minSlots,
		uint32_t	maxSlots,
		uint32_t	maxRetries,
		uint32_t	ceiling
	)

Set the backoff parameters used to determine the wait to retry transmitting a packet when the channel is busy.

See also: Attach ()

Parameters

slotTime	Length of a packet slot (or average packet time)
minSlots	Minimum number of slots to wait
maxSlots	Maximum number of slots to wait
maxRetries	Maximum number of retries before packet is discard
ceiling	Cap on the exponential function when calculating max slots

Definition at line 298 of file csma-net-device.cc.

References m_backoff, ns3::Backoff::m_ceiling, ns3::Backoff::m_maxRetries, ns3::Backoff::m_maxSlots, ns3::Backoff::m_minSlots, ns3::Backoff::m_slotTime, and NS_LOG_FUNCTION.

◆ SetEncapsulationMode()

void ns3::CsmaNetDevice::SetEncapsulationMode ( CsmaNetDevice::EncapsulationMode mode )

Set the encapsulation mode of this device.

Parameters

mode	The encapsulation mode of this device.

Definition at line 225 of file csma-net-device.cc.

References m_encapMode, m_mtu, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetIfIndex()

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

virtual

Parameters

index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 839 of file csma-net-device.cc.

References m_ifIndex, and NS_LOG_FUNCTION.

◆ SetInterframeGap()

void ns3::CsmaNetDevice::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. As in Ethernet, it defaults to 96 bit times.

Parameters

t	the interframe gap time

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

References m_tInterframeGap, and NS_LOG_FUNCTION.

◆ SetMtu()

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

Definition at line 243 of file csma-net-device.cc.

References m_encapMode, m_mtu, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetNode()

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

virtual

Set the node to which this device is being attached.

Parameters

node	Ptr to the Node to which the device is being attached.

Implements ns3::NetDevice.

Definition at line 1008 of file csma-net-device.cc.

References m_node, and NS_LOG_FUNCTION.

◆ SetPromiscReceiveCallback()

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

virtual

Parameters

cb	callback to invoke whenever a packet has been received in promiscuous mode and must be forwarded to the higher layers.

Enables netdevice promiscuous mode and sets the callback that will handle promiscuous mode packets. Note, promiscuous mode packets means all packets, including those packets that can be sensed by the netdevice but which are intended to be received by other hosts.

Implements ns3::NetDevice.

Definition at line 1038 of file csma-net-device.cc.

References m_promiscRxCallback, and NS_LOG_FUNCTION.

◆ SetQueue()

void ns3::CsmaNetDevice::SetQueue ( Ptr< Queue< Packet > > queue )

Attach a queue to the CsmaNetDevice.

The CsmaNetDevice "owns" a queue. This queue may be set by higher level topology objects to implement a particular queueing method such as DropTail.

See also: Queue; DropTailQueue

Parameters

queue a Ptr to the queue for being assigned to the device.

Definition at line 673 of file csma-net-device.cc.

References m_queue, and NS_LOG_FUNCTION.

◆ SetReceiveCallback()

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

virtual

Set the callback to be used to notify higher layers when a packet has been received.

Parameters

cb	The callback.

Implements ns3::NetDevice.

Definition at line 1023 of file csma-net-device.cc.

References m_rxCallback, and NS_LOG_FUNCTION.

◆ SetReceiveEnable()

void ns3::CsmaNetDevice::SetReceiveEnable ( bool enable )

Enable or disable the receive side of the network device.

Parameters

enable Enable the receive side if true, otherwise disable.

Definition at line 270 of file csma-net-device.cc.

References m_receiveEnable, and NS_LOG_FUNCTION.

◆ SetReceiveErrorModel()

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

Attach a receive ErrorModel to the CsmaNetDevice.

The CsmaNetDevice may optionally include an ErrorModel in the packet receive chain to simulate data errors in during transmission.

See also: ErrorModel

Parameters

em	a pointer to the ErrorModel

Definition at line 680 of file csma-net-device.cc.

References m_receiveErrorModel, and NS_LOG_FUNCTION.

◆ SetSendEnable()

void ns3::CsmaNetDevice::SetSendEnable ( bool enable )

Enable or disable the send side of the network device.

Parameters

enable Enable the send side if true, otherwise disable.

Definition at line 263 of file csma-net-device.cc.

References m_sendEnable, and NS_LOG_FUNCTION.

◆ SupportsSendFrom()

bool ns3::CsmaNetDevice::SupportsSendFrom ( void ) const

virtual

Returns: true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

Definition at line 1045 of file csma-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ TransmitAbort()

void ns3::CsmaNetDevice::TransmitAbort ( void )

private

Aborts the transmission of the current packet.

If the net device has tried to transmit a packet for more times than the maximum allowed number of retries (channel always busy) then the packet is dropped.

Definition at line 533 of file csma-net-device.cc.

References BACKOFF, ns3::Packet::GetUid(), m_backoff, m_currentPkt, m_phyTxDropTrace, m_promiscSnifferTrace, m_queue, m_snifferTrace, m_txMachineState, NS_ASSERT_MSG, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, READY, ns3::Backoff::ResetBackoffTime(), and TransmitStart().

Referenced by TransmitStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransmitCompleteEvent()

void ns3::CsmaNetDevice::TransmitCompleteEvent ( void )

private

Stop Sending a Packet Down the Wire and Begin the Interframe Gap.

The TransmitCompleteEvent method is used internally to finish the process of sending a packet out on the channel. During execution of this method the TransmitEnd method is called on the channel to let it know that the physical device this class represents has finished sending simulated signals. The channel uses this event to begin its speed of light delay timer after which it notifies the Net Device(s) at the other end of the link that new bits have arrived (it delivers the Packet). During this method, the net device also schedules the TransmitReadyEvent at which time the transmitter becomes ready to send the next packet.

See also: CsmaChannel::TransmitEnd (); TransmitReadyEvent ()

Definition at line 578 of file csma-net-device.cc.

References ns3::Time::As(), BUSY, GAP, ns3::Packet::GetUid(), m_channel, m_currentPkt, m_phyTxEndTrace, m_tInterframeGap, m_txMachineState, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, ns3::Time::S, ns3::Simulator::Schedule(), TransmitReadyEvent(), and ns3::TRANSMITTING.

Referenced by TransmitStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransmitReadyEvent()

void ns3::CsmaNetDevice::TransmitReadyEvent ( void )

private

Cause the Transmitter to Become Ready to Send Another Packet.

The TransmitReadyEvent method is used internally to re-enable the transmit machine of the net device. It is scheduled after a suitable interframe gap after the completion of the previous transmission. The queue is checked at this time, and if there is a packet waiting on the queue, the transmission process is begun.

If a packet is in the queue, it is extracted for the queue as the next packet to be transmitted by the net device.

See also: TransmitStart ()

Definition at line 610 of file csma-net-device.cc.

References GAP, m_currentPkt, m_promiscSnifferTrace, m_queue, m_snifferTrace, m_txMachineState, NS_ASSERT_MSG, NS_LOG_FUNCTION_NOARGS, READY, and TransmitStart().

Referenced by TransmitCompleteEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransmitStart()

void ns3::CsmaNetDevice::TransmitStart ( void )

private

Start Sending a Packet Down the Wire.

The TransmitStart method is the method that is used internally in the CsmaNetDevice to begin the process of sending a packet out on the channel. A corresponding method is called on the channel to let it know that the physical device this class represents has actually started sending signals, this causes the channel to enter the BUSY state. An event is scheduled for the time at which the bits have been completely transmitted.

If the channel is found to be BUSY, this method reschedules itself for execution at a later time (within the backoff period).

See also: CsmaChannel::TransmitStart (); TransmitCompleteEvent ()

Definition at line 440 of file csma-net-device.cc.

References ns3::Time::As(), BACKOFF, BUSY, ns3::DataRate::CalculateBytesTxTime(), ns3::Backoff::GetBackoffTime(), ns3::Packet::GetSize(), ns3::Packet::GetUid(), ns3::IDLE, ns3::Backoff::IncrNumRetries(), IsSendEnabled(), m_backoff, m_bps, m_channel, m_currentPkt, m_deviceId, m_macTxBackoffTrace, m_phyTxBeginTrace, m_phyTxDropTrace, m_txMachineState, ns3::Backoff::MaxRetriesReached(), NS_ASSERT_MSG, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, NS_LOG_WARN, READY, ns3::Backoff::ResetBackoffTime(), ns3::Time::S, ns3::Simulator::Schedule(), TransmitAbort(), and TransmitCompleteEvent().

Referenced by SendFrom(), TransmitAbort(), and TransmitReadyEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ DEFAULT_MTU

const uint16_t ns3::CsmaNetDevice::DEFAULT_MTU = 1500

staticprivate

Default Maximum Transmission Unit (MTU) for the CsmaNetDevice.

Definition at line 721 of file csma-net-device.h.

Referenced by GetTypeId().

◆ m_address

Mac48Address ns3::CsmaNetDevice::m_address

private

The MAC address which has been assigned to this device.

Definition at line 689 of file csma-net-device.h.

Referenced by GetAddress(), GetTypeId(), Receive(), Send(), and SetAddress().

◆ m_backoff

Backoff ns3::CsmaNetDevice::m_backoff

private

Holds the backoff parameters and is used to calculate the next backoff time to use when the channel is busy and the net device is ready to transmit.

Definition at line 510 of file csma-net-device.h.

Referenced by AssignStreams(), SetBackoffParams(), TransmitAbort(), and TransmitStart().

◆ m_bps

DataRate ns3::CsmaNetDevice::m_bps

private

The data rate that the Net Device uses to simulate packet transmission timing.

See also: class DataRate

Definition at line 496 of file csma-net-device.h.

Referenced by Attach(), and TransmitStart().

◆ m_channel

Ptr<CsmaChannel> ns3::CsmaNetDevice::m_channel

private

The CsmaChannel to which this CsmaNetDevice has been attached.

See also: class CsmaChannel

Definition at line 524 of file csma-net-device.h.

Referenced by CsmaNetDevice(), Attach(), DoDispose(), GetChannel(), TransmitCompleteEvent(), and TransmitStart().

◆ m_currentPkt

Ptr<Packet> ns3::CsmaNetDevice::m_currentPkt

private

Next packet that will be transmitted (if transmitter is not currently transmitting) or packet that is currently being transmitted.

Definition at line 517 of file csma-net-device.h.

Referenced by SendFrom(), TransmitAbort(), TransmitCompleteEvent(), TransmitReadyEvent(), and TransmitStart().

◆ m_deviceId

uint32_t ns3::CsmaNetDevice::m_deviceId

private

Device ID returned by the attached functions.

It is used by the mp-channel to identify each net device to make sure that only active net devices are writing to the channel

Definition at line 455 of file csma-net-device.h.

Referenced by Attach(), and TransmitStart().

◆ m_encapMode

EncapsulationMode ns3::CsmaNetDevice::m_encapMode

private

The type of packet that should be created by the AddHeader function and that should be processed by the ProcessHeader function.

Definition at line 489 of file csma-net-device.h.

Referenced by CsmaNetDevice(), AddHeader(), GetEncapsulationMode(), SetEncapsulationMode(), and SetMtu().

◆ m_ifIndex

uint32_t ns3::CsmaNetDevice::m_ifIndex

private

The interface index (really net evice index) that has been assigned to this network device.

Definition at line 705 of file csma-net-device.h.

Referenced by GetIfIndex(), and SetIfIndex().

◆ m_linkChangeCallbacks

TracedCallback ns3::CsmaNetDevice::m_linkChangeCallbacks

private

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

Definition at line 716 of file csma-net-device.h.

Referenced by AddLinkChangeCallback(), and NotifyLinkUp().

◆ m_linkUp

bool ns3::CsmaNetDevice::m_linkUp

private

Flag indicating whether or not the link is up.

In this case, whether or not the device is connected to a channel.

Definition at line 711 of file csma-net-device.h.

Referenced by IsLinkUp(), and NotifyLinkUp().

◆ m_macPromiscRxTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_macPromiscRxTrace

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.

See also: class CallBackTraceSource

Definition at line 565 of file csma-net-device.h.

Referenced by GetTypeId(), and Receive().

◆ m_macRxDropTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_macRxDropTrace

private

The trace source fired for packets successfully received by the device but dropped before being forwarded up to higher layers (at the L2/L3 transition).

See also: class CallBackTraceSource

Definition at line 583 of file csma-net-device.h.

Referenced by GetTypeId().

◆ m_macRxTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_macRxTrace

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.

See also: class CallBackTraceSource

Definition at line 574 of file csma-net-device.h.

Referenced by GetTypeId(), and Receive().

◆ m_macTxBackoffTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_macTxBackoffTrace

private

The trace source fired when the mac layer is forced to begin the backoff process for a packet.

This can happen a number of times as the backoff sequence is repeated with increasing delays.

See also: class CallBackTraceSource

Definition at line 592 of file csma-net-device.h.

Referenced by GetTypeId(), and TransmitStart().

◆ m_macTxDropTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_macTxDropTrace

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.

See also: class CallBackTraceSource

Definition at line 556 of file csma-net-device.h.

Referenced by GetTypeId(), and SendFrom().

◆ m_macTxTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_macTxTrace

private

The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission.

See also: class CallBackTraceSource

Definition at line 548 of file csma-net-device.h.

Referenced by GetTypeId(), and SendFrom().

◆ m_mtu

uint32_t ns3::CsmaNetDevice::m_mtu

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 729 of file csma-net-device.h.

Referenced by AddHeader(), GetMtu(), SetEncapsulationMode(), and SetMtu().

◆ m_node

Ptr<Node> ns3::CsmaNetDevice::m_node

private

The Node to which this device is attached.

Definition at line 684 of file csma-net-device.h.

Referenced by DoDispose(), GetNode(), and SetNode().

◆ m_phyRxBeginTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_phyRxBeginTrace

private

The trace source fired when a packet begins the reception process from the medium.

See also: class CallBackTraceSource

Definition at line 624 of file csma-net-device.h.

Referenced by GetTypeId().

◆ m_phyRxDropTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_phyRxDropTrace

private

The trace source fired when the phy layer drops a packet it has received.

See also: class CallBackTraceSource

Definition at line 639 of file csma-net-device.h.

Referenced by GetTypeId(), and Receive().

◆ m_phyRxEndTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_phyRxEndTrace

private

The trace source fired when a packet ends the reception process from the medium.

See also: class CallBackTraceSource

Definition at line 632 of file csma-net-device.h.

Referenced by GetTypeId(), and Receive().

◆ m_phyTxBeginTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_phyTxBeginTrace

private

The trace source fired when a packet begins the transmission process on the medium.

See also: class CallBackTraceSource

Definition at line 600 of file csma-net-device.h.

Referenced by GetTypeId(), and TransmitStart().

◆ m_phyTxDropTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_phyTxDropTrace

private

The trace source fired when the phy layer drops a packet as it tries to transmit it.

See also: class CallBackTraceSource

Definition at line 616 of file csma-net-device.h.

Referenced by GetTypeId(), TransmitAbort(), and TransmitStart().

◆ m_phyTxEndTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_phyTxEndTrace

private

The trace source fired when a packet ends the transmission process on the medium.

See also: class CallBackTraceSource

Definition at line 608 of file csma-net-device.h.

Referenced by GetTypeId(), and TransmitCompleteEvent().

◆ m_promiscRxCallback

NetDevice::PromiscReceiveCallback ns3::CsmaNetDevice::m_promiscRxCallback

private

The callback used to notify higher layers that a packet has been received in promiscuous mode.

Definition at line 699 of file csma-net-device.h.

Referenced by Receive(), and SetPromiscReceiveCallback().

◆ m_promiscSnifferTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_promiscSnifferTrace

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.

See also: class CallBackTraceSource

Definition at line 679 of file csma-net-device.h.

Referenced by GetTypeId(), Receive(), SendFrom(), TransmitAbort(), and TransmitReadyEvent().

◆ m_queue

Ptr<Queue<Packet> > ns3::CsmaNetDevice::m_queue

private

The Queue which this CsmaNetDevice uses as a packet source.

Management of this Queue has been delegated to the CsmaNetDevice and it has the responsibility for deletion.

See also: class Queue; class DropTailQueue

Definition at line 533 of file csma-net-device.h.

Referenced by ~CsmaNetDevice(), DoDispose(), GetQueue(), GetTypeId(), SendFrom(), SetQueue(), TransmitAbort(), and TransmitReadyEvent().

◆ m_receiveEnable

bool ns3::CsmaNetDevice::m_receiveEnable

private

Enable net device to receive packets.

True by default

Definition at line 465 of file csma-net-device.h.

Referenced by GetTypeId(), IsReceiveEnabled(), and SetReceiveEnable().

◆ m_receiveErrorModel

Ptr<ErrorModel> ns3::CsmaNetDevice::m_receiveErrorModel

private

Error model for receive packet events.

When active this model will be used to model transmission errors by marking some of the packets received as corrupt.

Definition at line 540 of file csma-net-device.h.

Referenced by GetTypeId(), Receive(), and SetReceiveErrorModel().

◆ m_rxCallback

NetDevice::ReceiveCallback ns3::CsmaNetDevice::m_rxCallback

private

The callback used to notify higher layers that a packet has been received.

Definition at line 694 of file csma-net-device.h.

Referenced by Receive(), and SetReceiveCallback().

◆ m_sendEnable

bool ns3::CsmaNetDevice::m_sendEnable

private

Enable net device to send packets.

True by default

Definition at line 460 of file csma-net-device.h.

Referenced by GetTypeId(), IsSendEnabled(), and SetSendEnable().

◆ m_snifferTrace

TracedCallback<Ptr<const Packet> > ns3::CsmaNetDevice::m_snifferTrace

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.

See also: class CallBackTraceSource

Definition at line 659 of file csma-net-device.h.

Referenced by GetTypeId(), Receive(), SendFrom(), TransmitAbort(), and TransmitReadyEvent().

◆ m_tInterframeGap

Time ns3::CsmaNetDevice::m_tInterframeGap

private

The interframe gap that the Net Device uses insert time between packet transmission.

See also: class Time

Definition at line 503 of file csma-net-device.h.

Referenced by CsmaNetDevice(), Attach(), SetInterframeGap(), and TransmitCompleteEvent().

◆ m_txMachineState

TxMachineState ns3::CsmaNetDevice::m_txMachineState

private

The state of the Net Device transmit state machine.

See also: TxMachineState

Definition at line 482 of file csma-net-device.h.

Referenced by CsmaNetDevice(), SendFrom(), TransmitAbort(), TransmitCompleteEvent(), TransmitReadyEvent(), and TransmitStart().

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

src/csma/model/csma-net-device.h
src/csma/model/csma-net-device.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

TraceSources

Member Enumeration Documentation

◆ EncapsulationMode

◆ TxMachineState

Constructor & Destructor Documentation

◆ CsmaNetDevice() [1/2]

◆ ~CsmaNetDevice()

◆ CsmaNetDevice() [2/2]

Member Function Documentation

◆ AddHeader()

◆ AddLinkChangeCallback()

◆ AssignStreams()

◆ Attach()

◆ DoDispose()

◆ GetAddress()

◆ GetBroadcast()

◆ GetChannel()

◆ GetEncapsulationMode()

◆ GetIfIndex()

◆ GetMtu()

◆ GetMulticast() [1/2]

◆ GetMulticast() [2/2]

◆ GetNode()

◆ GetQueue()

◆ GetTypeId()

◆ Init()

◆ IsBridge()

◆ IsBroadcast()

◆ IsLinkUp()

◆ IsMulticast()

◆ IsPointToPoint()

◆ IsReceiveEnabled()

◆ IsSendEnabled()

◆ NeedsArp()

◆ NotifyLinkUp()

◆ operator=()

◆ Receive()

◆ Send()

◆ SendFrom()

◆ SetAddress()

◆ SetBackoffParams()

◆ SetEncapsulationMode()

◆ SetIfIndex()

◆ SetInterframeGap()

◆ SetMtu()

◆ SetNode()

◆ SetPromiscReceiveCallback()

◆ SetQueue()

◆ SetReceiveCallback()

◆ SetReceiveEnable()

◆ SetReceiveErrorModel()

◆ SetSendEnable()

◆ SupportsSendFrom()

◆ TransmitAbort()

◆ TransmitCompleteEvent()

◆ TransmitReadyEvent()

◆ TransmitStart()

Member Data Documentation

◆ DEFAULT_MTU

◆ m_address

◆ m_backoff

◆ m_bps

◆ m_channel

◆ m_currentPkt

◆ m_deviceId

◆ m_encapMode

◆ m_ifIndex

◆ m_linkChangeCallbacks