Gateway side of RC-MAC. More...

#include "uan-mac-rc-gw.h"

Inheritance diagram for ns3::UanMacRcGw:

Classes
struct	AckData
	Packet ACK data. More...

struct	Request
	Reservation request. More...

Public Types
typedef void(*	CycleCallback) (Time now, Time delay, uint32_t numRts, uint32_t totalBytes, double secs, uint32_t ctlRate, double actualX)
	TracedCallback signature for. More...

Public Types inherited from ns3::UanMac
typedef void(*	PacketModeTracedCallback) (Ptr< const Packet > packet, UanTxMode mode)
	TracedCallback signature for packet reception/enqueue/dequeue events. More...

Public Member Functions
	UanMacRcGw ()
	Constructor. More...

virtual	~UanMacRcGw ()
	Dummy destructor, see DoDispose. More...

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

virtual void	AttachPhy (Ptr< UanPhy > phy)
	Attach PHY layer to this MAC. More...

virtual void	Clear (void)
	Clears all pointer references. More...

virtual bool	Enqueue (Ptr< Packet > pkt, uint16_t protocolNumber, const Address &dest)
	Enqueue packet to be transmitted. More...

virtual void	SetForwardUpCb (Callback< void, Ptr< Packet >, uint16_t, const Mac8Address &> cb)
	Set the callback to forward packets up to higher layers. More...

Public Member Functions inherited from ns3::UanMac
	UanMac ()
	Default constructor. More...

virtual Address	GetAddress (void)
	Get the MAC Address. More...

virtual Address	GetBroadcast (void) const
	Get the broadcast address. More...

uint32_t	GetTxModeIndex ()

virtual void	SetAddress (Mac8Address addr)
	Set the address. More...

void	SetTxModeIndex (uint32_t txModeIndex)

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<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. 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)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (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)
	Register this type. More...

Static Public Member Functions inherited from ns3::UanMac
static TypeId	GetTypeId (void)
	Register this type. 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
virtual void	DoDispose ()
	Destructor implementation. 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	State { IDLE, INCYCLE, CTSING }
	Gateway state. More...

Private Member Functions
uint32_t	CompExpMinIndex (uint32_t n, uint32_t k)
	Index to the k'th expected delay among n nodes. More...

double	ComputeAlpha (uint32_t totalFrames, uint32_t totalBytes, uint32_t n, uint32_t a, double deltaK)
	Compute alpha parameter. More...

double	ComputeExpBOverA (uint32_t n, uint32_t a, uint32_t ldlh, std::vector< double > deltaK)
	Numeric function. More...

double	ComputeExpS (uint32_t a, uint32_t ld, std::vector< double > exppdk)
	Throughput for a reservations with framesize ld, given expected delays exppdk. More...

double	ComputeExpS (uint32_t a, uint32_t ld)
	Throughput for a reservations with framesize ld. More...

double	ComputePiK (uint32_t a, uint32_t n, uint32_t k)
	Numeric function. More...

void	CycleStarted (void)
	Set state to INCYCLE. More...

void	EndCycle (void)
	End cycle by scheduling pending ACKs. More...

uint32_t	FindOptA (void)
	Compute the optimum maximum number of reservations to accept per cycle. More...

std::vector< double >	GetExpPdk (void)
	Get the expected propagation delay to each node. More...

uint64_t	NchooseK (uint32_t n, uint32_t k)
	Binomial coefficient. More...

void	ReceiveError (Ptr< Packet > pkt, double sinr)
	PHY receive error callback. More...

void	ReceivePacket (Ptr< Packet > pkt, double sinr, UanTxMode mode)
	PHY receive ok callback. More...

void	SendPacket (Ptr< Packet > pkt, uint32_t rate)
	Send packet on PHY. More...

void	StartCycle (void)
	Cycle through pending requests. More...

Private Attributes
std::map< Mac8Address, AckData >	m_ackData
	AckData for each node. More...

uint32_t	m_ackSize
	Size of UanHeaderCommon and UanHeaderRcAck. More...

Mac8Address	m_address
	The MAC address. More...

bool	m_cleared
	Flag when we've been cleared. More...

