| class REComSession : public RSessionBase |
The REComSession singleton class provides an API to identify (resolution), instantiate, and destroy interface class implementations requested by ECOM clients. It manages the session connection to the ECOM Server itself so that typically only one connection is made to the ECOM Server per thread. It provides an un-initialise function where it releases memory and handles of unused plug-ins, see the FinalClose() function. It also ensures that all necessary clean-up is performed in the event of a Leave by any of the ListImplementationsL() or CreateImplementationL() methods.
Note: Although a public default constructor is provided in this class it is strongly recommended this object is never created by users of this API on the stack or heap by value. To access the non-static methods of this API use the static OpenL() method to obtain a pointer or a reference to the single reference counted session in use. Close() must be called when finished with.
Special care must be taken when using aInstanceKey. It is a 32-bit instance key that is returned from a call to one of the CreateImplementationL() methods. This instance key must only be used with DestroyedImplementation() to identify the implementation instance for destruction, or GetImplementationUidL() to retrieve the Implementation Uid of the instance it refers to. No meaning must be attached to this instance key by ECOM clients and it must not be used for any other purpose.
| Inherited Enumerations | |
|---|---|
| RHandleBase:TAttributes | |
| RSessionBase:TAttachMode | |
| Private Attributes | |
|---|---|
| TInt | iReserved1 |
| TInt | iReserved2 |
| TInt | iReserved3 |
| Inherited Attributes | |
|---|---|
| RHandleBase::iHandle | |
| IMPORT_C void | CancelNotifyOnChange | ( | TRequestStatus & | aStatus | ) |
| TRequestStatus & aStatus | The request status object originally passed to NotifyOnChange() for notification signalling. |
| IMPORT_C void | Close | ( | ) |
Closes the open handle on the ECOM framework. Reference count is decremented and the ECOM client/server session is closed.
| void | ConstructL | ( | ) | [private] |
Initialisation phase of two phase construction.
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aImplementationUid, |
| TUid & | aInstanceKey | |||
| ) | [static] | |||
| TUid aImplementationUid | A UID specifying the required interface implementation. |
| TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aImplementationUid, |
| TInt32 | aKeyOffset | |||
| ) | [static] | |||
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aImplementationUid, |
| TUid & | aInstanceKey, | |||
| TAny * | aConstructionParameters | |||
| ) | [static] | |||
| TUid aImplementationUid | A UID specifying the required interface implementation. |
| TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aImplementationUid, |
| TInt32 | aKeyOffset, | |||
| TAny * | aConstructionParameters | |||
| ) | [static] | |||
| TUid aImplementationUid | A UID specifying the required interface implementation. |
| TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
| TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| TUid & | aInstanceKey, | |||
| const TEComResolverParams & | aResolutionParameters | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| TInt32 | aKeyOffset, | |||
| const TEComResolverParams & | aResolutionParameters | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| TUid & | aInstanceKey, | |||
| TAny * | aConstructionParameters, | |||
| const TEComResolverParams & | aResolutionParameters | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. return TAny* A pointer to the instantiated interface implementation. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| TInt32 | aKeyOffset, | |||
| TAny * | aConstructionParameters, | |||
| const TEComResolverParams & | aResolutionParameters | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
| TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| TUid & | aInstanceKey, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| TInt32 | aKeyOffset, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| TUid & | aInstanceKey, | |||
| TAny * | aConstructionParameters, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| TInt32 | aKeyOffset, | |||
| TAny * | aConstructionParameters, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
| TAny * aConstructionParameters | The parameter structure to pass to the object creation method. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| TUid & | aInstanceKey, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TAny * | aConstructionParameters = NULL | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface implementation. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TAny * aConstructionParameters = NULL | The parameter structure to pass to the object creation method. Default value is NULL. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| TInt32 | aKeyOffset, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TAny * | aConstructionParameters = NULL | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface implementation. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TAny * aConstructionParameters = NULL | The parameter structure to pass to the object creation method. Default value is NULL. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| TUid & | aInstanceKey, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| TAny * | aConstructionParameters = NULL | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface implementation. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| TUid & aInstanceKey | A 32-bit instance key that is returned by the ECom framework. This instance key should be passed as an argument to the DestroyedImplementation() method to identify the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| TAny * aConstructionParameters = NULL | The parameter structure to pass to the object creation method. Default value is NULL. |
| IMPORT_C TAny * | CreateImplementationL | ( | TUid | aInterfaceUid, |
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| TInt32 | aKeyOffset, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| TAny * | aConstructionParameters = NULL | |||
| ) | [static] | |||
Instantiates an interface implementation to satisfy the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface implementation. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| TInt32 aKeyOffset | An offset to the 32 bit identifer returned by the ECom framework to identify this instance to the framework. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| TAny * aConstructionParameters = NULL | The parameter structure to pass to the object creation method. Default value is NULL. |
| IMPORT_C void | DestroyedImplementation | ( | TUid | aInstanceKey | ) | [static] |
| TUid aInstanceKey | A 32-bit instance key that is returned from a call to one of the CreateImplementationL() methods. This instance key identifies the implementation for destruction. No meaning should be attached to this instance key by ECOM clients and it should not be used for any other purpose. |
| IMPORT_C void | FinalClose | ( | ) | [static] |
This method is used in processes that have utilised the ECOM framework, it does nothing if the ECOM framework has not been initialised. Its main purpose is to release memory and close handles held on unused plug-in implementations and their associated DLLs. If is found (through reference counting) that the ECOM framework is no longer in use in the calling thread the session to the ECOM's server is also closed.
This method is called by direct users of the ECOM framework wherever possible (e.g. library, server or test code). It is safe to call it at any time outside of plug-in code as the user's scenario dictates. This maybe during a test case or just before process termination.
Note: It must never be called from within a plug-in implementations class destructor, especially following a DestroyImplementation() as there is a risk that the plug-in's supporting DLL may immediately be unloaded by the Kernel due to the closure of RLibrary handles. It can result in a KERN-EXEC if the destructor call stack is still inside the DLL that is unloaded.
Note: Processes that utilise the ECOM framework that do not use this call are at risk of a UHEAP_MARKEND generated panic in debug builds.
| IMPORT_C TAny * | GetExtendedInterfaceL | ( | const TUid & | aInstanceKey, |
| const TUid & | aExtendedInterfaceUid | |||
| ) | [static] | |||
| const TUid & aInstanceKey | A 32-bit implementation instance key that is returned from a call to one of the CreateImplementationL() methods. ECOM uses this implementation instance key when it is passed as an argument to the DestroyedImplementation() method to identify an implementation for destruction. No meaning should be attached to this implementation instance key by ECOM clients and it should not be used for any other purpose. |
| const TUid & aExtendedInterfaceUid | Identifies an interface to fetch from the plug-in instance. |
| IMPORT_C TUid | GetImplementationUidL | ( | TUid | aInstanceKey | ) | [static] |
| TUid aInstanceKey | A 32-bit implementation instance key that is returned from a call to one of the CreateImplementationL() methods. ECOM uses this implementation instance key when it is passed as an argument to the DestroyedImplementation() method to identify an implementation for destruction. No meaning should be attached to this implementation instance key by ECOM clients and it should not be used for any other purpose. |
| IMPORT_C void | ListExtendedInterfacesL | ( | const TUid & | aImplementationUid, |
| RExtendedInterfacesArray & | aIfInfo | |||
| ) | [static] | |||
| const TUid & aImplementationUid | Implementation UID to fetch the extended interfaces for. |
| RExtendedInterfacesArray & aIfInfo | Return value consisting of an array containing the extended interfaces. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| RImplInfoPtrArray & | aImplInfoArray | |||
| ) | [static] | |||
| TUid aInterfaceUid | A UID specifying the required interface. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| const TEComResolverParams & | aResolutionParameters, | |||
| RImplInfoPtrArray & | aImplInfoArray | |||
| ) | [static] | |||
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process.
| TUid aInterfaceUid | A UID specifying the required interface. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| RImplInfoPtrArray & | aImplInfoArray | |||
| ) | [static] | |||
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process. Overload with a client provided CResolver.
| TUid aInterfaceUid | A UID specifying the required interface. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The CResolver UID which identifies the resolver implementation with the required client defined behaviour. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| RImplInfoPtrArray & | aImplInfoArray, | |||
| TBool | aCapabilityCheck | |||
| ) | [static] | |||
| TUid aInterfaceUid | A UID specifying the required interface. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| TBool aCapabilityCheck | A boolean value EFalse , if no capability check is required ETrue otherwise. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| const TEComResolverParams & | aResolutionParameters, | |||
| RImplInfoPtrArray & | aImplInfoArray, | |||
| TBool | aCapabilityCheck | |||
| ) | [static] | |||
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters.This method does not do capability check. The aImplInfoArray on exit contains the plug-in implementations .
| TUid aInterfaceUid | A UID specifying the required interface. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| TBool aCapabilityCheck | A boolean value EFalse , if no capability check is required ETrue otherwise. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| RImplInfoPtrArray & | aImplInfoArray, | |||
| TBool | aCapabilityCheck | |||
| ) | [static] | |||
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters.This method does not do capability check. The aImplInfoArray on exit contains the plug-in implementations . Overload with a client provided CResolver.
| TUid aInterfaceUid | A UID specifying the required interface. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The CResolver UID which identifies the resolver implementation with the required client defined behaviour. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| TBool aCapabilityCheck | A boolean value EFalse , if no capability check is required ETrue otherwise. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| RImplInfoPtrArray & | aImplInfoArray | |||
| ) | [static] | |||
| TUid aInterfaceUid | A UID specifying the required interface. |
| RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or many extended interfaces to match. Must match all extended interfaces for a match to occur. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| RImplInfoPtrArray & | aImplInfoArray | |||
| ) | [static] | |||
Retrieves a list of all the implementations which satisfy the specified interface, extended interfaces, with selection restriction to the specified parameters. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process.
| TUid aInterfaceUid | A UID specifying the required interface. |
| RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| IMPORT_C void | ListImplementationsL | ( | TUid | aInterfaceUid, |
| RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| RImplInfoPtrArray & | aImplInfoArray | |||
| ) | [static] | |||
Retrieves a list of all the implementations which satisfy the specified interface, extended Interfaces, with selection restriction to the specified parameters. The aImplInfoArray on exit contains the plug-in implementations who's plug-in DLLs have sufficient capabilities to be loaded by the calling client process. Overload with a client provided CResolver.
| TUid aInterfaceUid | A UID specifying the required interface. |
| RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The CResolver UID which identifies the resolver implementation with the required client defined behaviour. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| void | ListImplementationsL | ( | TInt | aServiceId, |
| TUid | aInterfaceUid, | |||
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| RImplInfoPtrArray & | aImplInfoArray, | |||
| TBool | aCapabilityCheck = ETrue | |||
| ) | [private] | |||
Retrieves a list of all the implementations which satisfy the specified interface with selection restriction to the specified parameters. Overload for internal use to ensure consistency between calls. This is the method which actually makes the IPC call.
| TInt aServiceId | An integer specifying the ECom service variant to use. |
| TUid aInterfaceUid | A UID specifying the required interface. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match, Must match all extended interfaces for a match to occur. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The CResolver UID which identifies the resolver implementation with the required client defined behaviour. |
| RImplInfoPtrArray & aImplInfoArray | A reference to a client owned array which will be filled with interface implementation data. The array will first be cleared and all items destroyed before adding new data. |
| TBool aCapabilityCheck = ETrue |
| IMPORT_C void | ManuallyReleaseExtendedInterfaceL | ( | const TUid & | aInstanceKey, |
| const TUid & | aExtendedInterfaceUid | |||
| ) | [static] | |||
| const TUid & aInstanceKey | A 32-bit implementation instance key that is returned from a call to one of the CreateImplementationL() methods. ECOM uses this implementation instance key when it is passed as an argument to the DestroyedImplementation() method to identify an implementation for destruction. No meaning should be attached to this implementation instance key by ECOM clients and it should not be used for any other purpose. |
| const TUid & aExtendedInterfaceUid | Identifies an extended interface to release. |
| IMPORT_C void | NotifyOnChange | ( | TRequestStatus & | aStatus | ) |
Registers for notification messages when the underlying ECOM registration data changes. The client must not call this api again until their request is Completed as this could result in a 'stray signal'. This api should be placed first in the RunL of an Active Object otherwise changes could be lost. RunError should be implemented to cater for any Leaves. For example, it could retry after a second if the ECom server is busy rebuilding its indexes. CancelNotifyOnChange should be called to cancel this request and should NOT be part of the RunL.
| TRequestStatus & aStatus | A request status object to complete for notification signalling. |
| IMPORT_C REComSession & | OpenL | ( | ) | [static] |
This method returns a reference to the singleton client/server session object maintained by the ECOM client library, referenced counted. If it does not exist it is initialised and then returned. Clients should store the handle returned by refernce or by pointer. Storage by value is highly discouraged.
It is only necessary to use the Open() /Close() API directly if you need access to the notification methods. Access to the static API does not require these to be used. Please remeber each call to Open() must have an equivalent Close() .
| REComSession & | OpenLC | ( | ) | [private, static] |
This method returns a reference to the singleton client/server session object maintained by the ECOM client library, referenced counted. If it does not exist it is initialised and then returned.
| void | PackMatchStrAndExtendedInterfacesL | ( | const TEComResolverParams & | aResolutionParameters, |
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| RBuf8 & | aMatchStrExtInfBuf | |||
| ) | [private] | |||
Pack the match string of the resolution parameter and extended interfaces into a buffer for sending to server.
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match, Must match all extended interfaces for a match to occur. |
| RBuf8 & aMatchStrExtInfBuf | The return buffer containing the information of match string and extended interfaces. |
| void | ProcessListExtendedInterfacesL | ( | const TUid & | aImplementationUid, |
| RExtendedInterfacesArray & | aIfInfo | |||
| ) | [private] | |||
| const TUid & aImplementationUid | Implementation UID to fetch the extended interfaces for. |
| RExtendedInterfacesArray & aIfInfo | Return value consisting of an array containing the extended interfaces. |
| void | ReallyClose | ( | ) | [private] |
| TAny * | ResolveAndCreateImplL | ( | TUid | aImplementationUid, |
| TUid & | aInstanceKey, | |||
| TAny * | aCreationParameters, | |||
| TBool | aCreationParamsFlag | |||
| ) | [private] | |||
Provides the instantiation method for an interface implementation that satisfies the specified interface.
| TUid aImplementationUid | A UID specifying the required interface implementation. |
| TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
| TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
| TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
| TAny * | ResolveAndCreateImplL | ( | TUid | aInterfaceUid, |
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid & | aInstanceKey, | |||
| TAny * | aCreationParameters, | |||
| TBool | aCreationParamsFlag | |||
| ) | [private] | |||
Provides the instantiation method for an interface implementation that satisfies the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
| TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
| TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
| TAny * | ResolveAndCreateImplL | ( | TUid | aInterfaceUid, |
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| TUid & | aInstanceKey, | |||
| TAny * | aCreationParameters, | |||
| TBool | aCreationParamsFlag | |||
| ) | [private] | |||
Provides the instantiation method for an interface implementation that satisfies the specified interface. Overload with a client provided CResolver.
| TUid aInterfaceUid | A UID specifying the required interface. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
| TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
| TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
| TAny * | ResolveAndCreateImplL | ( | TUid | aInterfaceUid, |
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid & | aInstanceKey, | |||
| TAny * | aCreationParameters, | |||
| TBool | aCreationParamsFlag | |||
| ) | [private] | |||
Provides the instantiation method for an interface implementation that satisfies the specified interface.
| TUid aInterfaceUid | A UID specifying the required interface. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
| TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
| TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
| TAny * | ResolveAndCreateImplL | ( | TUid | aInterfaceUid, |
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| TUid & | aInstanceKey, | |||
| TAny * | aCreationParameters, | |||
| TBool | aCreationParamsFlag | |||
| ) | [private] | |||
Provides the instantiation method for an interface implementation that satisfies the specified interface. Overload with a client provided CResolver.
| TUid aInterfaceUid | A UID specifying the required interface. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
| TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
| TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
| TAny * | ResolveAndCreateImplL | ( | TInt | aServiceId, |
| TUid | aInterfaceUid, | |||
| const RExtendedInterfacesArray & | aExtendedInterfaces, | |||
| const TEComResolverParams & | aResolutionParameters, | |||
| TUid | aResolverUid, | |||
| TUid & | aInstanceKey, | |||
| TAny * | aCreationParameters, | |||
| TBool | aCreationParamsFlag | |||
| ) | [private] | |||
Provides the instantiation method for an interface implementation that satisfies the specified interface. Overload for internal use to ensure consistency between calls. This is the method which actually makes the IPC call.
| TInt aServiceId | An integer specifying the ECom service variant to use. |
| TUid aInterfaceUid | A UID specifying the required interface. |
| const RExtendedInterfacesArray & aExtendedInterfaces | Identifies a set of zero or more extended interfaces to match. Must match all extended interfaces for a match to occur. |
| const TEComResolverParams & aResolutionParameters | Specifies any additional implementation characteristics to be fulfilled, maybe empty. |
| TUid aResolverUid | The Uid of a CResolver with client defined behaviour. |
| TUid & aInstanceKey | A 32 bit instance key returned by the ECom framework that identifies the returned instance. |
| TAny * aCreationParameters | A pointer to the creation parameter structure passed to the creation method when called. |
| TBool aCreationParamsFlag | A boolean flag to indicate the existence or non-existence of aCreationParameters. Will be ETrue even for if the value of aCreationParameters is NULL. |
| IMPORT_C void | SetGetParametersL | ( | const TIpcArgs & | aArgs | ) | [static] |
| const TIpcArgs & aArgs | Arguments used for sending and receiving parameters |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.