os/mm/mmlibs/mmfw/src/ControllerFramework/mmfcontrollerheap.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/mmlibs/mmfw/src/ControllerFramework/mmfcontrollerheap.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,55 @@
     1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +
    1.20 +#ifndef __MMFCONTROLLERHEAP_H__
    1.21 +#define __MMFCONTROLLERHEAP_H__
    1.22 +
    1.23 +#include <e32base.h>
    1.24 +
    1.25 +/*
    1.26 +To prevent an MMF client with multiple controllers running out of chunks, all
    1.27 +controllers for the same client are made to use the same heap.
    1.28 +  
    1.29 +This class controls that shared heap.
    1.30 +  
    1.31 +The iRefCount tracks the number of controllers using the heap.
    1.32 +  
    1.33 +When the client requests a pointer to the heap - RegisterHeap() - it is 
    1.34 +assumed that a controller will be created using it, so the refcount
    1.35 +is automatically incremented. When the controller terminates, the client 
    1.36 +unregisters - ReleaseHeap() - and the ref count is decreased.
    1.37 +When the refcount is zero (no controller threads left) the client deletes 
    1.38 +this class.
    1.39 +*/
    1.40 +
    1.41 +const TInt KMMFControllerSharedHeapMaxSize = 0x1000000;//16MB
    1.42 +
    1.43 +NONSHARABLE_CLASS(CMMFControllerHeap) : public CBase
    1.44 +	{
    1.45 +public:
    1.46 +	static CMMFControllerHeap* NewL();
    1.47 +	~CMMFControllerHeap();
    1.48 +
    1.49 +	RHeap* RegisterHeap();
    1.50 +	TInt ReleaseHeap();
    1.51 +private:	
    1.52 +	void ConstructL();
    1.53 +private:
    1.54 +	RHeap*	iHeap;
    1.55 +	TInt	iRefCount;
    1.56 +	};
    1.57 +
    1.58 +#endif