uint32_t	m_ctsSizeG
	Size of UanHeaderCommon and UanHeaderRcCtsGlobal. More...

uint32_t	m_ctsSizeN
	Size of UanHeaderRcCts. More...

uint32_t	m_currentRateNum
	Rate number corresponding to data rate of current cycle. More...

uint16_t	m_currentRetryRate
	Retry rate number for current cycle. More...

TracedCallback< Time, Time, uint32_t, uint32_t, double, uint32_t, double >	m_cycleLogger
	A packet was destined for and received at this MAC layer. More...

Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & >	m_forwardUpCb
	Forwarding up callback. More...

uint32_t	m_frameSize
	Size of data frames in bytes. More...

Time	m_maxDelta
	Maximum propagation delay between gateway and non-gateway nodes . More...

uint32_t	m_maxRes
	Maximum number of reservations to accept per cycle. More...

double	m_minRetryRate
	Smallest allowed RTS retry rate. More...

uint32_t	m_numNodes
	Number of non-gateway nodes in this gateway's neighborhood. More...

uint32_t	m_numRates
	Number of rates per Phy layer. More...

Ptr< UanPhy >	m_phy
	PHY layer attached to this MAC. More...

std::map< Mac8Address, Time >	m_propDelay
	Propagation delay to each node. More...

uint32_t	m_rateStep
	Increments available for rate assignment in bps. More...

std::map< Mac8Address, Request >	m_requests
	Request for each node. More...

double	m_retryStep
	Retry rate increment. More...

uint32_t	m_rtsSize
	Size of UanHeaderCommon and UanHeaderRcRts. More...

TracedCallback< Ptr< const Packet >, UanTxMode >	m_rxLogger
	A packet was destined for and received at this MAC layer. More...

Time	m_sifs
	Spacing between frames to account for timing error and processing delay. More...

std::set< std::pair< Time, Mac8Address > >	m_sortedRes
	Queued request times. More...

State	m_state
	Gateway processing state. More...

uint32_t	m_totalRate
	Total available channel rate in bps (for a single channel, without splitting reservation channel). 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

Gateway side of RC-MAC.

This MAC protocol assumes a network topology where all traffic is destined for a set of GW nodes which are connected via some out of band (RF?) means. UanMacRcGw is the protocol which runs on the gateway nodes.

This particular implementation assumes that there is only a single gateway.

For more information on class operation email lentr.nosp@m.acy@.nosp@m.u.was.nosp@m.hing.nosp@m.ton.e.nosp@m.du (This work is, as of yet, unpublished)

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::UanMacRcGw"

Attributes

MaxReservations: Maximum number of reservations to accept per cycle.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
NumberOfRates: Number of rates per Phy layer.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1023
- Flags: construct write read
MaxPropDelay: Maximum propagation delay between gateway and non-gateway nodes.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +2000000000.0ns
- Flags: construct write read
SIFS: Spacing between frames to account for timing error and processing delay.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +200000000.0ns
- Flags: construct write read
NumberOfNodes: Number of non-gateway nodes in this gateway's neighborhood.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
MinRetryRate: Smallest allowed RTS retry rate.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.01
- Flags: construct write read
RetryStep: Retry rate increment.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.01
- Flags: construct write read
TotalRate: Total available channel rate in bps (for a single channel, without splitting reservation channel).
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4096
- Flags: construct write read
RateStep: Increments available for rate assignment in bps.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4
- Flags: construct write read
FrameSize: Size of data frames in bytes.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1000
- Flags: construct write read

TraceSources

RX: A packet was destined for and received at this MAC layer.
Callback signature: ns3::UanMac::PacketModeTracedCallback
Cycle: Trace cycle statistics.
Callback signature: ns3::UanMacRcGw::CycleCallback

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

Definition at line 57 of file uan-mac-rc-gw.h.

Member Typedef Documentation

◆ CycleCallback

typedef void(* ns3::UanMacRcGw::CycleCallback) (Time now, Time delay, uint32_t numRts, uint32_t totalBytes, double secs, uint32_t ctlRate, double actualX)

TracedCallback signature for.

Parameters

