mmlibs/mmfw/src/ControllerFramework/mmfcontrollerheap.h
author hgs
Thu, 07 Oct 2010 22:34:12 +0100
changeset 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk40
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
// All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
// Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
// Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
// Description:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
#ifndef __MMFCONTROLLERHEAP_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
#define __MMFCONTROLLERHEAP_H__
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
#include <e32base.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
/*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
To prevent an MMF client with multiple controllers running out of chunks, all
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
controllers for the same client are made to use the same heap.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
  
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
This class controls that shared heap.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
  
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
The iRefCount tracks the number of controllers using the heap.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
  
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
When the client requests a pointer to the heap - RegisterHeap() - it is 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
assumed that a controller will be created using it, so the refcount
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
is automatically incremented. When the controller terminates, the client 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
unregisters - ReleaseHeap() - and the ref count is decreased.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
When the refcount is zero (no controller threads left) the client deletes 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
this class.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
const TInt KMMFControllerSharedHeapMaxSize = 0x1000000;//16MB
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
NONSHARABLE_CLASS(CMMFControllerHeap) : public CBase
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
	static CMMFControllerHeap* NewL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
	~CMMFControllerHeap();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
	RHeap* RegisterHeap();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
	TInt ReleaseHeap();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
private:	
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
	void ConstructL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
private:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
	RHeap*	iHeap;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
	TInt	iRefCount;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
#endif