MMPXData Class Reference
Base class for managing data in global heap.
mpxcommon.lib
| Public Member Functions |
|---|
| void | AddClientRef(TUint) |
| void | AddRef(TUint) |
|
TInt
| Append(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &) |
| const TMPXAttribute & | Attribute(TUint, TInt) |
|
TMPXAttributeType
| AttributeType(TUint, TInt) |
|
TUint
| ClientHandle() |
|
TInt
| Count(TUint) |
|
MMPXData * | Data(TUint, TUint) |
|
MMPXData * | Data(TUint, const TDesC8 &) |
|
MMPXData * | Data(TUint, TAny *, TInt) |
|
TUint
| DataHandle(TUint) |
| void | Delete(TUint, TInt) |
| void | HeapMemoryInfoL(TInt &, TInt &) |
|
TInt
| Index(TUint, const TMPXAttribute &) |
|
TInt
| Index(TUint, TInt) |
|
TInt
| Insert(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &, TInt) |
| void | LockHeap(TUint) |
|
MMPXData * | NewL(TUint) |
|
MMPXData * | NewL(TUint, const MMPXData &) |
| void | Release(TUint) |
| void | ReleaseClient(TUint) |
| void | Reset(TUint) |
| void | Set(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &, TInt) |
|
TInt
| SetSupportedIds(TUint, const TArray< TInt > &) |
|
TArray< TInt > | SupportedIds(TUint) |
|
TInt
| Uid(TUint, TInt) |
| void | UnlockHeap(TUint) |
|
TPtrC8
| Value(TUint, TInt) |
Member Functions Documentation
AddClientRef(TUint)
| void | AddClientRef | ( | TUint | aClientHandle | ) | [static] |
To increment the reference count for this client (thread); should be called for every media/media array object that is not contained within another.
Parameters
| TUint aClientHandle | client handle to the global chunk |
AddRef(TUint)
| void | AddRef | ( | TUint | aClientHandle | ) | [pure virtual] |
To increment the reference count on this data.
Parameters
| TUint aClientHandle | client handle to the global chunk |
Append(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &)
Attribute(TUint, TInt)
Parameters
| TUint aClientHandle | client handle to the global chunk |
| TInt aIndex | index of the data item |
AttributeType(TUint, TInt)
Gets object type by index.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| TInt aIndex | index of the data item |
ClientHandle()
|
TUint
| ClientHandle | ( | ) | [static] |
Handle which represents the current client (thread). This should be stored by the client and provided in all methods; zero indicates that it has failed.
Count(TUint)
Returns number of data items.
Parameters
| TUint aClientHandle | client handle to the global chunk |
Data(TUint, TUint)
Obtain the interface of an existing implementation from the handle. This is thread-relative.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| TUint aDataHandle | data handle to the MMPXData implementation. |
Data(TUint, const TDesC8 &)
Obtain the interface from a buffer, or NULL if the buffer does not contain an implementation of the interface.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| const TDesC8 & aData | buffer which contains the object of MMPXData implementation |
Data(TUint, TAny *, TInt)
Obtains the interface from a buffer, or NULL if the buffer does not contain an implementation of the interface.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| TAny * aData | buffer which contains the object of MMPXData implementation |
| TInt aSize | size of the data buffer |
DataHandle(TUint)
|
TUint
| DataHandle | ( | TUint | aClientHandle | ) | [pure virtual] |
Handle to the object implementing this interface; can be used to reference the object.
Parameters
| TUint aClientHandle | client handle to the global chunk |
Delete(TUint, TInt)
| void | Delete | ( | TUint | aClientHandle, |
| | TInt | aIndex |
| | ) | [pure virtual] |
Parameters
| TUint aClientHandle | client handle to the global chunk |
| TInt aIndex | index of the data item |
HeapMemoryInfoL(TInt &, TInt &)
| void | HeapMemoryInfoL | ( | TInt & | aTotal, |
| | TInt & | aUsed |
| | ) | [static] |
Gets the total size and the currently used size of the global heap.
Parameters
| TInt & aTotal | Total size of memory (out parameter) |
| TInt & aUsed | Used size of memory (out parameter) |
Index(TUint, const TMPXAttribute &)
Returns index of the data item with the media attribute.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| const TMPXAttribute & aAttr | media attribute |
Index(TUint, TInt)
Returns index of the data item with aUid.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| TInt aUid | uid of the data item |
Insert(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &, TInt)
LockHeap(TUint)
| void | LockHeap | ( | TUint | aClientHandle | ) | [static] |
Parameters
| TUint aClientHandle | client handle to the global chunk |
NewL(TUint)
Create a new implementation of the MMPXData interface. This is thread- relative.
Parameters
| TUint aClientHandle | client handle to the global chunk |
NewL(TUint, const MMPXData &)
Create a new implementation from an existing MMPXData implementation. This is an duplicate copy of the original. This is thread-relative.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| const MMPXData & aData | existing MMPXData implementation. |
Release(TUint)
| void | Release | ( | TUint | aClientHandle | ) | [pure virtual] |
To decrement the reference count on this data; when zero, the data is deleted.
Parameters
| TUint aClientHandle | client handle to the global chunk |
ReleaseClient(TUint)
| void | ReleaseClient | ( | TUint | aClientHandle | ) | [static] |
To decrement the reference count on this this client (thread).
Parameters
| TUint aClientHandle | client handle to the global chunk |
Reset(TUint)
| void | Reset | ( | TUint | aClientHandle | ) | [pure virtual] |
Parameters
| TUint aClientHandle | client handle to the global chunk |
Set(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &, TInt)
SetSupportedIds(TUint, const TArray< TInt > &)
Sets supported content ids.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| const TArray< TInt > & aSupportedIds | array of supported content ids |
SupportedIds(TUint)
Gets supported content ids.
Parameters
| TUint aClientHandle | client handle to the global chunk |
Uid(TUint, TInt)
Parameters
| TUint aClientHandle | client handle to the global chunk |
| TInt aIndex | index of the data item |
UnlockHeap(TUint)
| void | UnlockHeap | ( | TUint | aClientHandle | ) | [static] |
Parameters
| TUint aClientHandle | client handle to the global chunk |
Value(TUint, TInt)
Gets the data value by index.
Parameters
| TUint aClientHandle | client handle to the global chunk |
| TInt aIndex | index of the data item |
Member Enumerations Documentation
Enum TMPXObjectType
Defines 'markers' that identify objects from their streamed buffers, e.g. if the first 4 bytes of an externalized object constitute the value EMedia, then we assume the it is an externalized media object.
Enumerators
| EMedia = 0x12343219 | |
| EMediaArray = 0x987678ab | |
| EPath = 0x567982fe | |
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.