MXIMPProtocolConnectionHost Class Reference

class MXIMPProtocolConnectionHost : public MXIMPBase

Interface for XIMP protocol connection host. This interface is implemented by XIMP Framework.

XIMP protocol connection host interface defines requests that a XIMP protocol implementation can request (callback) from XIMP Framework.

MXIMPProtocolConnection
Since
S60 v3.2

Inherits from

Constructor & Destructor Documentation

~MXIMPProtocolConnectionHost()

~MXIMPProtocolConnectionHost()[protected, inline, virtual]

Protected destructor. MXIMPProtocolConnectionHost instancies can't be destroyed via this interface.

Member Functions Documentation

HandleConnectionTerminated(MXIMPStatus *)

TXIMPRequestId HandleConnectionTerminated(MXIMPStatus *aReason)[pure virtual]

Notifies XIMP Framework that protocol connection to remote XIMP service is terminated due certain reason.

In this case, XIMP Framework doesn't try to re-open the client sessions.

Parameters

MXIMPStatus * aReasonStatus object describing more closely the protocol connection termination reason. Object ownership is transfered always to XIMP Framework. NULL value is allowed.

HandleRequestCompleted(TXIMPRequestId, TInt)

voidHandleRequestCompleted(TXIMPRequestIdaReqId,
TIntaResultCode
)[pure virtual]

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

Parameters

TXIMPRequestId aReqIdRequest ID identifying the request which handling is completed. This must equal to value given in the processing initiation. If no pending XIMP protocol connection request is found with this request ID, protocol connection is paniced.
TInt aResultCodeResult code from request handling.

HandleRequestCompleted(TXIMPRequestId, MXIMPStatus *)

voidHandleRequestCompleted(TXIMPRequestIdaReqId,
MXIMPStatus *aResult
)[pure virtual]

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

Parameters

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

HandleRequestCompleted(TXIMPRequestId, MXIMPStatus *, MXIMPBase *)

voidHandleRequestCompleted(TXIMPRequestIdaReqId,
MXIMPStatus *aResult,
MXIMPBase *aParameter
)[pure virtual]

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

Parameters

TXIMPRequestId aReqIdRequest ID identifying the request which handling is completed. This must equal to value given in the processing initiation. If no pending XIMP protocol connection request is found with this request ID, protocol connection is paniced.
MXIMPStatus * aResultStatus object describing result from request handling. Object ownership is transfered always to XIMPFw. NULL value not allowed.
MXIMPBase * aParameterAdditional 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.

XIMP protocol connection implementation uses factory interface to instantiate XIMP objects.

ProtocolPresenceDataHost()

MProtocolPresenceDataHost &ProtocolPresenceDataHost()[pure virtual]

Gets reference to MProtocolPresenceDataHost interface.

Presence protocol connection implementation uses returned data host interface to manage the Presence connection's presence auhtorization data.

RegisterObserverL(MXIMPProtocolConnectionHostObserver &, const TArray< TInt32 > *)

voidRegisterObserverL(MXIMPProtocolConnectionHostObserver &aObserver,
const TArray< TInt32 > *aEventFilter = NULL
)[pure virtual]

Reqisters XIMP connection host event observer.

Reqisters observer to be notified from XIMP connection host events.

Parameters

MXIMPProtocolConnectionHostObserver & aObserverThe observer to be notified from XIMP connection host events. If the observer is already registered, event filter associated to observer is updated.
const TArray< TInt32 > * aEventFilter = NULLList of event types that the observer accepts. Event types are identified with their interface IDs. If NULL, all event types are delivered to observer. In this case, observer must be prepared to handle gracefully unknown event types, which are added in future when extending XIMP Framework functionality.

UnregisterConnectionHostObserver(MXIMPProtocolConnectionHostObserver &)

voidUnregisterConnectionHostObserver(MXIMPProtocolConnectionHostObserver &aObserver)[pure virtual]

Unregisters XIMP connection host observer.

Parameters

MXIMPProtocolConnectionHostObserver & aObserverThe observer to unregister.