MProtocolPresenceWatchingDataHost Class Reference

class MProtocolPresenceWatchingDataHost : public MXIMPBase

Interface for managing cached subscribed presence information.

Interface is used by protocol adaptations to manage manage presentities presence information stored in XIMP Framework internal data cache.

This interface is implemented by XIMP Framework. Protocol adaptation can obtain reference to this interface from MXIMPProtocolConnectionHost interface.

For each separated protocol connection, protocol adaptation must use the specific MProtocolPresentityGroupsDataHost instance, what is received from the connection specific MXIMPProtocolConnectionHost instance.

Since
S60 v3.2

Inherits from

Constructor & Destructor Documentation

~MProtocolPresenceWatchingDataHost()

~MProtocolPresenceWatchingDataHost ( ) [protected, inline, virtual]

Protected destructor. Object instancies can't be deleted via this interface.

Member Functions Documentation

HandleSubscribedPresentityPresenceL(MXIMPIdentity *, MPresenceInfo *)

TXIMPRequestId HandleSubscribedPresentityPresenceL ( MXIMPIdentity * aPresentityId,
MPresenceInfo * aPresenceInfo
) [pure virtual]

Notifies XIMP Framework from subscribed presentitys presence information.

Protocol adaptation implementation can call this method to notify XIMP Framework from subscribed presentitys presence information. XIMP Framework updates its cached presentitys presence status, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL argument(s) were provided.

Parameters

MXIMPIdentity * aPresentityId MXIMPIdentity object identifying the presentity of which subscribed presence information is delivered here.
MPresenceInfo * aPresenceInfo MPresenceInfo object containing new presence information for the identified presentity.

PresentityPresenceDataSubscriptionState(const MXIMPIdentity &)

const MXIMPDataSubscriptionState & PresentityPresenceDataSubscriptionState ( const MXIMPIdentity & aPresentityId ) const [pure virtual]

Gets data subscription state for presentitys presence information.

Protocol adaptation can call this method to retrieve presentitys presence information data subscription state. Protocol adaptation can use data subscription state information, to optimize its own processing and network trafic amount.

Parameters

const MXIMPIdentity & aPresentityId

SetPresentityPresenceDataSubscriptionStateL(MXIMPIdentity *, MXIMPDataSubscriptionState *, MXIMPStatus *)

TXIMPRequestId SetPresentityPresenceDataSubscriptionStateL ( MXIMPIdentity * aPresentityId,
MXIMPDataSubscriptionState * aSubscriptionState,
MXIMPStatus * aStatus
) [pure virtual]

Updates data subscription state for presentitys presence information.

Updates data subscription state for presentitys presence subscription. XIMP Framework calculates the subscription state change, from previous presentitys presence information content, and notifies the subscribing clients from data changes.

XIMP Framework takes ownership of the argument(s), if method succeeds without a leave.

leave
KErrNoMemory if failed to allocate memory.
leave
KErrArgument if NULL subscription state argument was provided.

Parameters

MXIMPIdentity * aPresentityId MXIMPIdentity object identifying the presentity of which presence data subscription state is updated here.
MXIMPDataSubscriptionState * aSubscriptionState New data subscription state for presentitys presence information.
MXIMPStatus * aStatus Optional status object describing the the reason, why protocol adaptation updated data item subscription state. Given status object is passed to clients through data item specific data change event. NULL value is accepted.