Symbian^3 Application Developer Library >

TDataBuffer Class Reference

class TDataBuffer

Meta header for Rx and Tx frames

Since
S60 v3.1
Public Member Functions
TInt AppendBuffer (const TUint8 *, TUint32 )
TFrameType FrameType ()
void FrameType ( TFrameType )
const TUint8 * GetBuffer ()
TUint8 * GetBuffer ()
TUint32 GetLength ()
void KeClearFlags ( TFlag )
TFlag KeFlags ()
TUint8 * KeGetBufferStart ()
void KeSetFlags ( TFlag )
TUint8 Rcpi ()
void SetUserPriority ( TUint8 )
TUint8 UserPriority ()
Private Member Functions
TDataBuffer ()
TDataBuffer (const TDataBuffer &)
void AppendBuffer (const TUint8 *, TUint32 , TUint32 )
void IncrementLength ( TUint32 )
void SetBufLength ( TUint16 )
void SetDestinationAddress (const TMacAddress &)
void SetLength ( TUint32 )
TDataBuffer & operator= (const TDataBuffer &)
Public Member Type Definitions
typedef TUint32 TFlag
typedef TUint32 TFrameType
Public Attributes
const TFlag KDontReleaseBuffer
const TFrameType KDot11Frame
const TFrameType KEthernetFrame
const TFrameType KEthernetTestFrame
const TFrameType KFrameTypeMax
const TFrameType KSnapFrame
const TFlag KTxFrameMustNotBeEncrypted
Private Attributes
TUint16 iBufLength
TInt32 iBufferOffsetAddr
TMacAddress iDestinationAddress
TFlag iFlags
TFrameType iFrameType
TUint32 iLength
TUint32 iOffsetToFrameBeginning
TUint32 iRcpi
TUint32 iUp

Constructor & Destructor Documentation

TDataBuffer()

TDataBuffer ( ) [private, inline]

Default Ctor

TDataBuffer(const TDataBuffer &)

TDataBuffer ( const TDataBuffer & ) [private]

Prohibit copy constructor

Parameters

const TDataBuffer &

Member Functions Documentation

AppendBuffer(const TUint8 *, TUint32)

TInt AppendBuffer ( const TUint8 * aData,
TUint32 aLength
) [inline]

Appends data to Tx Buffer

Parameters

const TUint8 * aData data to be apended
TUint32 aLength length of data in bytes

AppendBuffer(const TUint8 *, TUint32, TUint32)

void AppendBuffer ( const TUint8 * aData,
TUint32 aLength,
TUint32 aOffsetToFrameBeginning
) [private, inline]

Appends data to Buffer

Parameters

const TUint8 * aData data to be apended
TUint32 aLength length of data in BYTEs
TUint32 aOffsetToFrameBeginning Amount of empty space to leave in the beginning of the buffer, i.e. before the frame beginning

FrameType()

TFrameType FrameType ( ) const [inline]

Gets the frame type in the buffer

Since
S60 3.1

FrameType(TFrameType)

void FrameType ( TFrameType aFrameType ) [inline]

Sets the frame type in the buffer

Since
S60 3.1

Parameters

TFrameType aFrameType

GetBuffer()

const TUint8 * GetBuffer ( ) const [inline]

Gets the begin of the buffer

Since
S60 3.1

GetBuffer()

TUint8 * GetBuffer ( ) [inline]

Gets the beginning of the buffer

Since
S60 3.1

GetLength()

TUint32 GetLength ( ) const [inline]

Gets length of the data in the buffer

Since
S60 3.1

IncrementLength(TUint32)

void IncrementLength ( TUint32 aValue ) [private, inline]

Adds a value to the length field

Parameters

TUint32 aValue length to be set

KeClearFlags(TFlag)

void KeClearFlags ( TFlag aFlags ) [inline]

Clears the specified flag(s) NOTE: to be used only by the device driver

Parameters

TFlag aFlags

KeFlags()

TFlag KeFlags ( ) const [inline]

