Symbian^3 Application Developer Library >

MXIMPHost Class Reference

class MXIMPHost

?one_line_short_description

?more_complete_description

?library
Since
S60 v4.0
Public Member Functions
void ActivateEventL ( CXIMPApiEventBase &, MXIMPPscContext *)
void AddEventL ( CXIMPApiEventBase &, MXIMPPscContext *)
void AddNewOperationL ( CXIMPOperationBase &)
TXIMPRequestId AddNewOperationL ( CXIMPOperationBase *)
TXIMPRequestId AddNewOperationL ( TInt , MXIMPBase *, MXIMPBase *)
void Close ()
void FakeCompleteRequest ( TXIMPRequestId , TInt )
void ForcedTeardownL ()
MXIMPProtocolConnection & GetConnection ()
TAny * GetProtocolHost ( TInt )
void HandleAdaptationRequestCompleted ( TXIMPRequestId , TInt )
void HandleInternalRequestCompleted ( TXIMPRequestId , TInt )
void HandleSessionMgmtRequestCompleted ( TXIMPRequestId , TInt )
void Open ()
CProtocolPresenceDataHostImp & PresenceDataAccess ()
TInt32 ProtocolUID ()
void StartCleanerTimer ()
void UnregisterSession ( 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 *)

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

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

Parameters

CXIMPApiEventBase & aEvent The event
MXIMPPscContext * aContext The session context

AddEventL(CXIMPApiEventBase &, MXIMPPscContext *)

void AddEventL ( 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 & aEvent The event
MXIMPPscContext * aContext = NULL The session context. If NULL -> send to all contexts.

AddNewOperationL(CXIMPOperationBase &)

void AddNewOperationL ( CXIMPOperationBase & aOperation ) [pure virtual]

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

Parameters

CXIMPOperationBase & aOperation The 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 ( TInt aOperation,
MXIMPBase * aParam,
MXIMPBase * aParam2 = NULL
) [pure virtual]

Create operation and add it to process queue.

Parameters

TInt aOperation
MXIMPBase * aParam
MXIMPBase * aParam2 = NULL

Close()

void Close ( ) [pure virtual]

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

FakeCompleteRequest(TXIMPRequestId, TInt)

void FakeCompleteRequest ( TXIMPRequestId aReqId,
TInt aResult
) [pure virtual]

Fake a request complete event to currently run operation.

Parameters

TXIMPRequestId aReqId
TInt aResult The result

ForcedTeardownL()

void ForcedTeardownL ( ) [pure virtual]

Do forced teardown by activating all valid cached unbinds.

GetConnection()

MXIMPProtocolConnection & GetConnection ( ) const [pure virtual]

GetProtocolHost(TInt)

TAny * GetProtocolHost ( TInt aInterfaceId ) [pure virtual]

to get corresponding protocol host from the array of hosts.

Parameters

TInt aInterfaceId host object interface id

HandleAdaptationRequestCompleted(TXIMPRequestId, TInt)

void HandleAdaptationRequestCompleted ( TXIMPRequestId aReqId,
TInt aResult
) [pure virtual]

Request complete for adaptation operation

Parameters

TXIMPRequestId aReqId
TInt aResult The result

HandleInternalRequestCompleted(TXIMPRequestId, TInt)

void HandleInternalRequestCompleted ( TXIMPRequestId aReqId,
TInt aResult
) [pure virtual]

Request complete for internal operation

Parameters

TXIMPRequestId aReqId
TInt aResult The result

HandleSessionMgmtRequestCompleted(TXIMPRequestId, TInt)

void HandleSessionMgmtRequestCompleted ( TXIMPRequestId aReqId,
TInt aResult
) [pure virtual]

Request complete for adaptation operation, related to session management

Parameters

TXIMPRequestId aReqId
TInt aResult The result

Open()

void Open ( ) [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()

void StartCleanerTimer ( ) [pure virtual]

Start cleaner timer if not started already.

UnregisterSession(CXIMPPscContext *)

void UnregisterSession ( CXIMPPscContext * aContext ) [pure virtual]

Unregister session when not needed anymore.

Parameters

CXIMPPscContext * aContext Unregistered 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.