Symbian^3 Application Developer Library >

RMBuf Class Reference

class RMBuf : public RCommsBuf

RMBuf is a thin wrapper over RCommsBuf providing compatibility for existing code.

Inherits from

Public Member Functions
void AdjustEnd ( TInt )
void AdjustStart ( TInt )
IMPORT_C RMBuf * Alloc ()
IMPORT_C RMBuf * Alloc ( TUint )
IMPORT_C RMBuf * Alloc ( RMBufAllocator &)
IMPORT_C RMBuf * Alloc ( TUint , RMBufAllocator &)
IMPORT_C RMBuf * AllocL ()
IMPORT_C RMBuf * AllocL ( TUint )
IMPORT_C RMBuf * AllocL ( RMBufAllocator &)
IMPORT_C RMBuf * AllocL ( TUint , RMBufAllocator &)
TUint8 * Buffer ()
const TUint8 * Buffer ()
TInt End ()
TUint8 * EndPtr ()
const TUint8 * EndPtr ()
void FillZ ()
IMPORT_C void Free ()
TUint8 Get ( TInt )
IMPORT_C void Init ( TMBufType )
IMPORT_C RMBuf * Last ()
TInt Length ()
void Link ( RMBuf *)
void LinkPkt ( RMBufChain &)
RMBuf * Next ()
const RMBuf * Next ()
RMBufChain & NextPkt ()
const RMBufChain & NextPkt ()
TInt Offset ()
TUint8 * Ptr ()
const TUint8 * Ptr ()
void Put ( TUint8 , TInt )
void SetData ( TInt , TInt )
void SetLength ( TInt )
void SetOffset ( TInt )
void SetType ( TMBufType )
TInt Size ()
TMBufType Type ()
void Unlink ()
void UnlinkPkt ()
Private Member Functions
RMBuf ()
RMBuf (const RMBuf &)
IMPORT_C TUint8 __DbgGet ( TInt )
IMPORT_C void __DbgPut ( TUint8 , TInt )
void operator delete ( TAny *, TUint8 *)
TAny * operator new ( TUint , TUint8 *)
RMBuf & operator= (const RMBuf &)
Inherited Functions
RCommsBuf::AdjustDataEnd(TInt)
RCommsBuf::AdjustDataStart(TInt)
RCommsBuf::Alloc(TUint,TCommsBufAllocator &)
RCommsBuf::Append(const TDesC8 &)
RCommsBuf::AppendLimit()const
RCommsBuf::DesC8()const
RCommsBuf::Prepend(const TDesC8 &)
RCommsBuf::PrependLimit()const
RCommsBuf::RCommsBuf()
RCommsBuf::RCommsBuf(TInt,TUint,TInt)
RCommsBuf::RCommsBuf(TInt,TUint,TInt,TInt)
RCommsBuf::RawBase()
RCommsBuf::RawBase()const
RCommsBuf::RawSize()const
RCommsBuf::Read(TDes8 &,TInt)const
RCommsBuf::Reset()
RCommsBuf::SetDataRange(TInt,TInt)
RCommsBuf::SetNext(RCommsBuf *)
RCommsBuf::Write(const TDesC8 &,TInt)
RCommsBuf::operator[](TInt)
RCommsBuf::operator[](TInt)const
Inherited Attributes
RCommsBuf::iCommsBufMetaData

Constructor & Destructor Documentation

RMBuf()

RMBuf ( ) [private]

RMBuf(const RMBuf &)

RMBuf ( const RMBuf & ) [private]

Parameters

const RMBuf &

Member Functions Documentation

AdjustEnd(TInt)

void AdjustEnd ( TInt aLen ) [inline]

Parameters

TInt aLen

AdjustStart(TInt)

void AdjustStart ( TInt aLen ) [inline]

Parameters

TInt aLen

Alloc()

IMPORT_C RMBuf * Alloc ( ) [static]

Allocates memory for a RMBuf object - the size of the mbuf to be allocate will depend on the available pool chains, eg. 128, 256 etc...

Alloc(TUint)

IMPORT_C RMBuf * Alloc ( TUint aSize ) [static]

Allocates memory for a RMBuf object. Multiple RMBuf's maybe allocated internally if the requested size is greater than the maximum size of the RMBuf on the available pool chains.

Parameters

TUint aSize The requested size for the RMBuf

Alloc(RMBufAllocator &)

IMPORT_C RMBuf * Alloc ( RMBufAllocator & aRMBufAllocator ) [static]

Allocates memory for a RMBuf object using a given RMBufAllocator . Multiple RMBuf's maybe allocated internally if the requested size is greater than the maximum size of the RMBuf on the available pool chains.

RMBufAllocator

Parameters

RMBufAllocator & aRMBufAllocator RMBufAllocator object

Alloc(TUint, RMBufAllocator &)

IMPORT_C RMBuf * Alloc ( TUint aSize,
RMBufAllocator & aRMBufAllocator
) [static]

Allocates memory for a RMBuf object using a given RMBufAllocator and a given size. Multiple RMBuf's maybe allocated internally if the requested size is greater than the maximum size of the RMBuf on the available pool chains.

RMBufAllocator

Parameters

TUint aSize The requested size for the RMBuf
RMBufAllocator & aRMBufAllocator RMBufAllocator object

AllocL()