Returns the flags set in this object NOTE: to be used only by the device driver

KeGetBufferStart()

TUint8 * KeGetBufferStart ( ) const [inline]

Gets the beginning of the data buffer NOTE: to be used only by the device driver

KeSetFlags(TFlag)

void KeSetFlags ( TFlag aFlags ) [inline]

Sets the specified flag(s) NOTE: to be used only by the device driver

Parameters

TFlag aFlags

Rcpi()

TUint8 Rcpi ( ) const [inline]

Gets the RCPI value of a received frame

Since
S60 3.2

SetBufLength(TUint16)

void SetBufLength ( TUint16 aBufLength ) [private, inline]

Sets the length of the attached data buffer

Parameters

TUint16 aBufLength length to be set

SetDestinationAddress(const TMacAddress &)

void SetDestinationAddress ( const TMacAddress & aDa ) [private, inline]

Sets the Destination Address of the frame to be transmitted

Parameters

const TMacAddress & aDa Destination Address to be set

SetLength(TUint32)

void SetLength ( TUint32 aLength ) [private, inline]

Sets the length field

Parameters

TUint32 aLength length to be set

SetUserPriority(TUint8)

void SetUserPriority ( TUint8 aUp ) [inline]

Sets the 802.1D User Priority of the frame

Since
S60 3.2

Parameters

TUint8 aUp UP value to be set

UserPriority()

TUint8 UserPriority ( ) const [inline]

Gets the 802.1D User Priority of the frame

Since
S60 3.2

operator=(const TDataBuffer &)

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

Prohibit assigment operator

Parameters

const TDataBuffer &

Member Type Definitions Documentation

Typedef TFlag

typedef TUint32 TFlag

Typedef TFrameType

typedef TUint32 TFrameType

Member Data Documentation

const TFlag KDontReleaseBuffer

const TFlag KDontReleaseBuffer [static]

flag indicating that the associated Rx buffer shall not be released when releasing this meta header

const TFrameType KDot11Frame

const TFrameType KDot11Frame [static]

complete 802.11 frame

const TFrameType KEthernetFrame

const TFrameType KEthernetFrame [static]

ethernet II frame

const TFrameType KEthernetTestFrame

const TFrameType KEthernetTestFrame [static]

ethernet II frame used to test an AP

const TFrameType KFrameTypeMax

const TFrameType KFrameTypeMax [static]

upper bound, so not a real type

const TFrameType KSnapFrame

const TFrameType KSnapFrame [static]

frame beginning with a SNAP header

const TFlag KTxFrameMustNotBeEncrypted

const TFlag KTxFrameMustNotBeEncrypted [static]

flag indicating that the Tx frame in the associated buffer shall not be encrypted even if a valid encryption key existed. If not set, the frame may be encrypted if a valid key exists

TUint16 iBufLength

TUint16 iBufLength [private]

Length of the attached data buffer. Currently used only for Protocol Stack Side client Tx frames

TInt32 iBufferOffsetAddr

TInt32 iBufferOffsetAddr [private]

the offset from the start address of this object to the start address of the data buffer. May be positive or negative.

TMacAddress iDestinationAddress

TMacAddress iDestinationAddress [private]

Destination address of the frame to be transmitted. Used only when the address cannot be determined from the frame content

TFlag iFlags

TFlag iFlags [private]

may contain a combination of the flags defined for this class

TFrameType iFrameType

TFrameType iFrameType [private]

type of the frame in buffer

TUint32 iLength

TUint32 iLength [private]

length of the data in buffer

TUint32 iOffsetToFrameBeginning

TUint32 iOffsetToFrameBeginning [private]

the offset to actual frame beginning within the data buffer

TUint32 iRcpi

TUint32 iRcpi [private]

RCPI of the received frame; range: [0..250] stored as a 32-bit value to keep the length of this object 32-bit aligned

TUint32 iUp

TUint32 iUp [private]

802.1D User Priority of the frame stored as a 32-bit value to keep the length of this object 32-bit aligned

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.