| 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.
| Public Member Functions | |
|---|---|
| TXIMPRequestId | HandleConnectionTerminated ( MXIMPStatus *) |
| void | HandleRequestCompleted ( TXIMPRequestId , TInt ) |
| void | HandleRequestCompleted ( TXIMPRequestId , MXIMPStatus *) |
| void | HandleRequestCompleted ( TXIMPRequestId , MXIMPStatus *, MXIMPBase *) |
| MXIMPObjectFactory & | ObjectFactory () |
| MProtocolPresenceDataHost & | ProtocolPresenceDataHost () |
| void | RegisterObserverL (MXIMPProtocolConnectionHostObserver &, const TArray < TInt32 > *) |
| void | UnregisterConnectionHostObserver (MXIMPProtocolConnectionHostObserver &) |
| Protected Member Functions | |
|---|---|
| ~MXIMPProtocolConnectionHost () | |
| Inherited Functions | |
|---|---|
| MXIMPBase::GetInterface(TInt32,TIfGetOps) | |
| MXIMPBase::GetInterface(TInt32,TIfGetOps)const | |
| MXIMPBase::GetInterfaceId()const | |
| MXIMPBase::~MXIMPBase() | |
| Inherited Enumerations | |
|---|---|
| MXIMPBase:@26 | |
| MXIMPBase:TIfGetOps | |
| ~MXIMPProtocolConnectionHost | ( | ) | [protected, inline, virtual] |
Protected destructor. MXIMPProtocolConnectionHost instancies can't be destroyed via this interface.
| 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.
| MXIMPStatus * aReason | Status object describing more closely the protocol connection termination reason. Object ownership is transfered always to XIMP Framework. NULL value is allowed. |
| void | HandleRequestCompleted | ( | TXIMPRequestId | aReqId, |
| TInt | aResultCode | |||
| ) | [pure virtual] | |||
Notifies XIMP Framework that protocol connection has completed (successfully or otherwise) the request handling.
| 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 connection request is found with this request ID, protocol connection is paniced. |
| TInt aResultCode | Result code from request handling. |
| void | HandleRequestCompleted | ( | TXIMPRequestId | aReqId, |
| MXIMPStatus * | aResult | |||
| ) | [pure virtual] | |||
Notifies XIMP Framework that protocol connection has completed (successfully or otherwise) the request handling.
| 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 connection request is found with this request ID, protocol connection is paniced. |
| MXIMPStatus * aResult | Status object describing result from request handling. Object ownership is transfered always to XIMPFw. NULL value not allowed. |
| void | HandleRequestCompleted | ( | TXIMPRequestId | aReqId, |
| MXIMPStatus * | aResult, | |||
| MXIMPBase * | aParameter | |||
| ) | [pure virtual] | |||
Notifies XIMP Framework that protocol connection has completed (successfully or otherwise) the request handling.
| 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 connection request is found with this request ID, protocol connection 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. |
| MXIMPObjectFactory & | ObjectFactory | ( | ) | [pure virtual] |
Gets reference to object factory interface.
XIMP protocol connection implementation uses factory interface to instantiate XIMP objects.
| 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.
| void | RegisterObserverL | ( | 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.
| MXIMPProtocolConnectionHostObserver & aObserver | The 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 = NULL | List 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. |
| void | UnregisterConnectionHostObserver | ( | MXIMPProtocolConnectionHostObserver & | aObserver | ) | [pure virtual] |
Unregisters XIMP connection host observer.
| MXIMPProtocolConnectionHostObserver & aObserver | The observer to unregister. |
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.