IMPORT_C RMBuf * AllocL ( ) [static]

Allocates memory for a RMBuf object - the size of the mbuf to be allocate will depend on the available pool chains, eg. 128, 256 etc...

leave
KErrNoMemory On allocation failure

AllocL(TUint)

IMPORT_C RMBuf * AllocL ( TUint aSize ) [static]

Allocates memory for a RMBuf object. Multiple RMBuf's maybe allocated internally if the requested size is greater than the maximum size of the RMBuf on the available pool chains.

leave
KErrNoMemory On allocation failure

Parameters

TUint aSize The requested size for the RMBuf

AllocL(RMBufAllocator &)

IMPORT_C RMBuf * AllocL ( RMBufAllocator & aRMBufAllocator ) [static]

Allocates memory for a RMBuf object using a given RMBufAllocator . Multiple RMBuf's maybe allocated internally if the requested size is greater than the maximum size of the RMBuf on the available pool chains.

RMBufAllocator
leave
KErrNoMemory On allocation failure

Parameters

RMBufAllocator & aRMBufAllocator RMBufAllocator object

AllocL(TUint, RMBufAllocator &)

IMPORT_C RMBuf * AllocL ( TUint aSize,
RMBufAllocator & aRMBufAllocator
) [static]

Allocates memory for a RMBuf object using a given RMBufAllocator and a given size. Multiple RMBuf's maybe allocated internally if the requested size is greater than the maximum size of the RMBuf on the available pool chains.

RMBufAllocator
leave
KErrNoMemory On allocation failure

Parameters

TUint aSize The requested size for the RMBuf
RMBufAllocator & aRMBufAllocator RMBufAllocator object

Buffer()

TUint8 * Buffer ( ) [inline]

Buffer()

const TUint8 * Buffer ( ) const [inline]

End()

TInt End ( ) const [inline]

EndPtr()

TUint8 * EndPtr ( ) [inline]

EndPtr()

const TUint8 * EndPtr ( ) const [inline]

FillZ()

void FillZ ( ) [inline]

Free()

IMPORT_C void Free ( )

Get(TInt)

TUint8 Get ( TInt aOffset = 0 ) const [inline]

Parameters

TInt aOffset = 0

Init(TMBufType)

IMPORT_C void Init ( TMBufType aType )

Initialises MBuf's members

Parameters

TMBufType aType A MBuf type

Last()

IMPORT_C RMBuf * Last ( )

Last MBuf in a chain. Not really supposed to be in RMBuf , but putting it here allows the code to be shared by RMBufChain and RMBufQ

Length()

TInt Length ( ) const [inline]

Returns the length of the RCommsBuf data

Link(RMBuf *)

void Link ( RMBuf * aBuf ) [inline]

Parameters

RMBuf * aBuf

LinkPkt(RMBufChain &)

void LinkPkt ( RMBufChain & aChain ) [inline]

Parameters

RMBufChain & aChain

Next()

RMBuf * Next ( ) [inline]

Next()

const RMBuf * Next ( ) const [inline]

NextPkt()

RMBufChain & NextPkt ( ) [inline]

NextPkt()

const RMBufChain & NextPkt ( ) const [inline]

Offset()

TInt Offset ( ) const [inline]

Returns the offset of the RCommsBuf data

Ptr()

TUint8 * Ptr ( ) [inline]

Returns a pointer to the actual location of the data start.

RCommsBuf::RawBase

Ptr()

const TUint8 * Ptr ( ) const [inline]

Returns a const pointer to the actual location of the data start. Actual data start location may differ from the start of the data

RCommsBuf::RawBase

Put(TUint8, TInt)

void Put ( TUint8 aVal,
TInt aOffset = 0
) [inline]

Parameters

TUint8 aVal
TInt aOffset = 0

SetData(TInt, TInt)

void SetData ( TInt aOffset,
TInt aLength
) [inline]

Parameters

TInt aOffset
TInt aLength

SetLength(TInt)

void SetLength ( TInt aLength ) [inline]

Parameters

TInt aLength

SetOffset(TInt)

void SetOffset ( TInt aOffset ) [inline]

Sets the RCommsBuf data offset

Parameters

TInt aOffset An offset

SetType(TMBufType)

void SetType ( TMBufType aType ) [inline]

Parameters

TMBufType aType

Size()

TInt Size ( ) const [inline]

Type()

TMBufType Type ( ) const [inline]

Unlink()

void Unlink ( ) [inline]

UnlinkPkt()

void UnlinkPkt ( ) [inline]

__DbgGet(TInt)

IMPORT_C TUint8 __DbgGet ( TInt aOffset = 0 ) const [private]

Parameters

TInt aOffset = 0

__DbgPut(TUint8, TInt)

IMPORT_C void __DbgPut ( TUint8 aVal,
TInt aOffset = 0
) [private]

Parameters

TUint8 aVal
TInt aOffset = 0

operator delete(TAny *, TUint8 *)

void operator delete ( TAny * aPtr,
TUint8 *
) [private]

Parameters

TAny * aPtr
TUint8 *

operator new(TUint, TUint8 *)

TAny * operator new ( TUint aSize,
TUint8 * aPtr
) [private]

Parameters

TUint aSize
TUint8 * aPtr

operator=(const RMBuf &)

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

Parameters

const RMBuf &

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.