[in]	now,The	current simulation time.
[in]	delay	Minimum path delay of first RTS.
[in]	numRts	Number of pending RTS.
[in]	totalBytes	Length of RTS header.
[in]	secs	Effective window size for RcCtsGlobal message, or time to next cycle, both in seconds.
[in]	ctlRate	CTL rate in Bps.
[in]	actualX	Current retry rate.

Definition at line 89 of file uan-mac-rc-gw.h.

Member Enumeration Documentation

◆ State

enum ns3::UanMacRcGw::State

private

Gateway state.

Enumerator
IDLE	Initial idle state.
INCYCLE	Cycling through nodes.
CTSING	Sending CTS.

Definition at line 95 of file uan-mac-rc-gw.h.

Constructor & Destructor Documentation

◆ UanMacRcGw()

ns3::UanMacRcGw::UanMacRcGw ( )

Constructor.

Definition at line 48 of file uan-mac-rc-gw.cc.

References ns3::UanHeaderCommon::GetSerializedSize(), ns3::UanHeaderRcRts::GetSerializedSize(), ns3::UanHeaderRcCtsGlobal::GetSerializedSize(), ns3::UanHeaderRcCts::GetSerializedSize(), ns3::UanHeaderRcAck::GetSerializedSize(), m_ackSize, m_ctsSizeG, m_ctsSizeN, m_rtsSize, and NS_LOG_DEBUG.

◆ ~UanMacRcGw()

ns3::UanMacRcGw::~UanMacRcGw ( )

virtual

Dummy destructor, see DoDispose.

Definition at line 68 of file uan-mac-rc-gw.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::UanMacRcGw::AssignStreams ( int64_t stream )

virtual

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.

Implements ns3::UanMac.

Definition at line 713 of file uan-mac-rc-gw.cc.

References NS_LOG_FUNCTION.

◆ AttachPhy()

void ns3::UanMacRcGw::AttachPhy ( Ptr< UanPhy > phy )

virtual

Attach PHY layer to this MAC.

Some MACs may be designed to work with multiple PHY layers. Others may only work with one.

Parameters

phy	Phy layer to attach to this MAC.

Implements ns3::UanMac.

Definition at line 189 of file uan-mac-rc-gw.cc.

References m_phy, ns3::MakeCallback(), third::phy, ReceiveError(), and ReceivePacket().

◆ Clear()

void ns3::UanMacRcGw::Clear ( void )

virtual

Clears all pointer references.

Implements ns3::UanMac.

Definition at line 73 of file uan-mac-rc-gw.cc.

References m_ackData, m_cleared, m_phy, m_propDelay, m_requests, and m_sortedRes.

Referenced by DoDispose().

◆ CompExpMinIndex()

uint32_t ns3::UanMacRcGw::CompExpMinIndex	(	uint32_t	n,
		uint32_t	k
	)

private

Index to the k'th expected delay among n nodes.

Parameters

n	Number of nodes.
k	Target index.

Returns: The expected index.

Definition at line 627 of file uan-mac-rc-gw.cc.

References sample-rng-plot::n, and NchooseK().

Referenced by GetExpPdk().

◆ ComputeAlpha()

double ns3::UanMacRcGw::ComputeAlpha	(	uint32_t	totalFrames,
		uint32_t	totalBytes,
		uint32_t	n,
		uint32_t	a,
		double	deltaK
	)

private

Compute alpha parameter.

Parameters

totalFrames	Total number of frames in m_requests.
totalBytes	Total number of bytes in m_requests.
n	Number of nodes.
a	m_maxRes, or optimal A value.
deltaK	Propagation delay.

Returns: Alpha parameter.

Definition at line 533 of file uan-mac-rc-gw.cc.

References sample-rng-plot::alpha, ns3::Time::GetSeconds(), m_ctsSizeG, m_maxDelta, m_rtsSize, m_sifs, m_totalRate, sample-rng-plot::n, NS_ASSERT_MSG(), and NS_UNUSED.

Referenced by ComputeExpBOverA(), ComputeExpS(), and StartCycle().

◆ ComputeExpBOverA()

double ns3::UanMacRcGw::ComputeExpBOverA	(	uint32_t	n,
		uint32_t	a,
		uint32_t	ldlh,
		std::vector< double >	deltaK
	)

private

Numeric function.

