sl@0: // Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #ifndef __SQLSRVOBJCONTAINER_H__
sl@0: #define __SQLSRVOBJCONTAINER_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include "SqlAssert.h"
sl@0: 
sl@0: /**
sl@0: Indexed storage for server sdide objects.
sl@0: 
sl@0: RDbObjContainer container is used for storing IPC stream handles (HIpcStream) and 
sl@0: statement handles (CSqlSrvStatement).
sl@0: 
sl@0: Behaviour when the container is destroyed:
sl@0:  - all objects inside the container are destroyed too;
sl@0:  
sl@0: Behaviour when the an object is removed from the container:
sl@0:  - the container will destroy the object;
sl@0: 
sl@0: Behaviour when the an object is added to the container:
sl@0:  - the container stores the object <by_ref>, not <by_val>;
sl@0: 
sl@0: Behaviour when a look up is performed in the container for an object:
sl@0:  - a pointer to the object is returned or NULL if there is no object;
sl@0: 
sl@0: @see CSqlSrvStatement
sl@0: @see HIpcStream
sl@0: @see RDbObjContainer::Close()
sl@0: @see RDbObjContainer::AllocL()
sl@0: @see RDbObjContainer::Add()
sl@0: @see RDbObjContainer::Remove()
sl@0: @see RDbObjContainer::Find()
sl@0: @see RDbObjContainer::Count()
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: template <class T> class RDbObjContainer
sl@0: 	{
sl@0: public:
sl@0: 	RDbObjContainer();
sl@0: 	void Close();
sl@0: 	void AllocL();
sl@0: 	TInt Add(T* aObj);
sl@0: 	void Remove(TInt aHandle);
sl@0: 	T* Find(TInt aHandle) const;
sl@0: 	TInt Count() const;
sl@0: 
sl@0: private:	
sl@0: 	TInt MakeHandle(TInt aIndex) const;
sl@0: 	TInt MakeIndex(TInt aHandle) const;
sl@0: 	
sl@0: private:	
sl@0: 	struct TEntry
sl@0: 		{
sl@0: 		T*		iObj;
sl@0: 		TInt	iNext;
sl@0: 		};
sl@0: 	enum {KGranularity = 16};
sl@0: 	//KMaxSize value depends on how many bits are used for handles - see
sl@0: 	//KStmtHandleMask and KStreamHandleMask in SqlUtil.h file.
sl@0: 	enum {KMaxSize = 0x7FF};
sl@0: 	TEntry*	iEntries;
sl@0: 	TInt	iSize;
sl@0: 	TInt 	iFree;
sl@0: 	};
sl@0: 
sl@0: #include "SqlSrvObjContainer.inl"
sl@0: 
sl@0: #endif//__SQLSRVOBJCONTAINER_H__