Collapse all Symbian^3 Product Developer Library

RFrameXferBlockProtocolStack Class Reference

class RFrameXferBlockProtocolStack : public RFrameXferBlock

Ethernet frame transfer context block between user and kernel space for the protocol stack side client

Inherits from

RFrameXferBlockProtocolStack
- RFrameXferBlock
  - RFrameXferBlockBase

Public Member Functions
void	UserInitialize(TUint32)

Private Member Functions
	RFrameXferBlockProtocolStack()
	RFrameXferBlockProtocolStack(const RFrameXferBlockProtocolStack &)
TBool	TxFlowControl(TQueueId, TBool)
TBool	TxPossible(const TWhaTxQueueState &, TQueueId &)
RFrameXferBlockProtocolStack &	operator=(const RFrameXferBlockProtocolStack &)

Inherited Functions
	RFrameXferBlock::AppendTxDataBuffer(const TUint8 ,TUint32,TDataBuffer::TFrameType,TUint8,TBool,const TMacAddress )
	RFrameXferBlock::ClearTxDataBuffer()
	RFrameXferBlock::SetTxDataBufferField(TLinAddr)
	RFrameXferBlockBase::GetNextRxDataBuffer(TDataBuffer *&)
	RFrameXferBlockBase::SetRxDataChunkField(TLinAddr)

Private Attributes
RWlanCircularBuffer< KBackgroundTxQueueLen >	iBackgroundTxQueue
RWlanCircularBuffer< KBestEffortTxQueueLen >	iBestEffortTxQueue
TDataBuffer	iDataBuffers
RWlanCircularBuffer< KTxPoolSizeInPackets >	iFreeQueue
TUint32	iThisAddrKernelSpace
TUint32	iThisAddrUserSpace
TInt32	iUserToKernAddrOffset
RWlanCircularBuffer< KVideoTxQueueLen >	iVideoTxQueue
RWlanCircularBuffer< KVoiceTxQueueLen >	iVoiceTxQueue

Inherited Attributes
	RFrameXferBlockBase::iCurrentRxBuffer
	RFrameXferBlockBase::iFirstRxBufferToFree
	RFrameXferBlockBase::iNumOfCompleted
	RFrameXferBlockBase::iRxCompletedBuffers
	RFrameXferBlockBase::iRxDataChunk
	RFrameXferBlockBase::iTxOffset

Constructor & Destructor Documentation

RFrameXferBlockProtocolStack()

RFrameXferBlockProtocolStack

(

)

[private]

Prohibit default constructor

RFrameXferBlockProtocolStack(const RFrameXferBlockProtocolStack &)

RFrameXferBlockProtocolStack

(

const RFrameXferBlockProtocolStack &

)

[private]

Prohibit copy constructor

Parameters

const RFrameXferBlockProtocolStack &

Member Functions Documentation

TxFlowControl(TQueueId, TBool)

TBool	TxFlowControl	(	TQueueId	aTxQueue,
			TBool	aUserDataTxEnabled
		)	[private]

Determines if the Tx flow from client needs to be stopped

Parameters

TQueueId aTxQueue	Tx queue to which the latest packet was added
TBool aUserDataTxEnabled	ETrue if user data Tx is enabled EFalse otherwise return EFalse if Tx flow needs to be stopped ETrue otherwise

TxPossible(const TWhaTxQueueState &, TQueueId &)

TBool	TxPossible	(	const TWhaTxQueueState &	aWhaTxQueueState,
			TQueueId &	aQueueId
		)	[private]

With the current WLAN LDD Tx queue contents and WHA queue status, is it possible to schedule a new Tx packet

Parameters

const TWhaTxQueueState & aWhaTxQueueState	Status of all WHA Tx queues (full/not full)
TQueueId & aQueueId	Upon returning ETrue, denotes the WLAN LDD queue from which a packet can be scheduled

UserInitialize(TUint32)

void

UserInitialize

(

TUint32

aThisAddrUserSpace

)

[inline]

Initializes TX Data pool, with the address of this in user space.

Parameters

TUint32 aThisAddrUserSpace

Address of this object in user space.

operator=(const RFrameXferBlockProtocolStack &)

RFrameXferBlockProtocolStack &

operator=

(

const RFrameXferBlockProtocolStack &

)

[private]

Prohibit assigment operator

Parameters

const RFrameXferBlockProtocolStack &

Member Data Documentation

RWlanCircularBuffer< KBackgroundTxQueueLen > iBackgroundTxQueue

RWlanCircularBuffer< KBackgroundTxQueueLen >

iBackgroundTxQueue

[private]

Tx Queue for Background priority frames

RWlanCircularBuffer< KBestEffortTxQueueLen > iBestEffortTxQueue

RWlanCircularBuffer< KBestEffortTxQueueLen >

iBestEffortTxQueue

[private]

Tx Queue for Best Effort priority frames

TDataBuffer iDataBuffers

TDataBuffer

iDataBuffers

[private]

Tx frame meta header objects

RWlanCircularBuffer< KTxPoolSizeInPackets > iFreeQueue

RWlanCircularBuffer< KTxPoolSizeInPackets >

iFreeQueue

[private]

Free Queue

TUint32 iThisAddrKernelSpace

TUint32

iThisAddrKernelSpace

[private]

Address of this object instance in the kernel mode address space

TUint32 iThisAddrUserSpace

TUint32

iThisAddrUserSpace

[private]

Address of this object instance in the user mode address space

TInt32 iUserToKernAddrOffset

TInt32

iUserToKernAddrOffset

[private]

the offset from a User space address to the corresponding address in the Kernel space in the shared memory chunk. May also be negative

RWlanCircularBuffer< KVideoTxQueueLen > iVideoTxQueue

RWlanCircularBuffer< KVideoTxQueueLen >

iVideoTxQueue

[private]

Tx Queue for Video priority frames

RWlanCircularBuffer< KVoiceTxQueueLen > iVoiceTxQueue

RWlanCircularBuffer< KVoiceTxQueueLen >

iVoiceTxQueue

[private]

Tx Queue for Voice priority frames