#include "csma-channel.h"
Public Member Functions | |
CsmaChannel () | |
Create a CsmaChannel. | |
CsmaChannel (const CsmaChannel &)=delete | |
~CsmaChannel () override | |
Destroy a CsmaChannel. | |
int32_t | Attach (Ptr< CsmaNetDevice > device) |
Attach a given netdevice to this channel. | |
bool | Detach (Ptr< CsmaNetDevice > device) |
Detach a given netdevice from this channel. | |
bool | Detach (uint32_t deviceId) |
Detach a given netdevice from this channel. | |
Ptr< CsmaNetDevice > | GetCsmaDevice (std::size_t i) const |
DataRate | GetDataRate () |
Get the assigned data rate of the channel. | |
Time | GetDelay () |
Get the assigned speed-of-light delay of the channel. | |
Ptr< NetDevice > | GetDevice (std::size_t i) const override |
int32_t | GetDeviceNum (Ptr< CsmaNetDevice > device) |
std::size_t | GetNDevices () const override |
uint32_t | GetNumActDevices () |
WireState | GetState () |
bool | IsActive (uint32_t deviceId) |
Indicates if a net device is currently attached or detached from the channel. | |
bool | IsBusy () |
Indicates if the channel is busy. | |
CsmaChannel & | operator= (const CsmaChannel &)=delete |
void | PropagationCompleteEvent () |
Indicates that the channel has finished propagating the current packet. | |
bool | Reattach (Ptr< CsmaNetDevice > device) |
Reattach a previously detached net device to the channel. | |
bool | Reattach (uint32_t deviceId) |
Reattach a previously detached net device to the channel. | |
bool | TransmitEnd () |
Indicates that the net device has finished transmitting the packet over the channel. | |
bool | TransmitStart (Ptr< const Packet > p, uint32_t srcId) |
Start transmitting a packet over the channel. | |
Public Member Functions inherited from ns3::Channel | |
Channel () | |
~Channel () override | |
virtual Ptr< NetDevice > | GetDevice (std::size_t i) const =0 |
uint32_t | GetId () const |
virtual std::size_t | GetNDevices () const =0 |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Channel | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
DataRate | m_bps |
The assigned data rate of the channel. | |
Ptr< Packet > | m_currentPkt |
The Packet that is currently being transmitted on the channel (or last packet to have been transmitted on the channel if the channel is free.) | |
uint32_t | m_currentSrc |
Device Id of the source that is currently transmitting on the channel. | |
Time | m_delay |
The assigned speed-of-light delay of the channel. | |
std::vector< CsmaDeviceRec > | m_deviceList |
List of the net devices that have been or are currently connected to the channel. | |
WireState | m_state |
Current state of the channel. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Csma Channel.
This class represents a simple Csma channel that can be used when many nodes are connected to one wire. It uses a single busy flag to indicate if the channel is currently in use. It does not take into account the distances between stations or the speed of light to determine collisions.
ns3::CsmaChannel is accessible through the following paths with Config::Set and Config::Connect:
DataRate
Time
+9.22337e+18ns:+9.22337e+18ns No TraceSources are defined for this type.
Size of this type is 88 bytes (on a 64-bit architecture).
Definition at line 91 of file csma-channel.h.
ns3::CsmaChannel::CsmaChannel | ( | ) |
Create a CsmaChannel.
Definition at line 57 of file csma-channel.cc.
References ns3::IDLE, m_deviceList, m_state, and NS_LOG_FUNCTION_NOARGS.
|
override |
Destroy a CsmaChannel.
Definition at line 65 of file csma-channel.cc.
References m_deviceList, and NS_LOG_FUNCTION.
|
delete |
int32_t ns3::CsmaChannel::Attach | ( | Ptr< CsmaNetDevice > | device | ) |
Attach a given netdevice to this channel.
device | Device pointer to the netdevice to attach to the channel |
Definition at line 72 of file csma-channel.cc.
References m_deviceList, NS_ASSERT, and NS_LOG_FUNCTION.
bool ns3::CsmaChannel::Detach | ( | Ptr< CsmaNetDevice > | device | ) |
Detach a given netdevice from this channel.
The net device is marked as inactive and it is not allowed to receive or transmit packets
device | Device pointer to the netdevice to detach from the channel |
Definition at line 159 of file csma-channel.cc.
References m_deviceList, NS_ASSERT, and NS_LOG_FUNCTION.
bool ns3::CsmaChannel::Detach | ( | uint32_t | deviceId | ) |
Detach a given netdevice from this channel.
The net device is marked as inactive and it is not allowed to receive or transmit packets
deviceId | The deviceID assigned to the net device when it was connected to the channel |
Definition at line 130 of file csma-channel.cc.
References m_currentSrc, m_deviceList, m_state, NS_LOG_FUNCTION, NS_LOG_WARN, and ns3::TRANSMITTING.
Ptr< CsmaNetDevice > ns3::CsmaChannel::GetCsmaDevice | ( | std::size_t | i | ) | const |
i | The deviceId of the net device for which we want the pointer. |
Definition at line 282 of file csma-channel.cc.
References m_deviceList.
Referenced by GetDevice().
DataRate ns3::CsmaChannel::GetDataRate | ( | ) |
Get the assigned data rate of the channel.
Definition at line 317 of file csma-channel.cc.
References m_bps.
Time ns3::CsmaChannel::GetDelay | ( | ) |
Get the assigned speed-of-light delay of the channel.
Definition at line 323 of file csma-channel.cc.
References m_delay.
i | The index of the net device. |
Implements ns3::Channel.
Definition at line 335 of file csma-channel.cc.
References GetCsmaDevice().
int32_t ns3::CsmaChannel::GetDeviceNum | ( | Ptr< CsmaNetDevice > | device | ) |
device | Device pointer to the netdevice for which the device number is needed |
Definition at line 288 of file csma-channel.cc.
References m_deviceList.
|
overridevirtual |
Implements ns3::Channel.
Definition at line 276 of file csma-channel.cc.
References m_deviceList.
uint32_t ns3::CsmaChannel::GetNumActDevices | ( | ) |
Definition at line 261 of file csma-channel.cc.
References m_deviceList.
WireState ns3::CsmaChannel::GetState | ( | ) |
Definition at line 329 of file csma-channel.cc.
References m_state.
|
static |
Get the type ID.
Definition at line 36 of file csma-channel.cc.
References m_bps, m_delay, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().
bool ns3::CsmaChannel::IsActive | ( | uint32_t | deviceId | ) |
Indicates if a net device is currently attached or detached from the channel.
deviceId | The ID that was assigned to the net device when it was attached to the channel. |
Definition at line 203 of file csma-channel.cc.
References m_deviceList.
Referenced by TransmitEnd(), and TransmitStart().
bool ns3::CsmaChannel::IsBusy | ( | ) |
Indicates if the channel is busy.
The channel will only accept new packets for transmission if it is not busy.
Definition at line 311 of file csma-channel.cc.
|
delete |
void ns3::CsmaChannel::PropagationCompleteEvent | ( | ) |
Indicates that the channel has finished propagating the current packet.
The channel is released and becomes free.
Calls the receive function of every active net device that is attached to the channel.
Definition at line 251 of file csma-channel.cc.
References ns3::Packet::GetUid(), ns3::IDLE, m_currentPkt, m_state, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::PROPAGATING.
Referenced by TransmitEnd().
bool ns3::CsmaChannel::Reattach | ( | Ptr< CsmaNetDevice > | device | ) |
Reattach a previously detached net device to the channel.
The net device is marked as active. It is now allowed to receive or transmit packets. The net device must have been previously attached to the channel using the attach function.
device | Device pointer to the netdevice to detach from the channel |
Definition at line 84 of file csma-channel.cc.
References m_deviceList, NS_ASSERT, and NS_LOG_FUNCTION.
bool ns3::CsmaChannel::Reattach | ( | uint32_t | deviceId | ) |
Reattach a previously detached net device to the channel.
The net device is marked as active. It is now allowed to receive or transmit packets. The net device must have been previously attached to the channel using the attach function.
deviceId | The device ID assigned to the net device when it was connected to the channel |
Definition at line 109 of file csma-channel.cc.
References m_deviceList, and NS_LOG_FUNCTION.
bool ns3::CsmaChannel::TransmitEnd | ( | ) |
Indicates that the net device has finished transmitting the packet over the channel.
The channel will stay busy until the packet has completely propagated to all net devices attached to the channel. The TransmitEnd function schedules the PropagationCompleteEvent which will free the channel for further transmissions. Stores the packet p as the m_currentPkt, the packet being currently transmitting.
Definition at line 209 of file csma-channel.cc.
References ns3::Time::As(), ns3::Packet::Copy(), ns3::Packet::GetUid(), IsActive(), m_currentPkt, m_currentSrc, m_delay, m_deviceList, m_state, NS_ASSERT, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::PROPAGATING, PropagationCompleteEvent(), ns3::CsmaNetDevice::Receive(), ns3::Time::S, ns3::Simulator::Schedule(), ns3::Simulator::ScheduleWithContext(), and ns3::TRANSMITTING.
Start transmitting a packet over the channel.
If the srcId belongs to a net device that is connected to the channel, packet transmission begins, and the channel becomes busy until the packet has completely reached all destinations.
p | A reference to the packet that will be transmitted over the channel |
srcId | The device Id of the net device that wants to transmit on the channel. |
Definition at line 177 of file csma-channel.cc.
References ns3::IDLE, IsActive(), m_currentPkt, m_currentSrc, m_state, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, NS_LOG_WARN, and ns3::TRANSMITTING.
|
private |
The assigned data rate of the channel.
Definition at line 303 of file csma-channel.h.
Referenced by GetDataRate(), and GetTypeId().
The Packet that is currently being transmitted on the channel (or last packet to have been transmitted on the channel if the channel is free.)
Definition at line 328 of file csma-channel.h.
Referenced by PropagationCompleteEvent(), TransmitEnd(), and TransmitStart().
|
private |
Device Id of the source that is currently transmitting on the channel.
Or last source to have transmitted a packet on the channel, if the channel is currently not busy.
Definition at line 335 of file csma-channel.h.
Referenced by Detach(), TransmitEnd(), and TransmitStart().
|
private |
The assigned speed-of-light delay of the channel.
Definition at line 308 of file csma-channel.h.
Referenced by GetDelay(), GetTypeId(), and TransmitEnd().
|
private |
List of the net devices that have been or are currently connected to the channel.
Devices are nor removed from this list, they are marked as inactive. Otherwise the assigned device IDs will not refer to the correct NetDevice. The DeviceIds are used so that it is possible to have a number to refer to an entry in the list so that the whole list does not have to be searched when making sure that a source is attached to a channel when it is transmitting data.
Definition at line 321 of file csma-channel.h.
Referenced by CsmaChannel(), ~CsmaChannel(), Attach(), Detach(), GetCsmaDevice(), GetDeviceNum(), GetNDevices(), GetNumActDevices(), IsActive(), Reattach(), and TransmitEnd().
|
private |
Current state of the channel.
Definition at line 340 of file csma-channel.h.
Referenced by CsmaChannel(), Detach(), GetState(), IsBusy(), PropagationCompleteEvent(), TransmitEnd(), and TransmitStart().