Symbian^3 Product Developer Library >

MXIMPHost Class Reference

class MXIMPHost

?one_line_short_description

?more_complete_description

?library
Since
S60 v4.0
Public Member Functions
voidActivateEventL(CXIMPApiEventBase &, MXIMPPscContext *)
voidAddEventL(CXIMPApiEventBase &, MXIMPPscContext *)
voidAddNewOperationL(CXIMPOperationBase &)
TXIMPRequestId AddNewOperationL(CXIMPOperationBase *)
TXIMPRequestId AddNewOperationL(TInt, MXIMPBase *, MXIMPBase *)
voidClose()
voidFakeCompleteRequest(TXIMPRequestId, TInt)
voidForcedTeardownL()
MXIMPProtocolConnection &GetConnection()
TAny *GetProtocolHost(TInt)
voidHandleAdaptationRequestCompleted(TXIMPRequestId, TInt)
voidHandleInternalRequestCompleted(TXIMPRequestId, TInt)
voidHandleSessionMgmtRequestCompleted(TXIMPRequestId, TInt)
voidOpen()
CProtocolPresenceDataHostImp &PresenceDataAccess()
TInt32 ProtocolUID()
voidStartCleanerTimer()
voidUnregisterSession(CXIMPPscContext *)
Protected Member Functions
~MXIMPHost()

Constructor & Destructor Documentation

~MXIMPHost()

~MXIMPHost()[protected, inline, virtual]

Protected destructor. Instancies can't be destroyed via this interface.

Member Functions Documentation

ActivateEventL(CXIMPApiEventBase &, MXIMPPscContext *)

voidActivateEventL(CXIMPApiEventBase &aEvent,
MXIMPPscContext *aContext
)[pure virtual]

Add preserved event to the event manager. The event will go to the given session.

Parameters

CXIMPApiEventBase & aEventThe event
MXIMPPscContext * aContextThe session context

AddEventL(CXIMPApiEventBase &, MXIMPPscContext *)

voidAddEventL(CXIMPApiEventBase &aEvent,
MXIMPPscContext *aContext = NULL
)[pure virtual]

Add the given event to the event manager. The event will go to the given session.

Parameters

CXIMPApiEventBase & aEventThe event
MXIMPPscContext * aContext = NULLThe session context. If NULL -> send to all contexts.

AddNewOperationL(CXIMPOperationBase &)

voidAddNewOperationL(CXIMPOperationBase &aOperation)[pure virtual]

Add new operation to the internal queue of operations. Ownership is transferred.

Parameters

CXIMPOperationBase & aOperationThe operation to add.

AddNewOperationL(CXIMPOperationBase *)

TXIMPRequestId AddNewOperationL(CXIMPOperationBase *aOperation)[pure virtual]

Add new operation for processing.

Parameters

CXIMPOperationBase * aOperation

AddNewOperationL(TInt, MXIMPBase *, MXIMPBase *)

TXIMPRequestId AddNewOperationL(TIntaOperation,
MXIMPBase *aParam,
MXIMPBase *aParam2 = NULL
)[pure virtual]

Create operation and add it to process queue.

Parameters

TInt aOperation
MXIMPBase * aParam
MXIMPBase * aParam2 = NULL

Close()

voidClose()[pure virtual]

Remove a reference to this object. Once all references are removed, the class destroys itself.

FakeCompleteRequest(TXIMPRequestId, TInt)

voidFakeCompleteRequest(TXIMPRequestIdaReqId,
TIntaResult
)[pure virtual]

Fake a request complete event to currently run operation.

Parameters

TXIMPRequestId aReqId
TInt aResultThe result

ForcedTeardownL()

voidForcedTeardownL()[pure virtual]

Do forced teardown by activating all valid cached unbinds.

GetConnection()

MXIMPProtocolConnection &GetConnection()const [pure virtual]

GetProtocolHost(TInt)

TAny *GetProtocolHost(TIntaInterfaceId)[pure virtual]

to get corresponding protocol host from the array of hosts.

Parameters

TInt aInterfaceIdhost object interface id

HandleAdaptationRequestCompleted(TXIMPRequestId, TInt)

voidHandleAdaptationRequestCompleted(TXIMPRequestIdaReqId,
TIntaResult
)[pure virtual]

Request complete for adaptation operation

Parameters

TXIMPRequestId aReqId
TInt aResultThe result

HandleInternalRequestCompleted(TXIMPRequestId, TInt)

voidHandleInternalRequestCompleted(TXIMPRequestIdaReqId,
TIntaResult
)[pure virtual]

Request complete for internal operation

Parameters

TXIMPRequestId aReqId
TInt aResultThe result

HandleSessionMgmtRequestCompleted(TXIMPRequestId, TInt)

voidHandleSessionMgmtRequestCompleted(TXIMPRequestIdaReqId,
TIntaResult
)[pure virtual]

Request complete for adaptation operation, related to session management

Parameters

TXIMPRequestId aReqId
TInt aResultThe result

Open()

voidOpen()[pure virtual]

Mark a reference to this object.

PresenceDataAccess()

CProtocolPresenceDataHostImp &PresenceDataAccess()[pure virtual]

Access to data cache.

ProtocolUID()

TInt32 ProtocolUID()[pure virtual]

Return the protocol ID of the host

StartCleanerTimer()

voidStartCleanerTimer()[pure virtual]

Start cleaner timer if not started already.

UnregisterSession(CXIMPPscContext *)

voidUnregisterSession(CXIMPPscContext *aContext)[pure virtual]

Unregister session when not needed anymore.

Parameters

CXIMPPscContext * aContextUnregistered context.

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.