remotecontrol/remotecontrolfw/converterplugin/public/remconconverterinterface.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
 @publishedPartner
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 REMCONCONVERTERINTERFACE_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    23
#define REMCONCONVERTERINTERFACE_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
/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    29
The UID of the converter API. If the converter API ever has to change, a new 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    30
UID and associated M class will be created. New implementations of 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    31
CRemConConverterPlugin may implement the new API. Old (non-updated) converters 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    32
will still work as long as RemCon supports the old API.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    33
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    34
const TInt KRemConConverterInterface1 = 0x1020D40A;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    35
20ac952a623c 201040_02
hgs
parents:
diff changeset
    36
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    37
Mixin for the converter API.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    38
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    39
class MRemConConverterInterface
20ac952a623c 201040_02
hgs
parents:
diff changeset
    40
	{
20ac952a623c 201040_02
hgs
parents:
diff changeset
    41
public:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    42
	/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    43
	Called by the server to get the converter to convert from the interface 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    44
	(API) format to the bearer-specific format.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    45
	@param aInterfaceUid The interface UID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    46
	@param aOperationId Operation ID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    47
	@param aData Data associated with the operation.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    48
	@param aMsgType The type of the message.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    49
	@param aBearerData Converted output.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    50
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    51
	virtual TInt InterfaceToBearer(TUid aInterfaceUid, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    52
		TUint aOperationId,
20ac952a623c 201040_02
hgs
parents:
diff changeset
    53
		const TDesC8& aData,
20ac952a623c 201040_02
hgs
parents:
diff changeset
    54
		TRemConMessageType aMsgType, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    55
		TDes8& aBearerData) const = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    56
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    57
	/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    58
	Called by the server to get the converter to convert from the bearer-
20ac952a623c 201040_02
hgs
parents:
diff changeset
    59
	specific format to the interface (API) format.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    60
	@param aBearerData Bearer input.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    61
	@param aInterfaceUid The interface UID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    62
	@param aOperationId Operation ID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    63
	@param aMsgType The type of the message.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    64
	@param aData Data associated with the operation.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    65
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    66
	virtual TInt BearerToInterface(const TDesC8& aBearerData,
20ac952a623c 201040_02
hgs
parents:
diff changeset
    67
		TUid& aInterfaceUid, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    68
		TUint& aOperationId,
20ac952a623c 201040_02
hgs
parents:
diff changeset
    69
		TRemConMessageType& aMsgType, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    70
		TDes8& aData) const = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    71
20ac952a623c 201040_02
hgs
parents:
diff changeset
    72
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    73
	Called by the server to find out if this converter converts between the formats 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    74
	of this interface and bearer.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    75
	@param aInterfaceUid The interface UID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    76
	@param aBearerUid The bearer UID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    77
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    78
	virtual TBool SupportedUids(const TUid& aInterfaceUid, const TUid& aBearerUid) const = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    79
	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    80
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    81
	Called by the server to find out if this converter converts between the formats 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    82
	of this bearer interface and RemCon interface.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    83
	@param aInterfaceData The identifier of this interface in a bearer defined format.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    84
	@param aBearerUid The bearer UID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    85
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    86
	virtual TBool SupportedInterface(const TDesC8& aInterfaceData, const TUid& aBearerUid) const = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    87
	};
20ac952a623c 201040_02
hgs
parents:
diff changeset
    88
20ac952a623c 201040_02
hgs
parents:
diff changeset
    89
#endif // REMCONCONVERTERINTERFACE_H