accessoryservices/remotecontrolfw/client/intermediate/public/remconinterfaceif.h
changeset 0 4e1aa6a622a0
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/accessoryservices/remotecontrolfw/client/intermediate/public/remconinterfaceif.h	Tue Feb 02 00:53:00 2010 +0200
@@ -0,0 +1,114 @@
+// 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 "Eclipse Public License v1.0"
+// which accompanies this distribution, and is available
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+/**
+ @file
+ @publishedAll
+ @released
+*/
+
+#ifndef REMCONINTERFACEIF_H
+#define REMCONINTERFACEIF_H
+
+#include <e32base.h>
+#include <remcon/messagetype.h>
+
+class TRemConAddress;
+
+/** 
+The UID of the interface between the interface selector and the outer layer 
+API. Currently this consists of a single 'new message' method. If in future it 
+changes (more methods are added) then a new M class and UID can be defined. 
+New outer layer APIs can implement that M class and be used by the interface 
+selector, without breaking existing outer layer APIs which still only 
+implement this version of the interface.
+*/
+const TInt KRemConInterfaceIf1 = 0x1020D409;
+
+/**
+Mixin for outer layer interfaces to be notified of incoming messages (commands and responses).
+Having received a command, the client is obliged to send a response.
+A client can only have one send outstanding at any time.
+If commands come in quickly, the client is responsible for queueing its responses to them.
+Note that each command delivered to a target involves memory allocated in the server’s heap,
+which is only released on client closure or when a response is sent.
+*/
+class MRemConInterfaceIf
+	{
+public: 
+	/**
+	Called when a message comes in for this interface.
+	@param aOperationId The interface-specific operation id.
+	@param aData Any operation-specific data.
+	*/
+	virtual void MrcibNewMessage(TUint aOperationId, const TDesC8& aData) = 0;
+	};
+	
+	
+/** 
+The UID of the interface between the interface selector and the outer layer 
+API. Currently this consists of a single 'new message' method. If in future it 
+changes (more methods are added) then a new M class and UID can be defined. 
+New outer layer APIs can implement that M class and be used by the interface 
+selector, without breaking existing outer layer APIs which still only 
+implement this version of the interface.
+*/
+const TInt KRemConInterfaceIf2 = 0x10285A37;
+		
+/**
+Mixin for outer layer interfaces to be notified of incoming messages. 
+*/
+class MRemConInterfaceIf2
+	{
+public: 
+	/**
+	Called when a message comes in for this interface.
+	@param aOperationId The interface-specific operation id.
+	@param aData Any operation-specific data.
+	@param aMessageSubType The message subtype.
+	*/
+	virtual void MrcibNewMessage(TUint aOperationId, const TDesC8& aData, TRemConMessageSubType aMessageSubType) = 0;
+	};
+
+	
+/** 
+The UID of the interface between the interface selector and the outer layer 
+API. Currently this consists of a single 'new message' method. If in future it 
+changes (more methods are added) then a new M class and UID can be defined. 
+New outer layer APIs can implement that M class and be used by the interface 
+selector, without breaking existing outer layer APIs which still only 
+implement this version of the interface.
+*/
+const TInt KRemConInterfaceIf3 = 0x10285DF1;
+		
+/**
+Mixin for outer layer interfaces to be notified of incoming messages. 
+*/
+class MRemConInterfaceIf3
+	{
+public: 
+	/**
+	Called when a message comes in for this interface.
+	@param aOperationId The interface-specific operation id.
+	@param aData Any operation-specific data.
+	@param aMessageSubType The message subtype.
+	@param aRemoteAddr The address of the remote that sent the message 
+	(includes the bearer UID).
+	*/
+	virtual void MrcibNewMessage(TUint aOperationId, const TDesC8& aData, TRemConMessageSubType aMessageSubType, const TRemConAddress& aRemoteAddr) = 0;
+	};
+
+	
+#endif // REMCONINTERFACEIF_H