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