FCL/sf/os/security: contentmgmt/contentaccessfwfordrm/inc/StreamablePtrArray.h@2c201484c85f (annotated)

0 2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	1	/*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	2	* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	3	* All rights reserved.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	4	* This component and the accompanying materials are made available
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	5	* under the terms of the License "Eclipse Public License v1.0"
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	6	* which accompanies this distribution, and is available
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	7	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	8	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	9	* Initial Contributors:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	10	* Nokia Corporation - initial contribution.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	11	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	12	* Contributors:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	13	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	14	* Description:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	15	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	16	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	17
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	18
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	19
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	20
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	21	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	22	@file
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	23	@publishedPartner
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	24	@released
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	25	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	26
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	27
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	28	#ifndef __STREAMABLEPTRARRAY_H__
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	29	#define __STREAMABLEPTRARRAY_H__
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	30
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	31	#include <e32base.h>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	32	#include <s32strm.h>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	33
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	34	namespace ContentAccess
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	35	{
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	36	/** Template class used to store an array of pointers that can also write itself to a stream
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	37
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	38	The RStreamablePtrArray owns all the elements contained within it. The close
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	39	function must be called before the RStreamablePtrArray goes out of scope.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	40
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	41	The close function frees all resources and deletes all array elements
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	42
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	43	The array can be streamed using the InternalizeL() and ExternalizeL() functions
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	44
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	45	@publishedPartner
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	46	@released
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	47	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	48	template <class T>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	49	class RStreamablePtrArray
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	50	{
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	51	public:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	52	/** Constructor */
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	53	inline RStreamablePtrArray();
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	54
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	55	/** Free all resources held by the array
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	56
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	57	Calls ResetAndDestroy();
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	58	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	59	inline void Close();
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	60
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	61	/** Append an element to the array
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	62
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	63	Ownership of the pointer is transferred to the array
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	64	@param aElement The item to add to the array
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	65	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	66	inline void AppendL(T* aElement);
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	67
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	68	/** Count the number of objects in the array */
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	69	inline TInt Count() const;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	70
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	71	/** Return a pointer to an element at a given index in the array
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	72
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	73	@param aIndex The zero based index in the array, must be less than Count()
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	74	@return A pointer to the object stored in the array
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	75	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	76	inline T* operator [] (TInt aIndex) const;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	77
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	78	/** Delete all elements in the array*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	79	inline void ResetAndDestroy();
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	80
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	81	/** Add array elements from a stream */
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	82	inline void InternalizeL(RReadStream& aStream);
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	83
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	84	/** Write the entire array to a stream */
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	85	inline void ExternalizeL(RWriteStream& aStream) const;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	86
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	87	/** Remove an element from the array.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	88	Note that the function does not delete the pointer.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	89	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	90	inline void RemoveL(TInt aIndex);
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	91
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	92	private:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	93	RPointerArray <T> iArray;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	94	};
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	95	}
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	96
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	97	// include inline function definitions
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	98	#include <caf/streamableptrarray.inl>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	99
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	100	#endif

author	Santosh Patil <santosh.v.patil@nokia.com>
	Wed, 08 Jul 2009 11:25:26 +0100
changeset 0	2c201484c85f
child 8	35751d3474b7
permissions	-rw-r--r--