williamr@2: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  @file
williamr@2:  @publishedPartner
williamr@2:  @released
williamr@2: */
williamr@2: 
williamr@2: #ifndef REMCONINTERFACEBASE_H
williamr@2: #define REMCONINTERFACEBASE_H
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <remcon/clienttype.h>
williamr@2: 
williamr@2: class CRemConInterfaceSelector;
williamr@2: 
williamr@2: /**
williamr@2: Base class for outer layer APIs. 
williamr@2: */
williamr@2: class CRemConInterfaceBase : public CBase
williamr@2: 	{
williamr@2: public: 
williamr@2: 	/** Destructor */
williamr@2: 	IMPORT_C ~CRemConInterfaceBase();
williamr@2: 
williamr@2: public: // called by the ultimate client
williamr@2: 	/** 
williamr@2: 	Cancels the currently outstanding asynchronous send request. 
williamr@2: 	@return KErrNone.
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt Cancel();
williamr@2: 
williamr@2: public: // called by the interface selector
williamr@2: 	/**
williamr@2: 	Called by the interface selector to get a pointer to an object which 
williamr@2: 	implements the interface API with UID aUid. This is a mechanism for 
williamr@2: 	allowing future change to the interface API without breaking BC in 
williamr@2: 	existing (non-updated) interfaces.
williamr@2: 	*/
williamr@2: 	virtual TAny* GetInterfaceIf(TUid aUid) = 0;
williamr@2: 
williamr@2: 	/** 
williamr@2: 	Accessor for the interface's UID. 
williamr@2: 	@return The interface's UID.
williamr@2: 	*/
williamr@2: 	TUid InterfaceUid() const;
williamr@2: 
williamr@2: 	/** 
williamr@2: 	Accessor for the maximum length of operation-specific data in this 
williamr@2: 	interface. 
williamr@2: 	@return The size in bytes of a buffer needed to hold the largest single 
williamr@2: 	payload of operation-associated data in this interface.
williamr@2: 	*/
williamr@2: 	TUint MaxLength() const;
williamr@2: 
williamr@2: 	/**
williamr@2: 	Accessor for the type of the interface- either controller or target.
williamr@2: 	@return The interface type.
williamr@2: 	*/
williamr@2: 	TRemConClientType Type() const;
williamr@2: 
williamr@2: protected:
williamr@2: 	/** 
williamr@2: 	Constructor.
williamr@2: 	@param aInterfaceUid The UID of the interface.
williamr@2: 	@param aMaxLength The maximum length of any operation-specific data in the 
williamr@2: 	interface being registered.
williamr@2: 	@param aInterfaceSelector The interface selector.
williamr@2: 	*/
williamr@2: 	IMPORT_C CRemConInterfaceBase(TUid aInterfaceUid, 
williamr@2: 		TUint aMaxLength, 
williamr@2: 		CRemConInterfaceSelector& aInterfaceSelector,
williamr@2: 		TRemConClientType aType);
williamr@2: 
williamr@2: 	/** Must be called by concrete types at construction time. Registers the 
williamr@2: 	interface with the interface selector. */
williamr@2: 	IMPORT_C void BaseConstructL();
williamr@2: 
williamr@2: 	/** 
williamr@2: 	Accessor for the interface selector. 
williamr@2: 	@return The interface selector.
williamr@2: 	*/
williamr@2: 	IMPORT_C CRemConInterfaceSelector& InterfaceSelector();
williamr@2: 
williamr@2: private: // owned
williamr@2: 	/** The UID of the concrete (derived) interface. */
williamr@2: 	TUid iInterfaceUid; 
williamr@2: 
williamr@2: 	/** Max length of operation-specific data in this interface. */
williamr@2: 	TUint iMaxLength; 
williamr@2: 
williamr@2: 	/** The type of the interface- controller or target. */
williamr@2: 	const TRemConClientType iType;
williamr@2: 
williamr@2: 	/** 
williamr@2: 	Pad for BC-friendly future change.
williamr@2: 	*/
williamr@2: 	TAny* iPad;
williamr@2: 
williamr@2: private: // unowned
williamr@2: 	CRemConInterfaceSelector& iInterfaceSelector;
williamr@2: 	};
williamr@2: 
williamr@2: #endif // REMCONINTERFACEBASE_H