Gateway side of RC-MAC. More...

#include <uan-mac-rc-gw.h>

Inheritance diagram for ns3::UanMacRcGw:

Collaboration diagram for ns3::UanMacRcGw:

Classes
struct	AckData
struct	Request

Public Member Functions
	UanMacRcGw ()
virtual	~UanMacRcGw ()
int64_t	AssignStreams (int64_t stream)
virtual void	AttachPhy (Ptr< UanPhy > phy)
virtual void	Clear (void)
virtual bool	Enqueue (Ptr< Packet > pkt, const Address &dest, uint16_t protocolNumber)
virtual Address	GetAddress (void)
virtual Address	GetBroadcast (void) const
virtual void	SetAddress (UanAddress addr)
virtual void	SetForwardUpCb (Callback< void, Ptr< Packet >, const UanAddress & > cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::UanMacRcGw.

Protected Member Functions
virtual void	DoDispose ()

Private Types
enum	State { IDLE, INCYCLE, CTSING }

Private Member Functions
uint32_t	CompExpMinIndex (uint32_t n, uint32_t k)
double	ComputeAlpha (uint32_t totalFrames, uint32_t totalBytes, uint32_t n, uint32_t a, double deltaK)
double	ComputeExpBOverA (uint32_t n, uint32_t a, uint32_t ldlh, std::vector< double > deltaK)
double	ComputeExpS (uint32_t a, uint32_t ld, std::vector< double > exppdk)
double	ComputeExpS (uint32_t a, uint32_t ld)
double	ComputePiK (uint32_t a, uint32_t n, uint32_t k)
void	CycleStarted (void)
void	EndCycle (void)
uint32_t	FindOptA (void)
std::vector< double >	GetExpPdk (void)
uint64_t	NchooseK (uint32_t n, uint32_t k)
void	ReceiveError (Ptr< Packet > pkt, double sinr)
void	ReceivePacket (Ptr< Packet > pkt, double sinr, UanTxMode mode)
void	SendPacket (Ptr< Packet > pkt, uint32_t rate)
void	StartCycle (void)

Private Attributes
std::map< UanAddress, AckData >	m_ackData
uint32_t	m_ackSize
UanAddress	m_address
bool	m_cleared
uint32_t	m_ctsSizeG
uint32_t	m_ctsSizeN
uint32_t	m_currentRateNum
uint16_t	m_currentRetryRate
TracedCallback< Time, Time, uint32_t, uint32_t, double, uint32_t, double >	m_cycleLogger
Callback< void, Ptr< Packet > , const UanAddress & >	m_forwardUpCb
uint32_t	m_frameSize
Time	m_maxDelta
uint32_t	m_maxRes
double	m_minRetryRate
uint32_t	m_numNodes
uint32_t	m_numRates
uint16_t	m_numRetryRates
Ptr< UanPhy >	m_phy
std::map< UanAddress, Time >	m_propDelay
uint32_t	m_rateStep
std::map< UanAddress, Request >	m_requests
double	m_retryRate
double	m_retryStep
uint32_t	m_rtsSize
TracedCallback< Ptr< const Packet >, UanTxMode >	m_rxLogger
Time	m_sifs
std::set< std::pair< Time, UanAddress > >	m_sortedRes
State	m_state
uint32_t	m_totalRate

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)

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

Member Enumeration Documentation

enum ns3::UanMacRcGw::State

private

Enumerator:

IDLE
INCYCLE
CTSING

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

Constructor & Destructor Documentation

ns3::UanMacRcGw::UanMacRcGw ( )

Definition at line 54 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.

Here is the call graph for this function:

ns3::UanMacRcGw::~UanMacRcGw ( )

virtual

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

Member Function Documentation

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 737 of file uan-mac-rc-gw.cc.

References NS_LOG_FUNCTION.

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 212 of file uan-mac-rc-gw.cc.

References m_phy, ns3::MakeCallback(), ReceiveError(), ReceivePacket(), ns3::UanPhy::SetReceiveErrorCallback(), and ns3::UanPhy::SetReceiveOkCallback().

Here is the call graph for this function:

void ns3::UanMacRcGw::Clear ( void )

virtual

Clears all pointer references

Implements ns3::UanMac.

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

References ns3::UanPhy::Clear(), m_ackData, m_cleared, m_phy, m_propDelay, m_requests, and m_sortedRes.

Referenced by DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

References NchooseK().

Referenced by GetExpPdk().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

References ns3::Time::GetSeconds(), m_ctsSizeG, m_maxDelta, m_rtsSize, m_sifs, m_totalRate, NS_ASSERT_MSG, and visualizer.higcontainer::w.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

References ComputeAlpha(), ComputePiK(), m_ackSize, m_ctsSizeG, m_ctsSizeN, and m_totalRate.

Referenced by ComputeExpS().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

Definition at line 617 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, and NS_LOG_DEBUG.

Referenced by ComputeExpS(), and FindOptA().

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

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

References ComputeExpS(), and GetExpPdk().

Here is the call graph for this function:

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

private

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

References NchooseK().

Referenced by ComputeExpBOverA(), and ComputeExpS().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UanMacRcGw::CycleStarted ( void )

private

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

References INCYCLE, and m_state.

Referenced by StartCycle().

Here is the caller graph for this function:

void ns3::UanMacRcGw::DoDispose ( void )

protectedvirtual

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

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

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

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

References Clear().

Here is the call graph for this function:

void ns3::UanMacRcGw::EndCycle ( void )

private

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

References ns3::Packet::AddHeader(), ns3::UanHeaderRcAck::AddNackedFrame(), data, ns3::UanMacRcGw::AckData::expFrames, ns3::UanMacRcGw::AckData::frameNo, ns3::UanTxMode::GetDataRateBps(), ns3::UanPhy::GetMode(), m_ackData, m_ackSize, m_address, m_currentRateNum, m_phy, m_sifs, ns3::Simulator::Now(), NS_LOG_DEBUG, ns3::UanMacRcGw::AckData::rxFrames, 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().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Enqueue packet to be transmitted

Parameters

pkt	Packet to be transmitted
dest	Destination address
protocolNumber	Protocol #. Usage varies by MAC

Implements ns3::UanMac.

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

References NS_LOG_WARN.

uint32_t ns3::UanMacRcGw::FindOptA ( void )

private

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

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

Referenced by StartCycle().

Here is the call graph for this function:

Here is the caller graph for this function:

Address ns3::UanMacRcGw::GetAddress ( void )

virtual

Returns: MAC Address

Implements ns3::UanMac.

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

References m_address.

Address ns3::UanMacRcGw::GetBroadcast ( void ) const

virtual

Returns: Broadcast address

Implements ns3::UanMac.

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

Referenced by ReceivePacket().

Here is the caller graph for this function:

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

private

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

References CompExpMinIndex(), ns3::Time::GetSeconds(), m_maxDelta, m_numNodes, and m_propDelay.

Referenced by ComputeExpS().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::UanMacRcGw::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::UanMacRcGw.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes defined for this type:

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
RetryRate: Number of retry rates per second at non-gateway nodes
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.1
- Flags: construct write read
MaxPropDelay: Maximum propagation delay between gateway and non-gateway nodes
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +2000000000.0ns
- Flags: construct write read
SIFS: Spacing between frames to account for timing error and processing delay
- Set with class: TimeValue
- Underlying type: Time
- 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
NumberOfRetryRates: Number of retry rates
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 100
- 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