Parameters

n	Number of nodes.
a	Number of reservations.
ldlh	Sum of common header length and frame size.
deltaK	Result of GetExpPdk

Returns: value.

Definition at line 647 of file uan-mac-rc-gw.cc.

References ComputeAlpha(), ComputePiK(), m_ackSize, m_ctsSizeG, m_ctsSizeN, m_totalRate, and sample-rng-plot::n.

Referenced by ComputeExpS().

◆ ComputeExpS() [1/2]

double ns3::UanMacRcGw::ComputeExpS	(	uint32_t	a,
		uint32_t	ld,
		std::vector< double >	exppdk
	)

private

Throughput for a reservations with framesize ld, given expected delays exppdk.

Parameters

a	Number of reservations.
ld	Frame size.
exppdk	Expected delays, given by GetExpPdk.

Returns: Expected throughput.

Definition at line 592 of file uan-mac-rc-gw.cc.

References ComputeAlpha(), ComputeExpBOverA(), ComputePiK(), ns3::Time::GetSeconds(), ns3::UanHeaderCommon::GetSerializedSize(), m_ctsSizeG, m_maxDelta, m_numNodes, m_rtsSize, m_sifs, m_totalRate, sample-rng-plot::n, and NS_LOG_DEBUG.

Referenced by ComputeExpS(), and FindOptA().

◆ ComputeExpS() [2/2]

double ns3::UanMacRcGw::ComputeExpS	(	uint32_t	a,
		uint32_t	ld
	)

private

Throughput for a reservations with framesize ld.

Parameters

a	Number of reservations.
ld	Frame size.

Returns: Expected throughput.

Definition at line 621 of file uan-mac-rc-gw.cc.

References ComputeExpS(), and GetExpPdk().

◆ ComputePiK()

double ns3::UanMacRcGw::ComputePiK	(	uint32_t	a,
		uint32_t	n,
		uint32_t	k
	)

private

Numeric function.

Parameters

a	Number of reservations.
n	number of nodes.
k	K'th node.

Returns: Value.

Definition at line 640 of file uan-mac-rc-gw.cc.

References sample-rng-plot::n, and NchooseK().

Referenced by ComputeExpBOverA(), and ComputeExpS().

◆ CycleStarted()

void ns3::UanMacRcGw::CycleStarted ( void )

private

Set state to INCYCLE.

Definition at line 450 of file uan-mac-rc-gw.cc.

References INCYCLE, and m_state.

Referenced by StartCycle().

◆ DoDispose()

void ns3::UanMacRcGw::DoDispose ( void )

protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 97 of file uan-mac-rc-gw.cc.

References Clear(), and ns3::Object::DoDispose().

◆ EndCycle()

void ns3::UanMacRcGw::EndCycle ( void )

private

End cycle by scheduling pending ACKs.

Definition at line 455 of file uan-mac-rc-gw.cc.

References ns3::Packet::AddHeader(), ns3::UanHeaderRcAck::AddNackedFrame(), data, m_ackData, m_ackSize, m_address, m_currentRateNum, m_phy, m_sifs, ns3::Simulator::Now(), NS_LOG_DEBUG, ns3::Simulator::Schedule(), ns3::Seconds(), SendPacket(), ns3::UanHeaderCommon::SetDest(), ns3::UanHeaderRcAck::SetFrameNo(), ns3::UanHeaderCommon::SetSrc(), ns3::UanHeaderCommon::SetType(), StartCycle(), and ns3::UanMacRc::TYPE_ACK.

Referenced by StartCycle().

◆ Enqueue()

bool ns3::UanMacRcGw::Enqueue	(	Ptr< Packet >	pkt,
		uint16_t	protocolNumber,
		const Address &	dest
	)

virtual

Enqueue packet to be transmitted.

Parameters

pkt	Packet to be transmitted.
dest	Destination address.
protocolNumber	The type of the packet.

Returns: True if packet was successfully enqueued.

Implements ns3::UanMac.

Definition at line 174 of file uan-mac-rc-gw.cc.

References NS_LOG_WARN, and NS_UNUSED.

◆ FindOptA()

uint32_t ns3::UanMacRcGw::FindOptA ( void )

private

