Symbian^3 Application Developer Library >

MXIMPProtocolPluginHost Class Reference

class MXIMPProtocolPluginHost : public MXIMPBase

Interface for XIMP Protocol Plugin host. This interface is implemented by XIMP Framework.

XIMP Protocol Plugin host interface defines actions that a XIMP protocol plug-in can request (callback) from XIMP Framework.

MXIMPProtocolPlugin CXIMPProtocolPluginBase
Since
S60 v3.2

Inherits from

Public Member Functions
void HandleRequestCompleted ( TXIMPRequestId , TInt )
void HandleRequestCompleted ( TXIMPRequestId , MXIMPStatus *)
void HandleRequestCompleted ( TXIMPRequestId , MXIMPStatus *, MXIMPBase *)
MXIMPObjectFactory & ObjectFactory ()
Protected Member Functions
~MXIMPProtocolPluginHost ()

Constructor & Destructor Documentation

~MXIMPProtocolPluginHost()

~MXIMPProtocolPluginHost ( ) [protected, inline, virtual]

Protected destructor. XIMP Protocol Plugin host instancies can't be destroyed via this interface.

Member Functions Documentation

HandleRequestCompleted(TXIMPRequestId, TInt)

void HandleRequestCompleted ( TXIMPRequestId aReqId,
TInt aResultCode
) [pure virtual]

Notifies XIMP Framework that XIMP protocol plug-in has completed (successfully or otherwise) the request handling.

NOTE: This method isn't yet supported by XIMP Framework, since all MXIMPProtocolPlugin methods are currently synchronous.

Parameters

TXIMPRequestId aReqId Request ID identifying the request which handling is completed. This must equal to value given in the processing initiation. If no pending XIMP protocol plug-in request is found with this ID, plug-in is paniced.
TInt aResultCode Result code from request handling.

HandleRequestCompleted(TXIMPRequestId, MXIMPStatus *)

void HandleRequestCompleted ( TXIMPRequestId aReqId,
MXIMPStatus * aResult
) [pure virtual]

Notifies XIMP Framework that XIMP protocol plug-in has completed (successfully or otherwise) the request handling.

NOTE: This method isn't yet supported by XIMP Framework, since all MXIMPProtocolPlugin methods are currently synchronous.

Parameters

TXIMPRequestId aReqId Request ID identifying the request which handling is completed. This must equal to value given in the processing initiation. If no pending XIMP protocol plug-in request is found with this ID, plug-in is paniced.
MXIMPStatus * aResult Status object describing result from request handling. Object ownership is transfered always to XIMPFw. NULL value not allowed.

HandleRequestCompleted(TXIMPRequestId, MXIMPStatus *, MXIMPBase *)

void HandleRequestCompleted ( TXIMPRequestId aReqId,
MXIMPStatus * aResult,
MXIMPBase * aParameter
) [pure virtual]

Notifies XIMP Framework that XIMP protocol plug-in has completed (successfully or otherwise) the request handling.

NOTE: This method isn't yet supported by XIMP Framework, since all MXIMPProtocolPlugin methods are currently synchronous.

Parameters

TXIMPRequestId aReqId Request ID identifying the request which handling is completed. This must equal to value given in the processing initiation. If no pending XIMP protocol plug-in request is found with this ID, plug-in is paniced.
MXIMPStatus * aResult Status object describing result from request handling. Object ownership is transfered always to XIMPFw. NULL value not allowed.
MXIMPBase * aParameter Additional request complete parameters. NULL if no additional parameters to transfer XIMPFw. Parameter may be single MXIMPBase derived object or MXIMPRestrictedObjectCollection object containing multiple objects. Ownership of given parameter (also the container and contained objects) is transfered always to XIMPFw.

ObjectFactory()

MXIMPObjectFactory & ObjectFactory ( ) [pure virtual]

Gets reference to object factory interface.

Returned object factory interface is used to instantiate XIMP data objects.

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.