Non-gateway node MAC for reservation channel MAC protocol. More...

#include <uan-mac-rc.h>

Inheritance diagram for ns3::UanMacRc:

Collaboration diagram for ns3::UanMacRc:

Public Types
enum	{ TYPE_DATA, TYPE_GWPING, TYPE_RTS, TYPE_CTS, TYPE_ACK }

Public Member Functions
	UanMacRc ()
virtual	~UanMacRc ()
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::UanMacRc.

Protected Member Functions
void	DoDispose ()

Private Types
enum	State { UNASSOCIATED, GWPSENT, IDLE, RTSSENT, DATATX }

Private Member Functions
void	Associate (void)
void	AssociateTimeout (void)
void	BlockRtsing (void)
UanHeaderRcRts	CreateRtsHeader (const Reservation &res)
bool	IsPhy1Ok (void)
void	ProcessAck (Ptr< Packet > ack)
void	ReceiveOkFromPhy (Ptr< Packet >, double sinr, UanTxMode mode)
void	RtsTimeout (void)
void	ScheduleData (const UanHeaderRcCts &ctsh, const UanHeaderRcCtsGlobal &ctsg, uint32_t ctsBytes)
void	SendPacket (Ptr< Packet > pkt, uint32_t rate)
void	SendRts (void)

Private Attributes
UanAddress	m_address
UanAddress	m_assocAddr
bool	m_cleared
uint32_t	m_ctsSizeG
uint32_t	m_ctsSizeN
uint32_t	m_currentRate
TracedCallback< Ptr< const Packet >, uint16_t >	m_dequeueLogger
TracedCallback< Ptr< const Packet >, uint16_t >	m_enqueueLogger
Ptr< ExponentialRandomVariable >	m_ev
	Provides exponential random variables.
Callback< void, Ptr< Packet > , const UanAddress & >	m_forwardUpCb
uint8_t	m_frameNo
Time	m_learnedProp
uint32_t	m_maxFrames
double	m_minRetryRate
uint32_t	m_numRates
uint16_t	m_numRetryRates
Ptr< UanPhy >	m_phy
std::list< std::pair< Ptr < Packet >, UanAddress > >	m_pktQueue
uint32_t	m_queueLimit
std::list< Reservation >	m_resList
double	m_retryRate
double	m_retryStep
bool	m_rtsBlocked
EventId	m_rtsEvent
TracedCallback< Ptr< const Packet >, UanTxMode >	m_rxLogger
Time	m_sifs
EventId	m_startAgain
State	m_state

Static Private Attributes
static uint32_t	m_cntrlSends = 0

Detailed Description

Non-gateway node MAC for reservation channel MAC protocol.

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. 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 137 of file uan-mac-rc.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

TYPE_DATA
TYPE_GWPING
TYPE_RTS
TYPE_CTS
TYPE_ACK

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

enum ns3::UanMacRc::State

private

Enumerator:

UNASSOCIATED
GWPSENT
IDLE
RTSSENT
DATATX

Definition at line 168 of file uan-mac-rc.h.

Constructor & Destructor Documentation

ns3::UanMacRc::UanMacRc ( )

Definition at line 153 of file uan-mac-rc.cc.

References ns3::UanHeaderRcCtsGlobal::GetSerializedSize(), ns3::UanHeaderRcCts::GetSerializedSize(), m_ctsSizeG, m_ctsSizeN, and m_ev.

Here is the call graph for this function:

ns3::UanMacRc::~UanMacRc ( )

virtual

Definition at line 171 of file uan-mac-rc.cc.

Member Function Documentation

int64_t ns3::UanMacRc::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 271 of file uan-mac-rc.cc.

References m_ev, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

void ns3::UanMacRc::Associate ( void )

private

Definition at line 623 of file uan-mac-rc.cc.

References ns3::Packet::AddHeader(), ns3::Reservation::AddTimestamp(), AssociateTimeout(), CreateRtsHeader(), ns3::UanAddress::GetBroadcast(), ns3::Object::GetObject(), ns3::ExponentialRandomVariable::GetValue(), GWPSENT, IsPhy1Ok(), ns3::EventId::IsRunning(), m_address, m_cntrlSends, m_currentRate, m_ev, m_frameNo, m_maxFrames, m_numRates, m_phy, m_pktQueue, m_resList, m_retryRate, m_rtsBlocked, m_rtsEvent, m_state, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, ns3::Simulator::Schedule(), ns3::Seconds(), SendPacket(), ns3::ObjectBase::SetAttribute(), timeout, and TYPE_GWPING.