Compute the optimum maximum number of reservations to accept per cycle.

Returns: Optimum number.

Definition at line 689 of file uan-mac-rc-gw.cc.

References ComputeExpS(), m_frameSize, ns3::Simulator::Now(), and NS_LOG_DEBUG.

Referenced by StartCycle().

◆ GetExpPdk()

std::vector< double > ns3::UanMacRcGw::GetExpPdk ( void )

private

Get the expected propagation delay to each node.

Returns: Vector of expected propagation delays.

Definition at line 564 of file uan-mac-rc-gw.cc.

References CompExpMinIndex(), ns3::Time::GetSeconds(), m_maxDelta, m_numNodes, m_propDelay, and sample-rng-plot::n.

Referenced by ComputeExpS().

◆ GetTypeId()

TypeId ns3::UanMacRcGw::GetTypeId ( void )

static

Register this type.

Returns: The type ID.

Definition at line 103 of file uan-mac-rc-gw.cc.

References m_cycleLogger, m_frameSize, m_maxDelta, m_maxRes, m_minRetryRate, m_numNodes, m_numRates, m_rateStep, m_retryStep, m_rxLogger, m_sifs, m_totalRate, ns3::MakeDoubleAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::Seconds(), and ns3::TypeId::SetParent().

◆ NchooseK()

uint64_t ns3::UanMacRcGw::NchooseK	(	uint32_t	n,
		uint32_t	k
	)

private

Binomial coefficient.

Parameters

n	Pool size.
k	Selection size.

Returns: Binomial coefficient n choose k.

Definition at line 666 of file uan-mac-rc-gw.cc.

References sample-rng-plot::n.

Referenced by CompExpMinIndex(), and ComputePiK().

◆ ReceiveError()

void ns3::UanMacRcGw::ReceiveError	(	Ptr< Packet >	pkt,
		double	sinr
	)

private

PHY receive error callback.

Parameters

pkt	The failed packet.
sinr	The SINR value on the channel.

Definition at line 197 of file uan-mac-rc-gw.cc.

References NS_UNUSED.

Referenced by AttachPhy().

◆ ReceivePacket()

void ns3::UanMacRcGw::ReceivePacket	(	Ptr< Packet >	pkt,
		double	sinr,
		UanTxMode	mode
	)

private

PHY receive ok callback.

Parameters

pkt	The Packet to receive
sinr	The SINR on the channel
mode	The transmission mode

Definition at line 203 of file uan-mac-rc-gw.cc.

References CTSING, ns3::UanMacRcGw::Request::frameNo, ns3::Mac8Address::GetBroadcast(), ns3::UanHeaderCommon::GetDest(), ns3::UanHeaderRcData::GetFrameNo(), ns3::UanHeaderRcRts::GetFrameNo(), ns3::UanHeaderRcRts::GetLength(), ns3::UanHeaderRcRts::GetNoFrames(), ns3::UanHeaderRcData::GetPropDelay(), ns3::UanHeaderCommon::GetProtocolNumber(), ns3::UanHeaderRcRts::GetRetryNo(), ns3::Packet::GetSize(), ns3::UanHeaderCommon::GetSrc(), ns3::UanHeaderCommon::GetType(), IDLE, ns3::UanMacRcGw::Request::length, m_ackData, m_address, m_forwardUpCb, m_maxDelta, m_propDelay, m_requests, m_rxLogger, m_sortedRes, m_state, ns3::Simulator::Now(), NS_FATAL_ERROR, NS_LOG_DEBUG, NS_UNUSED, ns3::UanMacRcGw::Request::numFrames, ns3::Packet::PeekHeader(), ns3::Packet::RemoveHeader(), ns3::UanMacRcGw::Request::retryNo, ns3::UanMacRcGw::Request::rxTime, StartCycle(), ns3::UanMacRc::TYPE_ACK, ns3::UanMacRc::TYPE_CTS, ns3::UanMacRc::TYPE_DATA, ns3::UanMacRc::TYPE_GWPING, and ns3::UanMacRc::TYPE_RTS.

Referenced by AttachPhy().

◆ SendPacket()

void ns3::UanMacRcGw::SendPacket	(	Ptr< Packet >	pkt,
		uint32_t	rate
	)

