remotecontrol/remotecontrolfw/bearerplugin/public/remconbearerplugin.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 REMCONBEARERPLUGIN_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    23
#define REMCONBEARERPLUGIN_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
20ac952a623c 201040_02
hgs
parents:
diff changeset
    27
class MRemConBearerObserver;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    28
class TBearerParams;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    29
class TRemConAddress;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    30
20ac952a623c 201040_02
hgs
parents:
diff changeset
    31
/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    32
The UID of the RemCon bearer interface. Implementors of new bearers are 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    33
implementing this interface. The bearer interface is simply a means of 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    34
supplying implementations of the 'bearer API' to RemCon. The bearer API may 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    35
change over time, so this extension pattern is used.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    36
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    37
const TInt KRemConBearerInterfaceUid = 0x10204546;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    38
20ac952a623c 201040_02
hgs
parents:
diff changeset
    39
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    40
Base class for bearer plugins.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    41
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    42
class CRemConBearerPlugin : public CBase
20ac952a623c 201040_02
hgs
parents:
diff changeset
    43
	{
20ac952a623c 201040_02
hgs
parents:
diff changeset
    44
public: // used by RemCon to create and destroy bearer instances
20ac952a623c 201040_02
hgs
parents:
diff changeset
    45
	/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    46
	Constructor.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    47
	@param aParams Parameters from RemCon, used to initialise the 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    48
	implementation.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    49
	@return Ownership of a new bearer plugin.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    50
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    51
	IMPORT_C static CRemConBearerPlugin* NewL(TBearerParams& aParams);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    52
20ac952a623c 201040_02
hgs
parents:
diff changeset
    53
	/** Destructor. */
20ac952a623c 201040_02
hgs
parents:
diff changeset
    54
	IMPORT_C ~CRemConBearerPlugin();
20ac952a623c 201040_02
hgs
parents:
diff changeset
    55
20ac952a623c 201040_02
hgs
parents:
diff changeset
    56
public:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    57
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    58
	Called by RemCon server to get a pointer to an object which implements the 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    59
	bearer API with UID aUid. This is a mechanism for allowing future change 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    60
	to the bearer API without breaking BC in existing (non-updated) bearer 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    61
	plugins.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    62
	@param aUid The UID of a bearer API
20ac952a623c 201040_02
hgs
parents:
diff changeset
    63
	@return A pointer to an object which implements the interface identified 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    64
	by aUid or NULL if the interface is not implemented.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    65
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    66
	virtual TAny* GetInterface(TUid aUid) = 0;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    67
20ac952a623c 201040_02
hgs
parents:
diff changeset
    68
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    69
	Called by RemCon to query the bearer's implementation UID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    70
	@return The bearer's implementation UID.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    71
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    72
	IMPORT_C TUid Uid() const;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    73
20ac952a623c 201040_02
hgs
parents:
diff changeset
    74
protected: // called by concrete bearer plugins
20ac952a623c 201040_02
hgs
parents:
diff changeset
    75
	/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    76
	Constructor
20ac952a623c 201040_02
hgs
parents:
diff changeset
    77
	@param aParams Parameters from RemCon, used to initialise the 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    78
	implementation.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    79
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    80
	IMPORT_C CRemConBearerPlugin(TBearerParams& aParams);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    81
20ac952a623c 201040_02
hgs
parents:
diff changeset
    82
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    83
	Accessor for the observer.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    84
	@return The observer.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    85
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    86
	IMPORT_C MRemConBearerObserver& Observer();
20ac952a623c 201040_02
hgs
parents:
diff changeset
    87
20ac952a623c 201040_02
hgs
parents:
diff changeset
    88
private: // unowned
20ac952a623c 201040_02
hgs
parents:
diff changeset
    89
	MRemConBearerObserver& iObserver;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    90
20ac952a623c 201040_02
hgs
parents:
diff changeset
    91
private: // owned
20ac952a623c 201040_02
hgs
parents:
diff changeset
    92
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    93
	UID set by ECOM when the instance is created. Used when the instance is 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    94
	destroyed.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    95
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    96
	TUid iInstanceId;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    97
20ac952a623c 201040_02
hgs
parents:
diff changeset
    98
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    99
	Implementation UID of concrete instance.
20ac952a623c 201040_02
hgs
parents:
diff changeset
   100
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
   101
	const TUid iImplementationUid;
20ac952a623c 201040_02
hgs
parents:
diff changeset
   102
20ac952a623c 201040_02
hgs
parents:
diff changeset
   103
	/** 
20ac952a623c 201040_02
hgs
parents:
diff changeset
   104
	Pad for BC-friendly future change.
20ac952a623c 201040_02
hgs
parents:
diff changeset
   105
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
   106
	TAny* iPad;
20ac952a623c 201040_02
hgs
parents:
diff changeset
   107
	};
20ac952a623c 201040_02
hgs
parents:
diff changeset
   108
20ac952a623c 201040_02
hgs
parents:
diff changeset
   109
#endif // REMCONBEARERPLUGIN_H