Referenced by Enqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UanMacRc::AssociateTimeout ( void )

private

Definition at line 649 of file uan-mac-rc.cc.

References ns3::Packet::AddHeader(), CreateRtsHeader(), ns3::UanAddress::GetBroadcast(), ns3::Object::GetObject(), ns3::ExponentialRandomVariable::GetValue(), GWPSENT, IsPhy1Ok(), ns3::EventId::IsRunning(), m_address, m_cntrlSends, m_currentRate, m_ev, m_numRates, m_phy, m_resList, m_retryRate, m_rtsBlocked, m_rtsEvent, m_state, ns3::Simulator::Now(), NS_ASSERT, ns3::Simulator::Schedule(), ns3::Seconds(), SendPacket(), ns3::ObjectBase::SetAttribute(), timeout, and TYPE_GWPING.

Referenced by Associate().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UanMacRc::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 333 of file uan-mac-rc.cc.

References m_phy, ns3::MakeCallback(), ReceiveOkFromPhy(), and ns3::UanPhy::SetReceiveOkCallback().

Here is the call graph for this function:

void ns3::UanMacRc::BlockRtsing ( void )

private

Definition at line 776 of file uan-mac-rc.cc.

References m_rtsBlocked.

Referenced by ReceiveOkFromPhy().

Here is the caller graph for this function:

void ns3::UanMacRc::Clear ( void )

virtual

Clears all pointer references

Implements ns3::UanMac.

Definition at line 176 of file uan-mac-rc.cc.

References ns3::EventId::Cancel(), ns3::UanPhy::Clear(), m_cleared, m_phy, m_pktQueue, m_resList, m_rtsEvent, and m_startAgain.

Referenced by DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

UanHeaderRcRts ns3::UanMacRc::CreateRtsHeader ( const Reservation & res )

private

Definition at line 610 of file uan-mac-rc.cc.

References ns3::Reservation::GetFrameNo(), ns3::Reservation::GetLength(), ns3::Reservation::GetNoFrames(), ns3::Reservation::GetRetryNo(), ns3::Reservation::GetTimestamp(), ns3::UanHeaderRcRts::SetFrameNo(), ns3::UanHeaderRcRts::SetLength(), ns3::UanHeaderRcRts::SetNoFrames(), ns3::UanHeaderRcRts::SetRetryNo(), and ns3::UanHeaderRcRts::SetTimeStamp().

Referenced by Associate(), AssociateTimeout(), RtsTimeout(), and SendRts().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::UanMacRc::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 200 of file uan-mac-rc.cc.

References Clear().

Here is the call graph for this function:

bool ns3::UanMacRc::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 291 of file uan-mac-rc.cc.

References Associate(), ns3::UanAddress::ConvertFrom(), DATATX, GWPSENT, IDLE, ns3::EventId::IsRunning(), m_pktQueue, m_queueLimit, m_rtsEvent, m_state, NS_LOG_WARN, RTSSENT, SendRts(), and UNASSOCIATED.

Here is the call graph for this function:

Address ns3::UanMacRc::GetAddress ( void )

virtual

Returns: MAC Address

Implements ns3::UanMac.

Definition at line 279 of file uan-mac-rc.cc.

References m_address.

Referenced by ReceiveOkFromPhy().

Here is the caller graph for this function:

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

virtual

Returns: Broadcast address

Implements ns3::UanMac.

Definition at line 340 of file uan-mac-rc.cc.

Referenced by ReceiveOkFromPhy().

Here is the caller graph for this function:

TypeId ns3::UanMacRc::GetTypeId ( void )

static

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

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

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

Attributes defined for this type:

RetryRate: Number of retry attempts per second (of RTS/GWPING)
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.2
- Flags: construct write read
MaxFrames: Maximum number of frames to include in a single RTS
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1
- Flags: construct write read
QueueLimit: Maximum packets to queue at MAC
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
SIFS: Spacing to give between frames (this should match gateway)
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +200000000.0ns
- Flags: construct write read
NumberOfRates: Number of rate divisions supported by each PHY
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- 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
MaxPropDelay: Maximum possible propagation delay to gateway
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +2000000000.0ns
- Flags: construct write read