private

Send packet on PHY.

Parameters

pkt	The Packet.
rate	The UanTxMode number, m_currentRateNum.

Definition at line 501 of file uan-mac-rc-gw.cc.

References ns3::UanHeaderCommon::GetDest(), ns3::Packet::GetSize(), ns3::UanHeaderCommon::GetType(), m_phy, ns3::Simulator::Now(), NS_LOG_DEBUG, ns3::Packet::PeekHeader(), ns3::UanMacRc::TYPE_ACK, ns3::UanMacRc::TYPE_CTS, ns3::UanMacRc::TYPE_DATA, ns3::UanMacRc::TYPE_GWPING, and ns3::UanMacRc::TYPE_RTS.

Referenced by EndCycle(), and StartCycle().

◆ SetForwardUpCb()

void ns3::UanMacRcGw::SetForwardUpCb ( Callback< void, Ptr< Packet >, uint16_t, const Mac8Address &> cb )

virtual

Set the callback to forward packets up to higher layers.

Parameters

cb	The callback. packet The packet. address The source address.

Implements ns3::UanMac.

Definition at line 183 of file uan-mac-rc-gw.cc.

References m_forwardUpCb.

◆ StartCycle()

void ns3::UanMacRcGw::StartCycle ( void )

private

Cycle through pending requests.

Definition at line 288 of file uan-mac-rc-gw.cc.

References ns3::Packet::AddHeader(), ComputeAlpha(), CTSING, CycleStarted(), EndCycle(), ns3::UanMacRcGw::AckData::expFrames, FindOptA(), ns3::UanMacRcGw::Request::frameNo, ns3::UanMacRcGw::AckData::frameNo, ns3::Mac8Address::GetBroadcast(), ns3::Time::GetSeconds(), INCYCLE, ns3::UanMacRcGw::Request::length, m_ackData, m_ackSize, m_address, m_ctsSizeG, m_ctsSizeN, m_currentRateNum, m_currentRetryRate, m_cycleLogger, m_maxDelta, m_maxRes, m_minRetryRate, m_numNodes, m_numRates, m_phy, m_rateStep, m_requests, m_retryStep, m_rtsSize, m_sifs, m_sortedRes, m_state, m_totalRate, max, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_WARN, ns3::UanMacRcGw::Request::numFrames, ns3::UanMacRcGw::Request::retryNo, ns3::UanMacRcGw::Request::rxTime, ns3::Simulator::Schedule(), ns3::Seconds(), SendPacket(), ns3::UanHeaderRcCts::SetAddress(), ns3::UanHeaderCommon::SetDest(), ns3::UanHeaderRcCtsGlobal::SetRateNum(), ns3::UanHeaderRcCtsGlobal::SetRetryRate(), ns3::UanHeaderCommon::SetSrc(), ns3::UanHeaderRcCtsGlobal::SetTxTimeStamp(), ns3::UanHeaderCommon::SetType(), ns3::UanHeaderRcCtsGlobal::SetWindowTime(), and ns3::UanMacRc::TYPE_CTS.

Referenced by EndCycle(), and ReceivePacket().

Member Data Documentation

◆ m_ackData

std::map<Mac8Address, AckData> ns3::UanMacRcGw::m_ackData

private

AckData for each node.

Definition at line 152 of file uan-mac-rc-gw.h.

Referenced by Clear(), EndCycle(), ReceivePacket(), and StartCycle().

◆ m_ackSize

uint32_t ns3::UanMacRcGw::m_ackSize

private

Size of UanHeaderCommon and UanHeaderRcAck.

Definition at line 137 of file uan-mac-rc-gw.h.

Referenced by ComputeExpBOverA(), EndCycle(), StartCycle(), and UanMacRcGw().

◆ m_address

Mac8Address ns3::UanMacRcGw::m_address

private

The MAC address.

Definition at line 129 of file uan-mac-rc-gw.h.

Referenced by EndCycle(), ReceivePacket(), and StartCycle().

◆ m_cleared

bool ns3::UanMacRcGw::m_cleared

private

Flag when we've been cleared.

Definition at line 160 of file uan-mac-rc-gw.h.

