|
sl@0
|
1 |
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// ULogger plug-in base class
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@file
|
|
sl@0
|
20 |
@publishedPartner
|
|
sl@0
|
21 |
@prototype
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#ifndef ULOGGERPLUGIN_H
|
|
sl@0
|
25 |
#define ULOGGERPLUGIN_H
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#include <e32base.h>
|
|
sl@0
|
28 |
#include <ecom/implementationinformation.h>
|
|
sl@0
|
29 |
#include <ecom/ecomresolverparams.h>
|
|
sl@0
|
30 |
#include <ecom/ecom.h>
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
namespace Ulogger
|
|
sl@0
|
33 |
{
|
|
sl@0
|
34 |
//! Base class for all ULogger plug-ins.
|
|
sl@0
|
35 |
/*!
|
|
sl@0
|
36 |
ULogger is extensible through a plug-in framework that uses ECom for plug-in
|
|
sl@0
|
37 |
discovery. Deriving from this class means that all the ECom-specific logic is
|
|
sl@0
|
38 |
already provided for the plug-in implementer, out-of-the-box, leaving the
|
|
sl@0
|
39 |
plug-in code to deal with the domain-specific logic that the plug-in is supposed
|
|
sl@0
|
40 |
to implement only.
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
Among the plug-in types that are currently supported are output plug-ins (see
|
|
sl@0
|
43 |
class ULogger::MOutputPlugin in uloggeroutputplugin.h) and input plug-ins (see
|
|
sl@0
|
44 |
class ULogger::MInputPlugin in uloggerinputplugin.h).
|
|
sl@0
|
45 |
|
|
sl@0
|
46 |
Plug-ins must derive from this class in order to be compatible with ULogger.
|
|
sl@0
|
47 |
*/
|
|
sl@0
|
48 |
class CPlugin : public CBase
|
|
sl@0
|
49 |
{
|
|
sl@0
|
50 |
public:
|
|
sl@0
|
51 |
/**
|
|
sl@0
|
52 |
Enum to signify plug-in interface types. Used by each specific plug-in
|
|
sl@0
|
53 |
interface (M-class) to identify itself as being of a particular type.
|
|
sl@0
|
54 |
*/
|
|
sl@0
|
55 |
enum TPluginInterface
|
|
sl@0
|
56 |
{
|
|
sl@0
|
57 |
EOutput,//!< output plug-in interface type
|
|
sl@0
|
58 |
EInput //!< input plug-in interface type
|
|
sl@0
|
59 |
};
|
|
sl@0
|
60 |
|
|
sl@0
|
61 |
public:
|
|
sl@0
|
62 |
/**
|
|
sl@0
|
63 |
Creates a CPlugin instance of the specified type and returns a pointer to
|
|
sl@0
|
64 |
it. The type is specified as the name of the ECom plug-in DLL (without the
|
|
sl@0
|
65 |
dll extension).
|
|
sl@0
|
66 |
|
|
sl@0
|
67 |
@param aCue a descriptor containing the name of the plug-in to be created
|
|
sl@0
|
68 |
@return A pointer to the newly created CPlugin object.
|
|
sl@0
|
69 |
*/
|
|
sl@0
|
70 |
static CPlugin* NewL(const TDesC8& aCue);
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/**
|
|
sl@0
|
73 |
Virtual destructor.
|
|
sl@0
|
74 |
*/
|
|
sl@0
|
75 |
virtual ~CPlugin();
|
|
sl@0
|
76 |
|
|
sl@0
|
77 |
/**
|
|
sl@0
|
78 |
Return pointer to requested interface.
|
|
sl@0
|
79 |
If plug-in implements multiple interfaces, it should return pointer to
|
|
sl@0
|
80 |
proper interface trough this method.
|
|
sl@0
|
81 |
|
|
sl@0
|
82 |
@param aInterfaceId Number of requested interface.
|
|
sl@0
|
83 |
@return Pointer to requested interface or NULL if requested interface is not
|
|
sl@0
|
84 |
supported.
|
|
sl@0
|
85 |
*/
|
|
sl@0
|
86 |
virtual TAny* GetInterfaceL(TPluginInterface aInterfaceId) = 0;
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
private:
|
|
sl@0
|
89 |
TUid iDtor_ID_Key;
|
|
sl@0
|
90 |
};
|
|
sl@0
|
91 |
|
|
sl@0
|
92 |
} //end of namespace
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
#include "uloggerplugin.inl" // Our own base implementations for ECOM
|
|
sl@0
|
95 |
|
|
sl@0
|
96 |
#endif /* ULOGGERPLUGIN_H */
|