sl@0: // Copyright (c) 1997-2009 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: // This file contains the Interface Definition for the
sl@0: // CExampleInterface class.
sl@0: // 
sl@0: //
sl@0: 
sl@0: #if defined (_MSC_VER) && (_MSC_VER >= 1000)
sl@0: #pragma once
sl@0: #endif
sl@0: #ifndef _INC_INTERFACE_3A1D07A10155_INCLUDED
sl@0: #define _INC_INTERFACE_3A1D07A10155_INCLUDED
sl@0: 
sl@0: #include <e32base.h>
sl@0: 
sl@0: #include <ecom/ecom.h>
sl@0: 
sl@0: /**
sl@0: 	@internalComponent
sl@0: 	@since 7.0
sl@0: 	An example abstract class being representative of the
sl@0: 	concrete class which the client wishes to use.
sl@0: 	It acts as a base, for a real class to provide all the 
sl@0: 	functionality that a client requires.  
sl@0: 	It supplies instantiation & destruction by using
sl@0: 	the ECom framework, and functional services
sl@0: 	by using the methods of the actual class.
sl@0:  */
sl@0: 
sl@0: class CExampleInterface  : public CActive
sl@0: {
sl@0: public:
sl@0: 	// The interface for passing initialisation parameters
sl@0: 	// to the derived class constructor.
sl@0: 	typedef struct _exampleInterfaceInitParams
sl@0: 		{
sl@0: 		TInt integer;
sl@0: 		const TDesC* descriptor;
sl@0: 		} TExampleInterfaceInitParams;
sl@0: 
sl@0: 	//The function which instantiates an object of this type 
sl@0: 	//(eg NewL for a CBase derived object).
sl@0: 	
sl@0: 	static CExampleInterface* NewL();
sl@0: 
sl@0: 	//The function which instantiates an object of this type 
sl@0: 	// using the MatchString as the resolver parameters.
sl@0: 	//(eg NewL for a CBase derived object).
sl@0: 	static CExampleInterface* NewL(const TDesC8& aMatchString);
sl@0: 
sl@0: 	//The function which instantiates an object of this type with the required parameters 
sl@0: 	//(eg NewL for a CBase derived object).
sl@0: 	
sl@0: 	static CExampleInterface* NewL(TInt aIntParameterTest, const TDesC& aDesParameterTest);
sl@0: 	
sl@0: 	//The function which instantiates an object of this type 
sl@0: 	//using ImplementationUid as a resolution parameter.
sl@0: 	//(eg NewL for a CBase derived object).
sl@0: 	static CExampleInterface* NewL2(const TUid aImplementationUid);
sl@0: 	
sl@0: 	//The function which instantiates an object of this type 
sl@0: 	//(eg NewL for a CBase derived object).
sl@0: 	static CExampleInterface* NewL3();
sl@0: 	
sl@0: 	//The function which instantiates an object of this type 
sl@0: 	//(eg NewL for a CBase derived object).
sl@0: 	static CExampleInterface* NewL4();
sl@0: 
sl@0: 	//The functions which instantiate object of this type with extended interface
sl@0: 	static CExampleInterface* NewL5();
sl@0: 	static CExampleInterface* NewL6();
sl@0: 	static CExampleInterface* NewL7();
sl@0: 	static CExampleInterface* NewL8();
sl@0: 
sl@0: 	//Standardised destructor.
sl@0: 	virtual ~CExampleInterface();
sl@0: 
sl@0: 	//Request a list of all available implementations which 
sl@0: 	//satisfy this given interface.
sl@0: 	
sl@0: 	static void ListImplementationsL(RImplInfoPtrArray& aImplInfoArray);
sl@0: 	static void ListAllImplementationsL(RImplInfoPtrArray& aImplInfoArray);
sl@0: 
sl@0: 
sl@0: 	//Pure interface method
sl@0: 	//Representative of a method provided on the interface by 
sl@0: 	//the interface definer.
sl@0: 	
sl@0: 	virtual void DoMethodL() = 0;
sl@0: 
sl@0: 	//Pure interface method
sl@0: 	//Representative of an asynchronous function which 
sl@0: 	//an interface definer could specify.  
sl@0: 	//It allows the client to call the function in the knowledge 
sl@0: 	//that the object will commit suicide when the 
sl@0: 	//function completes.
sl@0: 	
sl@0: 	virtual TInt FireAndForget() = 0;
sl@0: 
sl@0: 	//Pure interface method,
sl@0: 	//Used to cross check the implementation returned by ECOM.
sl@0: 	virtual TUid ImplId() = 0;
sl@0: public:
sl@0: 	// Wrapper methods which get and release the extended interface using 
sl@0: 	// the member iDtor_ID_Key
sl@0: 	TAny* GetExtendedInterfaceL(const TUid& aInterfaceUid);
sl@0: 	void ManuallyReleaseExtendedInterfaceL(const TUid& aInterfaceUid);
sl@0: 
sl@0: protected:
sl@0: 	//Default c'tor
sl@0: 	inline CExampleInterface();
sl@0: 
sl@0: //Attributes
sl@0: private:
sl@0: 	
sl@0: 	TUid iDtor_ID_Key;
sl@0: 
sl@0: 	// Declare the Test bed state accessor as a friend
sl@0: 	friend class TExampleInterface_StateAccessor;
sl@0: 
sl@0: };
sl@0: 
sl@0: // Example extended interface classes
sl@0: class MExampleInterfaceExtended
sl@0: {
sl@0: public:
sl@0: 	//Pure interface method
sl@0: 	//Representative of a method provided on the interface by 
sl@0: 	//the interface definer.
sl@0: 	virtual void DoMethodExtended() = 0;
sl@0: };
sl@0: 
sl@0: class MExampleInterfaceExtended2
sl@0: {
sl@0: public:
sl@0: 	
sl@0: 	//Pure interface method
sl@0: 	//Representative of a method provided on the interface by 
sl@0: 	//the interface definer.
sl@0: 	virtual void DoMethodExtended2() = 0;
sl@0: };
sl@0: #include "Interface.inl"
sl@0: 
sl@0: #endif /* _INC_INTERFACE_3A1D07A10155_INCLUDED */
sl@0: