1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/inc/ECom.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,451 @@
1.4 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// The API definitions required for the use of the ECOM framework by a client
1.18 +// are contained / defined here.
1.19 +//
1.20 +//
1.21 +
1.22 +/**
1.23 + @file
1.24 + @publishedAll
1.25 + @released
1.26 +*/
1.27 +
1.28 +#ifndef __ECOM_H__
1.29 +#define __ECOM_H__
1.30 +
1.31 +// ____________________________________________________________________________
1.32 +// INCLUDES
1.33 +
1.34 +#include <e32base.h>
1.35 +#include <s32std.h>
1.36 +#include <f32file.h>
1.37 +
1.38 +#include <ecom/ecomerrorcodes.h>
1.39 +#include <ecom/ecomresolverparams.h>
1.40 +#include <ecom/implementationinformation.h>
1.41 +
1.42 +
1.43 +// ____________________________________________________________________________
1.44 +// CONSTANTS
1.45 +
1.46 +class CGlobalData;
1.47 +
1.48 +/**
1.49 +The UID identifying the ROM-Only CResolver Interface Implementation.
1.50 +This resolver only returns implementations present on R/O internal media
1.51 +(built-in) or upgrades of such implementations on R/W media. It does not
1.52 +return implementations that solely reside on R/W media.
1.53 +*/
1.54 +const TUid KRomOnlyResolverUid = {0x10009D92};
1.55 +
1.56 +
1.57 +// ____________________________________________________________________________
1.58 +// CLASSES
1.59 +
1.60 +/**
1.61 +The REComSession singleton class provides an API to identify (resolution),
1.62 +instantiate, and destroy interface class implementations requested by
1.63 +ECOM clients. It manages the session connection to the ECOM Server itself so
1.64 +that typically only one connection is made to the ECOM Server per thread.
1.65 +It provides an un-initialise function where it releases memory and handles
1.66 +of unused plug-ins, see the FinalClose() function. It also ensures that all
1.67 +necessary clean-up is performed in the event of a Leave by any of the
1.68 +ListImplementationsL() or CreateImplementationL() methods.
1.69 +
1.70 +Note: Although a public default constructor is provided in this class
1.71 +it is strongly recommended this object is never created by users of this
1.72 +API on the stack or heap by value. To access the non-static methods of this
1.73 +API use the static OpenL() method to obtain a pointer or a
1.74 +reference to the single reference counted session in use. Close() must be
1.75 +called when finished with.
1.76 +
1.77 +Special care must be taken when using aInstanceKey. It is a 32-bit instance key
1.78 +that is returned from a call to one of the CreateImplementationL() methods.
1.79 +This instance key must only be used with DestroyedImplementation() to identify
1.80 +the implementation instance for destruction, or GetImplementationUidL() to
1.81 +retrieve the Implementation Uid of the instance it refers to.
1.82 +No meaning must be attached to this instance key by ECOM clients
1.83 +and it must not be used for any other purpose.
1.84 +
1.85 +
1.86 +@see REComSession::FinalClose()
1.87 +*/
1.88 +class REComSession : public RSessionBase
1.89 + {
1.90 + friend class CGlobalData;
1.91 +
1.92 +public: // publishedAll APIs
1.93 + // Available for use by all clients
1.94 +
1.95 + IMPORT_C REComSession();
1.96 +
1.97 + IMPORT_C static REComSession& OpenL();
1.98 + IMPORT_C void Close();
1.99 +
1.100 + // Get Implementation Uid from an Instance Key
1.101 + IMPORT_C static TUid GetImplementationUidL(
1.102 + TUid aInstanceKey);
1.103 +
1.104 + // Destroy Implementation API declaration
1.105 + IMPORT_C static void DestroyedImplementation(
1.106 + TUid aInstanceKey);
1.107 +
1.108 + // See developer documentation for use of FinalClose.
1.109 + IMPORT_C static void FinalClose();
1.110 +
1.111 +
1.112 + // Notification API declarations
1.113 + //
1.114 +
1.115 + IMPORT_C void NotifyOnChange(TRequestStatus& aStatus);
1.116 + IMPORT_C void CancelNotifyOnChange(TRequestStatus& aStatus);
1.117 +
1.118 +
1.119 + // List implementations API declarations
1.120 + //
1.121 + // Use LI1 to list all implementations, unfiltered.
1.122 + // Use LI2 when default resolving required on the returned list.
1.123 + // Use LI3 when custom resolving required on the returned list.
1.124 +
1.125 + // ListImplementationsL - LI1
1.126 + IMPORT_C static void ListImplementationsL(
1.127 + TUid aInterfaceUid,
1.128 + RImplInfoPtrArray& aImplInfoArray);
1.129 +
1.130 + // ListImplementationsL - LI2
1.131 + IMPORT_C static void ListImplementationsL(
1.132 + TUid aInterfaceUid,
1.133 + const TEComResolverParams& aResolutionParameters,
1.134 + RImplInfoPtrArray& aImplInfoArray);
1.135 +
1.136 + // ListImplementationsL - LI3
1.137 + IMPORT_C static void ListImplementationsL(
1.138 + TUid aInterfaceUid,
1.139 + const TEComResolverParams& aResolutionParameters,
1.140 + TUid aResolverUid,
1.141 + RImplInfoPtrArray& aImplInfoArray);
1.142 +
1.143 + // Use LI7 to list all implementations, unfiltered and with no capability chaeck.
1.144 + // Use LI8 when default resolving required on the returned list and with no capability chaeck.
1.145 + // Use LI9 when custom resolving required on the returned list and with no capability chaeck.
1.146 +
1.147 + // ListImplementationsL - LI7
1.148 + IMPORT_C static void ListImplementationsL(
1.149 + TUid aInterfaceUid,
1.150 + RImplInfoPtrArray& aImplInfoArray,TBool aCapabilityCheck);
1.151 +
1.152 + // ListImplementationsL - LI8
1.153 + IMPORT_C static void ListImplementationsL(
1.154 + TUid aInterfaceUid,
1.155 + const TEComResolverParams& aResolutionParameters,
1.156 + RImplInfoPtrArray& aImplInfoArray,TBool aCapabilityCheck);
1.157 +
1.158 + // ListImplementationsL - LI9
1.159 + IMPORT_C static void ListImplementationsL(
1.160 + TUid aInterfaceUid,
1.161 + const TEComResolverParams& aResolutionParameters,
1.162 + TUid aResolverUid,
1.163 + RImplInfoPtrArray& aImplInfoArray,TBool aCapabilityCheck);
1.164 +
1.165 +
1.166 + // Create implementations API declarations
1.167 + //
1.168 + // When Implementation UID is known:
1.169 + // Use CI1, CI2.
1.170 + // Use CI3, CI4 when you have construction parameters.
1.171 + //
1.172 + // When the Interface UID is known and default resolving is required:
1.173 + // Use CI5, CI6.
1.174 + // Use CI7, CI8 when you have construction parameters.
1.175 + //
1.176 + // When the Interface UID is known and custom resolving is required:
1.177 + // Use CI9, CI10.
1.178 + // Use CI11, CI12 when you have construction parameters.
1.179 +
1.180 + // CreateImplementationL - CI1
1.181 + IMPORT_C static TAny* CreateImplementationL(
1.182 + TUid aImplementationUid,
1.183 + TUid& aInstanceKey);
1.184 +
1.185 + // CreateImplementationL - CI2
1.186 + IMPORT_C static TAny* CreateImplementationL(
1.187 + TUid aImplementationUid,
1.188 + TInt32 aKeyOffset);
1.189 +
1.190 + // CreateImplementationL - CI3
1.191 + IMPORT_C static TAny* CreateImplementationL(
1.192 + TUid aImplementationUid,
1.193 + TUid& aInstanceKey,
1.194 + TAny* aConstructionParameters);
1.195 +
1.196 + // CreateImplementationL - CI4
1.197 + IMPORT_C static TAny* CreateImplementationL(
1.198 + TUid aImplementationUid,
1.199 + TInt32 aKeyOffset,
1.200 + TAny* aConstructionParameters);
1.201 +
1.202 + // CreateImplementationL - CI5
1.203 + IMPORT_C static TAny* CreateImplementationL(
1.204 + TUid aInterfaceUid,
1.205 + TUid& aInstanceKey,
1.206 + const TEComResolverParams& aResolutionParameters);
1.207 +
1.208 + // CreateImplementationL - CI6
1.209 + IMPORT_C static TAny* CreateImplementationL(
1.210 + TUid aInterfaceUid,
1.211 + TInt32 aKeyOffset,
1.212 + const TEComResolverParams& aResolutionParameters);
1.213 +
1.214 + // CreateImplementationL - CI7
1.215 + IMPORT_C static TAny* CreateImplementationL(
1.216 + TUid aInterfaceUid,
1.217 + TUid& aInstanceKey,
1.218 + TAny* aConstructionParameters,
1.219 + const TEComResolverParams& aResolutionParameters);
1.220 +
1.221 + // CreateImplementationL - CI8
1.222 + IMPORT_C static TAny* CreateImplementationL(
1.223 + TUid aInterfaceUid,
1.224 + TInt32 aKeyOffset,
1.225 + TAny* aConstructionParameters,
1.226 + const TEComResolverParams& aResolutionParameters);
1.227 +
1.228 + // CreateImplementationL - CI9
1.229 + IMPORT_C static TAny* CreateImplementationL(
1.230 + TUid aInterfaceUid,
1.231 + TUid& aInstanceKey,
1.232 + const TEComResolverParams& aResolutionParameters,
1.233 + TUid aResolverUid);
1.234 +
1.235 + // CreateImplementationL - CI10
1.236 + IMPORT_C static TAny* CreateImplementationL(
1.237 + TUid aInterfaceUid,
1.238 + TInt32 aKeyOffset,
1.239 + const TEComResolverParams& aResolutionParameters,
1.240 + TUid aResolverUid);
1.241 +
1.242 + // CreateImplementationL - CI11
1.243 + IMPORT_C static TAny* CreateImplementationL(
1.244 + TUid aInterfaceUid,
1.245 + TUid& aInstanceKey,
1.246 + TAny* aConstructionParameters,
1.247 + const TEComResolverParams& aResolutionParameters,
1.248 + TUid aResolverUid);
1.249 +
1.250 + // CreateImplementationL - CI12
1.251 + IMPORT_C static TAny* CreateImplementationL(
1.252 + TUid aInterfaceUid,
1.253 + TInt32 aKeyOffset,
1.254 + TAny* aConstructionParameters,
1.255 + const TEComResolverParams& aResolutionParameters,
1.256 + TUid aResolverUid);
1.257 +
1.258 +
1.259 +public: // publishedPartner APIs
1.260 + // Extended interfaces API declarations available for use by
1.261 + // all system software i.e by phone manufacturers and internally (i.e. not supported for use by 3rd parties)
1.262 + // See Symbian OS Developer Library and ECOM How To/FAQ documentation.
1.263 +
1.264 +
1.265 + // List implementations API declarations
1.266 + //
1.267 + // Use L14 to list all implementations which satisfy interface, extended
1.268 + // interfaces
1.269 + // Use L15 to list all implementations which satisfy interface, extended
1.270 + // interfaces when default resolving required on the list returned
1.271 + // Use L16 to list all implementations which satisfy interface, extended
1.272 + // interfaces when custom resolving required on the list returned
1.273 +
1.274 + // ListImplementationsL - LI4
1.275 + IMPORT_C static void ListImplementationsL(
1.276 + TUid aInterfaceUid,
1.277 + RExtendedInterfacesArray& aExtendedInterfaces,
1.278 + RImplInfoPtrArray& aImplInfoArray);
1.279 +
1.280 + // ListImplementationsL - LI5
1.281 + IMPORT_C static void ListImplementationsL(
1.282 + TUid aInterfaceUid,
1.283 + RExtendedInterfacesArray& aExtendedInterfaces,
1.284 + const TEComResolverParams& aResolutionParameters,
1.285 + RImplInfoPtrArray& aImplInfoArray);
1.286 +
1.287 + // ListImplementationsL - LI6
1.288 + IMPORT_C static void ListImplementationsL(
1.289 + TUid aInterfaceUid,
1.290 + RExtendedInterfacesArray& aExtendedInterfaces,
1.291 + const TEComResolverParams& aResolutionParameters,
1.292 + TUid aResolverUid,
1.293 + RImplInfoPtrArray& aImplInfoArray);
1.294 +
1.295 +
1.296 + // Create implementations API declarations
1.297 + //
1.298 + // When the interface UID and the extended interface UID's are known
1.299 + // and default resolving is required. The construction parameters may
1.300 + // optionally be provided.
1.301 + // Use CI13: Instance key is returned
1.302 + // Use CI14: An offset to aInstanceKey returned by the ECom framework
1.303 + // to identify this instance to the framework
1.304 + // When the interface UID and the extended interface UID's are known
1.305 + // and custom resolving is required. The construction parameters may
1.306 + // optionally be provided.
1.307 + // Use CI15: Instance key is returned
1.308 + // Use CI16: An offset to aInstanceKey returned by the ECom framework
1.309 + // to identify this instance to the framework
1.310 +
1.311 + // CreateImplementationL - CI13
1.312 + IMPORT_C static TAny* CreateImplementationL(
1.313 + TUid aInterfaceUid,
1.314 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.315 + TUid& aInstanceKey,
1.316 + const TEComResolverParams& aResolutionParameters,
1.317 + TAny* aConstructionParameters = NULL);
1.318 +
1.319 + // CreateImplementationL - CI14
1.320 + IMPORT_C static TAny* CreateImplementationL(
1.321 + TUid aInterfaceUid,
1.322 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.323 + TInt32 aKeyOffset,
1.324 + const TEComResolverParams& aResolutionParameters,
1.325 + TAny* aConstructionParameters = NULL);
1.326 +
1.327 + // CreateImplementationL - CI15
1.328 + IMPORT_C static TAny* CreateImplementationL(
1.329 + TUid aInterfaceUid,
1.330 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.331 + TUid& aInstanceKey,
1.332 + const TEComResolverParams& aResolutionParameters,
1.333 + TUid aResolverUid,
1.334 + TAny* aConstructionParameters = NULL);
1.335 +
1.336 + // CreateImplementationL - CI16
1.337 + IMPORT_C static TAny* CreateImplementationL(
1.338 + TUid aInterfaceUid,
1.339 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.340 + TInt32 aKeyOffset,
1.341 + const TEComResolverParams& aResolutionParameters,
1.342 + TUid aResolverUid,
1.343 + TAny* aConstructionParameters = NULL);
1.344 +
1.345 +
1.346 + // Extended Interface query and management API declarations
1.347 + //
1.348 +
1.349 + IMPORT_C static TAny* GetExtendedInterfaceL(
1.350 + const TUid& aInstanceKey,
1.351 + const TUid& aExtendedInterfaceUid);
1.352 +
1.353 + IMPORT_C static void ListExtendedInterfacesL(
1.354 + const TUid& aImplementationUid,
1.355 + RExtendedInterfacesArray& aIfInfo);
1.356 +
1.357 + IMPORT_C static void ManuallyReleaseExtendedInterfaceL(
1.358 + const TUid& aInstanceKey,
1.359 + const TUid& aExtendedInterfaceUid);
1.360 +
1.361 +
1.362 +private: // @internalComponent APIs
1.363 + // This API is for internal testing purposes.Should not be used externally by clients.
1.364 +
1.365 + static REComSession& OpenLC();
1.366 +
1.367 + void ConstructL();
1.368 + void ReallyClose();
1.369 +
1.370 + void ListImplementationsL(
1.371 + TInt aServiceId,
1.372 + TUid aInterfaceUid,
1.373 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.374 + const TEComResolverParams& aResolutionParameters,
1.375 + TUid aResolverUid,
1.376 + RImplInfoPtrArray& aImplInfoArray,
1.377 + TBool aCapabilityCheck = ETrue);
1.378 +
1.379 + TAny* ResolveAndCreateImplL(
1.380 + TUid aImplementationUid,
1.381 + TUid& aInstanceKey,
1.382 + TAny* aCreationParameters,
1.383 + TBool aCreationParamsFlag);
1.384 +
1.385 + TAny* ResolveAndCreateImplL(
1.386 + TUid aInterfaceUid,
1.387 + const TEComResolverParams& aResolutionParameters,
1.388 + TUid& aInstanceKey,
1.389 + TAny* aCreationParameters,
1.390 + TBool aCreationParamsFlag);
1.391 +
1.392 + TAny* ResolveAndCreateImplL(
1.393 + TUid aInterfaceUid,
1.394 + const TEComResolverParams& aResolutionParameters,
1.395 + TUid aResolverUid,
1.396 + TUid& aInstanceKey,
1.397 + TAny* aCreationParameters,
1.398 + TBool aCreationParamsFlag);
1.399 +
1.400 + TAny* ResolveAndCreateImplL(
1.401 + TUid aInterfaceUid,
1.402 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.403 + const TEComResolverParams& aResolutionParameters,
1.404 + TUid& aInstanceKey,
1.405 + TAny* aCreationParameters,
1.406 + TBool aCreationParamsFlag);
1.407 +
1.408 + TAny* ResolveAndCreateImplL(
1.409 + TUid aInterfaceUid,
1.410 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.411 + const TEComResolverParams& aResolutionParameters,
1.412 + TUid aResolverUid,
1.413 + TUid& aInstanceKey,
1.414 + TAny* aCreationParameters,
1.415 + TBool aCreationParamsFlag);
1.416 +
1.417 + TAny* ResolveAndCreateImplL(
1.418 + TInt aServiceId,
1.419 + TUid aInterfaceUid,
1.420 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.421 + const TEComResolverParams& aResolutionParameters,
1.422 + TUid aResolverUid,
1.423 + TUid& aInstanceKey,
1.424 + TAny* aCreationParameters,
1.425 + TBool aCreationParamsFlag);
1.426 +
1.427 + void ProcessListExtendedInterfacesL(
1.428 + const TUid& aImplementationUid,
1.429 + RExtendedInterfacesArray& aIfInfo);
1.430 +
1.431 + void PackMatchStrAndExtendedInterfacesL(
1.432 + const TEComResolverParams& aResolutionParameters,
1.433 + const RExtendedInterfacesArray& aExtendedInterfaces,
1.434 + RBuf8& aMatchStrExtInfBuf);
1.435 +
1.436 +
1.437 +public: // @internalComponent APIs
1.438 + // Internal methods used inside ECOM, not for client use.
1.439 +
1.440 + // This API is for internal testing purposes.
1.441 + IMPORT_C static void SetGetParametersL(const TIpcArgs &aArgs);
1.442 +
1.443 +
1.444 +private:
1.445 + /** Not used */
1.446 + TInt iReserved1;
1.447 +
1.448 + /** not used */
1.449 + TInt iReserved3;
1.450 + /** not used */
1.451 + TInt iReserved2;
1.452 + };
1.453 +
1.454 +#endif // __ECOM_H__