Symbian^3 Application Developer Library >

RFrameXferBlock Class Reference

class RFrameXferBlock : public RFrameXferBlockBase

Ethernet frame transfer context block between user and kernel space for the Management Client

Inherits from

Public Member Functions
TInt AppendTxDataBuffer (const TUint8 *, TUint32 , TDataBuffer::TFrameType , TUint8 , TBool , const TMacAddress *)
void ClearTxDataBuffer ()
void SetTxDataBufferField ( TLinAddr )
Private Member Functions
RFrameXferBlock ()
RFrameXferBlock (const RFrameXferBlock &)
RFrameXferBlock & operator= (const RFrameXferBlock &)
Inherited Functions
RFrameXferBlockBase::GetNextRxDataBuffer(TDataBuffer *&)
RFrameXferBlockBase::SetRxDataChunkField(TLinAddr)
Private Attributes
TUint32 iTxBufLength
TDataBuffer * iTxDataBuffer
Inherited Attributes
RFrameXferBlockBase::iCurrentRxBuffer
RFrameXferBlockBase::iFirstRxBufferToFree
RFrameXferBlockBase::iNumOfCompleted
RFrameXferBlockBase::iRxCompletedBuffers
RFrameXferBlockBase::iRxDataChunk
RFrameXferBlockBase::iTxOffset

Constructor & Destructor Documentation

RFrameXferBlock()

RFrameXferBlock ( ) [private]

Prohibit default constructor

RFrameXferBlock(const RFrameXferBlock &)

RFrameXferBlock ( const RFrameXferBlock & ) [private]

Prohibit copy constructor

Parameters

const RFrameXferBlock &

Member Functions Documentation

AppendTxDataBuffer(const TUint8 *, TUint32, TDataBuffer::TFrameType, TUint8, TBool, const TMacAddress *)

TInt AppendTxDataBuffer ( const TUint8 * aData,
TUint32 aLength,
TDataBuffer::TFrameType aFrameType =  TDataBuffer::KEthernetFrame ,
TUint8 aUserPriority = 0,
TBool aMustNotBeEncrypted = EFalse,
const TMacAddress * aDestinationAddress = NULL
) [inline]

Appends data to iTxDataBuffer

Since
S60 3.1

Parameters

const TUint8 * aData data to be apended
TUint32 aLength length of data in BYTEs
TDataBuffer::TFrameType aFrameType =  TDataBuffer::KEthernetFrame frame type idenitifier
TUint8 aUserPriority = 0 802.1D User Priority of the frame
TBool aMustNotBeEncrypted = EFalse If EFalse it is allowed to encrypt the frame if a valid encryption key exists. This is the default behavior. If ETrue, the frame must not be encrypted even if a valid encryption key existed.
const TMacAddress * aDestinationAddress = NULL If not NULL, specifies the destination MAC address for the frame to be transmitted

ClearTxDataBuffer()

void ClearTxDataBuffer ( ) [inline]

Clears TxDataBuffer, makes it zero length size

Since
S60 3.1

SetTxDataBufferField(TLinAddr)

void SetTxDataBufferField ( TLinAddr aUserAddr ) [inline]

Set data buffer address

Note! This method is executed in user mode context by the user mode client interface, i.e. not the client itself!
Since
S60 3.1

Parameters

TLinAddr aUserAddr user address of the buffer

operator=(const RFrameXferBlock &)

RFrameXferBlock & operator= ( const RFrameXferBlock & ) [private]

Prohibit assigment operator

Parameters

const RFrameXferBlock &

Member Data Documentation

TUint32 iTxBufLength

TUint32 iTxBufLength [private]

stores the total capacity (length) of the Tx buffer (iTxDataBuffer) associated with this object instance

TDataBuffer * iTxDataBuffer

TDataBuffer * iTxDataBuffer [private]

Tx-data buffer

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.