RWlanCircularBuffer Class Reference

class RWlanCircularBuffer

Wlan LDD Shared Memory FIFO queue for Tx packets.

Member Functions Documentation

DoInit()

void DoInit ( ) [inline]

Initialization. This method acts as a contructor.

GetLength()

TUint GetLength ( ) const [inline]

Returns the number of packets in the queue.

GetPacket()

TDataBuffer * GetPacket ( ) [inline]

This method returns and removes the next packet from the queue.

IsActive(TInt64)

TBool IsActive ( TInt64 aTimeNow ) const [inline]

This method can be used to check if the queue is active.

Parameters

TInt64 aTimeNow Current time as microseconds since midnight, January 1st, 0 AD nominal Gregorian

IsEmpty()

TBool IsEmpty ( ) const [inline]

This method can be used to check if the queue is empty.

IsFull()

TBool IsFull ( ) const [inline]

This method can be used to check if the queue is full.

PeekPacket()

TDataBuffer * PeekPacket ( ) [inline]

Returns the next packet in the queue without removing it from the queue.

PutPacket(TDataBuffer *)

TBool PutPacket ( TDataBuffer * aPacket ) [inline]

This method is used to put a packet to the end of the queue.

Parameters

TDataBuffer * aPacket Pointer to the meta header attached to the packet.

Release()

void Release ( ) [inline]

Release. This method acts as a desctructor.

Member Data Documentation

TInt64 iBecameEmptyAt

TInt64 iBecameEmptyAt [private]

Time stamp (as microseconds since midnight, January 1st, 0 AD nominal Gregorian) when the queue became empty. Valid only if the queue is empty

TDataBuffer * iBuffer

TDataBuffer * iBuffer [private]

Queue as a circular buffer

TUint iGetIndex

TUint iGetIndex [private]

Index of the packet to get next. See GetPacket()

TUint iPacketAmount

TUint iPacketAmount [private]

The number of packets currently in the queue

TUint iPutIndex

TUint iPutIndex [private]

Index where to put the next packet. See PutPacket()

TUint iSize

TUint iSize [private]

The capacity of the queue