sl@0: // Copyright (c) 2007-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: // ULogger plug-in base class
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0:  @publishedPartner
sl@0:  @prototype
sl@0: */
sl@0: 
sl@0: #ifndef ULOGGERPLUGIN_H
sl@0: #define ULOGGERPLUGIN_H
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <ecom/implementationinformation.h>
sl@0: #include <ecom/ecomresolverparams.h>
sl@0: #include <ecom/ecom.h>
sl@0: 
sl@0: namespace Ulogger
sl@0: {
sl@0: //! Base class for all ULogger plug-ins.
sl@0: /*!
sl@0: ULogger is extensible through a plug-in framework that uses ECom for plug-in
sl@0: discovery. Deriving from this class means that all the ECom-specific logic is
sl@0: already provided for the plug-in implementer, out-of-the-box, leaving the
sl@0: plug-in code to deal with the domain-specific logic that the plug-in is supposed
sl@0: to implement only.
sl@0: 
sl@0: Among the plug-in types that are currently supported are output plug-ins (see
sl@0: class ULogger::MOutputPlugin in uloggeroutputplugin.h) and input plug-ins (see
sl@0: class ULogger::MInputPlugin in uloggerinputplugin.h).
sl@0: 
sl@0: Plug-ins must derive from this class in order to be compatible with ULogger.
sl@0: */
sl@0: class CPlugin : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 	Enum to signify plug-in interface types. Used by each specific plug-in
sl@0: 	interface (M-class) to identify itself as being of a particular type.
sl@0: 	*/
sl@0: 	enum TPluginInterface
sl@0: 	{
sl@0: 	EOutput,//!< output plug-in interface type
sl@0: 	EInput  //!< input plug-in interface type
sl@0: 	};
sl@0: 
sl@0: public:
sl@0: 	/**
sl@0: 	Creates a CPlugin instance of the specified type and returns a pointer to
sl@0: 	it. The type is specified as the name of the ECom plug-in DLL (without the
sl@0: 	dll	extension).
sl@0: 
sl@0: 	@param aCue a descriptor containing the name of the plug-in to be created
sl@0: 	@return A pointer to the newly created CPlugin object.
sl@0: 	*/
sl@0: 	static CPlugin* NewL(const TDesC8& aCue);
sl@0: 
sl@0: 	/**
sl@0: 	Virtual destructor.
sl@0: 	*/
sl@0: 	virtual ~CPlugin();
sl@0: 
sl@0: 	/**
sl@0: 	Return pointer to requested interface. 
sl@0: 	If plug-in implements multiple interfaces, it should return pointer to
sl@0: 	proper interface trough this method.
sl@0: 
sl@0: 	@param aInterfaceId Number of requested interface.
sl@0: 	@return Pointer to requested interface or NULL if requested interface is not
sl@0: 	        supported.
sl@0: 	*/
sl@0: 	virtual TAny* GetInterfaceL(TPluginInterface aInterfaceId) = 0;
sl@0: 
sl@0: private:
sl@0: 	TUid iDtor_ID_Key;		 
sl@0: 	};
sl@0: 
sl@0: } //end of namespace
sl@0: 
sl@0: #include "uloggerplugin.inl" // Our own base implementations for ECOM
sl@0: 
sl@0: #endif /* ULOGGERPLUGIN_H */