Referenced by Clear().

◆ m_ctsSizeG

uint32_t ns3::UanMacRcGw::m_ctsSizeG

private

Size of UanHeaderCommon and UanHeaderRcCtsGlobal.

Definition at line 136 of file uan-mac-rc-gw.h.

Referenced by ComputeAlpha(), ComputeExpBOverA(), ComputeExpS(), StartCycle(), and UanMacRcGw().

◆ m_ctsSizeN

uint32_t ns3::UanMacRcGw::m_ctsSizeN

private

Size of UanHeaderRcCts.

Definition at line 135 of file uan-mac-rc-gw.h.

Referenced by ComputeExpBOverA(), StartCycle(), and UanMacRcGw().

◆ m_currentRateNum

uint32_t ns3::UanMacRcGw::m_currentRateNum

private

Rate number corresponding to data rate of current cycle.

Definition at line 139 of file uan-mac-rc-gw.h.

Referenced by EndCycle(), and StartCycle().

◆ m_currentRetryRate

uint16_t ns3::UanMacRcGw::m_currentRetryRate

private

Retry rate number for current cycle.

Definition at line 138 of file uan-mac-rc-gw.h.

Referenced by StartCycle().

◆ m_cycleLogger

TracedCallback<Time, Time, uint32_t, uint32_t, double, uint32_t, double> ns3::UanMacRcGw::m_cycleLogger

private

A packet was destined for and received at this MAC layer.

Start time min propagation delay reservations frames bytes window size CTS rate retry rate

Definition at line 177 of file uan-mac-rc-gw.h.

Referenced by GetTypeId(), and StartCycle().

◆ m_forwardUpCb

Callback<void, Ptr<Packet>, uint16_t, const Mac8Address&> ns3::UanMacRcGw::m_forwardUpCb

private

Forwarding up callback.

Definition at line 126 of file uan-mac-rc-gw.h.

Referenced by ReceivePacket(), and SetForwardUpCb().

◆ m_frameSize

uint32_t ns3::UanMacRcGw::m_frameSize

private

Size of data frames in bytes.

Definition at line 143 of file uan-mac-rc-gw.h.

Referenced by FindOptA(), and GetTypeId().

◆ m_maxDelta

Time ns3::UanMacRcGw::m_maxDelta

private

Maximum propagation delay between gateway and non-gateway nodes .

Definition at line 130 of file uan-mac-rc-gw.h.

Referenced by ComputeAlpha(), ComputeExpS(), GetExpPdk(), GetTypeId(), ReceivePacket(), and StartCycle().

◆ m_maxRes

uint32_t ns3::UanMacRcGw::m_maxRes

private

Maximum number of reservations to accept per cycle.

Definition at line 132 of file uan-mac-rc-gw.h.

Referenced by GetTypeId(), and StartCycle().

◆ m_minRetryRate

double ns3::UanMacRcGw::m_minRetryRate

private

Smallest allowed RTS retry rate.

Definition at line 145 of file uan-mac-rc-gw.h.

Referenced by GetTypeId(), and StartCycle().

◆ m_numNodes

uint32_t ns3::UanMacRcGw::m_numNodes

private

Number of non-gateway nodes in this gateway's neighborhood.

Definition at line 140 of file uan-mac-rc-gw.h.

Referenced by ComputeExpS(), GetExpPdk(), GetTypeId(), and StartCycle().

◆ m_numRates

uint32_t ns3::UanMacRcGw::m_numRates

private

Number of rates per Phy layer.

Definition at line 133 of file uan-mac-rc-gw.h.

Referenced by GetTypeId(), and StartCycle().

◆ m_phy

Ptr<UanPhy> ns3::UanMacRcGw::m_phy

private

PHY layer attached to this MAC.

Definition at line 128 of file uan-mac-rc-gw.h.

Referenced by AttachPhy(), Clear(), EndCycle(), SendPacket(), and StartCycle().

◆ m_propDelay

std::map<Mac8Address, Time> ns3::UanMacRcGw::m_propDelay

private

Propagation delay to each node.

Definition at line 149 of file uan-mac-rc-gw.h.

Referenced by Clear(), GetExpPdk(), and ReceivePacket().

◆ m_rateStep

uint32_t ns3::UanMacRcGw::m_rateStep

private

Increments available for rate assignment in bps.

Definition at line 142 of file uan-mac-rc-gw.h.

Referenced by GetTypeId(), and StartCycle().

◆ m_requests

std::map<Mac8Address, Request> ns3::UanMacRcGw::m_requests

private

Request for each node.

Definition at line 155 of file uan-mac-rc-gw.h.

Referenced by Clear(), ReceivePacket(), and StartCycle().

◆ m_retryStep

double ns3::UanMacRcGw::m_retryStep

private

Retry rate increment.

Definition at line 146 of file uan-mac-rc-gw.h.

Referenced by GetTypeId(), and StartCycle().

◆ m_rtsSize

uint32_t ns3::UanMacRcGw::m_rtsSize

private

Size of UanHeaderCommon and UanHeaderRcRts.

Definition at line 134 of file uan-mac-rc-gw.h.

Referenced by ComputeAlpha(), ComputeExpS(), StartCycle(), and UanMacRcGw().

◆ m_rxLogger

TracedCallback<Ptr<const Packet>, UanTxMode > ns3::UanMacRcGw::m_rxLogger

private

A packet was destined for and received at this MAC layer.

Definition at line 163 of file uan-mac-rc-gw.h.

Referenced by GetTypeId(), and ReceivePacket().

◆ m_sifs

Time ns3::UanMacRcGw::m_sifs

private

Spacing between frames to account for timing error and processing delay.

Definition at line 131 of file uan-mac-rc-gw.h.

Referenced by ComputeAlpha(), ComputeExpS(), EndCycle(), GetTypeId(), and StartCycle().

◆ m_sortedRes

std::set<std::pair<Time, Mac8Address> > ns3::UanMacRcGw::m_sortedRes

private

Queued request times.

Definition at line 157 of file uan-mac-rc-gw.h.

Referenced by Clear(), ReceivePacket(), and StartCycle().

◆ m_state

State ns3::UanMacRcGw::m_state

private

Gateway processing state.

Definition at line 100 of file uan-mac-rc-gw.h.

Referenced by CycleStarted(), ReceivePacket(), and StartCycle().

◆ m_totalRate

uint32_t ns3::UanMacRcGw::m_totalRate

private

Total available channel rate in bps (for a single channel, without splitting reservation channel).

Definition at line 141 of file uan-mac-rc-gw.h.

Referenced by ComputeAlpha(), ComputeExpBOverA(), ComputeExpS(), GetTypeId(), and StartCycle().

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

src/uan/model/uan-mac-rc-gw.h
src/uan/model/uan-mac-rc-gw.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

TraceSources

Member Typedef Documentation

◆ CycleCallback

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ UanMacRcGw()

◆ ~UanMacRcGw()

Member Function Documentation

◆ AssignStreams()

◆ AttachPhy()

◆ Clear()

◆ CompExpMinIndex()

◆ ComputeAlpha()

◆ ComputeExpBOverA()

◆ ComputeExpS() [1/2]

◆ ComputeExpS() [2/2]

◆ ComputePiK()

◆ CycleStarted()

◆ DoDispose()

◆ EndCycle()

◆ Enqueue()

◆ FindOptA()

◆ GetExpPdk()

◆ GetTypeId()

◆ NchooseK()

◆ ReceiveError()

◆ ReceivePacket()

◆ SendPacket()

◆ SetForwardUpCb()

◆ StartCycle()

Member Data Documentation

◆ m_ackData

◆ m_ackSize

◆ m_address

◆ m_cleared

◆ m_ctsSizeG

◆ m_ctsSizeN

◆ m_currentRateNum

◆ m_currentRetryRate

◆ m_cycleLogger

◆ m_forwardUpCb

◆ m_frameSize

◆ m_maxDelta

◆ m_maxRes

◆ m_minRetryRate

◆ m_numNodes

◆ m_numRates

◆ m_phy

◆ m_propDelay

◆ m_rateStep

◆ m_requests

◆ m_retryStep

◆ m_rtsSize

◆ m_rxLogger

◆ m_sifs

◆ m_sortedRes

◆ m_state

◆ m_totalRate