remotecontrol/remotecontrolfw/client/intermediate/public/remconinterfaceif.h
author hgs
Wed, 13 Oct 2010 16:20:29 +0300
changeset 51 20ac952a623c
permissions -rw-r--r--
201040_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
20ac952a623c 201040_02
hgs
parents:
diff changeset
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
20ac952a623c 201040_02
hgs
parents:
diff changeset
     2
// All rights reserved.
20ac952a623c 201040_02
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
20ac952a623c 201040_02
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
20ac952a623c 201040_02
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
20ac952a623c 201040_02
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
20ac952a623c 201040_02
hgs
parents:
diff changeset
     7
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
     8
// Initial Contributors:
20ac952a623c 201040_02
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    10
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    11
// Contributors:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    12
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    13
// Description:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    14
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    15
20ac952a623c 201040_02
hgs
parents:
diff changeset
    16
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    17
 @file
20ac952a623c 201040_02
hgs
parents:
diff changeset
    18
 @publishedAll
20ac952a623c 201040_02
hgs
parents:
diff changeset
    19
 @released
20ac952a623c 201040_02
hgs
parents:
diff changeset
    20
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    21
20ac952a623c 201040_02
hgs
parents:
diff changeset
    22
#ifndef REMCONINTERFACEIF_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    23
#define REMCONINTERFACEIF_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    24
20ac952a623c 201040_02
hgs
parents:
diff changeset
    25
#include <e32base.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    26
#include <remcon/messagetype.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    27
20ac952a623c 201040_02
hgs
parents:
diff changeset
    28
class TRemConAddress;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    29
20ac952a623c 201040_02
hgs
parents:
diff changeset
    30
/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    31
The UID of the interface between the interface selector and the outer layer 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    32
API. Currently this consists of a single 'new message' method. If in future it 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    33
changes (more methods are added) then a new M class and UID can be defined. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    34
New outer layer APIs can implement that M class and be used by the interface 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    35
selector, without breaking existing outer layer APIs which still only 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    36
implement this version of the interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    37
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    38
const TInt KRemConInterfaceIf1 = 0x1020D409;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    39
20ac952a623c 201040_02
hgs
parents:
diff changeset
    40
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    41
Mixin for outer layer interfaces to be notified of incoming messages (commands and responses).
20ac952a623c 201040_02
hgs
parents:
diff changeset
    42
Having received a command, the client is obliged to send a response.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    43
A client can only have one send outstanding at any time.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    44
If commands come in quickly, the client is responsible for queueing its responses to them.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    45
Note that each command delivered to a target involves memory allocated in the server’s heap,
20ac952a623c 201040_02
hgs
parents:
diff changeset
    46
which is only released on client closure or when a response is sent.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    47
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    48
class MRemConInterfaceIf
20ac952a623c 201040_02
hgs
parents:
diff changeset
    49
	{
20ac952a623c 201040_02
hgs
parents:
diff changeset
    50
public: 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    51
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    52
	Called when a message comes in for this interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    53
	@param aOperationId The interface-specific operation id.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    54
	@param aData Any operation-specific data.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    55
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    56
	virtual void MrcibNewMessage(TUint aOperationId, const TDesC8& aData) = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    57
	};
20ac952a623c 201040_02
hgs
parents:
diff changeset
    58
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    59
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    60
/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    61
The UID of the interface between the interface selector and the outer layer 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    62
API. Currently this consists of a single 'new message' method. If in future it 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    63
changes (more methods are added) then a new M class and UID can be defined. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    64
New outer layer APIs can implement that M class and be used by the interface 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    65
selector, without breaking existing outer layer APIs which still only 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    66
implement this version of the interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    67
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    68
const TInt KRemConInterfaceIf2 = 0x10285A37;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    69
		
20ac952a623c 201040_02
hgs
parents:
diff changeset
    70
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    71
Mixin for outer layer interfaces to be notified of incoming messages. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    72
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    73
class MRemConInterfaceIf2
20ac952a623c 201040_02
hgs
parents:
diff changeset
    74
	{
20ac952a623c 201040_02
hgs
parents:
diff changeset
    75
public: 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    76
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    77
	Called when a message comes in for this interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    78
	@param aOperationId The interface-specific operation id.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    79
	@param aData Any operation-specific data.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    80
	@param aMessageSubType The message subtype.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    81
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    82
	virtual void MrcibNewMessage(TUint aOperationId, const TDesC8& aData, TRemConMessageSubType aMessageSubType) = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    83
	};
20ac952a623c 201040_02
hgs
parents:
diff changeset
    84
20ac952a623c 201040_02
hgs
parents:
diff changeset
    85
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    86
/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    87
The UID of the interface between the interface selector and the outer layer 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    88
API. Currently this consists of a single 'new message' method. If in future it 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    89
changes (more methods are added) then a new M class and UID can be defined. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    90
New outer layer APIs can implement that M class and be used by the interface 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    91
selector, without breaking existing outer layer APIs which still only 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    92
implement this version of the interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    93
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    94
const TInt KRemConInterfaceIf3 = 0x10285DF1;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    95
		
20ac952a623c 201040_02
hgs
parents:
diff changeset
    96
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    97
Mixin for outer layer interfaces to be notified of incoming messages. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    98
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    99
class MRemConInterfaceIf3
20ac952a623c 201040_02
hgs
parents:
diff changeset
   100
	{
20ac952a623c 201040_02
hgs
parents:
diff changeset
   101
public: 
20ac952a623c 201040_02
hgs
parents:
diff changeset
   102
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
   103
	Called when a message comes in for this interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
   104
	@param aOperationId The interface-specific operation id.
20ac952a623c 201040_02
hgs
parents:
diff changeset
   105
	@param aData Any operation-specific data.
20ac952a623c 201040_02
hgs
parents:
diff changeset
   106
	@param aMessageSubType The message subtype.
20ac952a623c 201040_02
hgs
parents:
diff changeset
   107
	@param aRemoteAddr The address of the remote that sent the message 
20ac952a623c 201040_02
hgs
parents:
diff changeset
   108
	(includes the bearer UID).
20ac952a623c 201040_02
hgs
parents:
diff changeset
   109
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
   110
	virtual void MrcibNewMessage(TUint aOperationId, const TDesC8& aData, TRemConMessageSubType aMessageSubType, const TRemConAddress& aRemoteAddr) = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
   111
	};
20ac952a623c 201040_02
hgs
parents:
diff changeset
   112
20ac952a623c 201040_02
hgs
parents:
diff changeset
   113
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
   114
#endif // REMCONINTERFACEIF_H