| class MXIMPContext : public MXIMPBase |
Interface for XIMP context. This interface is implemented by the XIMP Framework.
MXIMPContext is root interface for accessing and updating XIMP data to remote XIMP service. MXIMPContext client binds MXIMPContext interface to desired remote XIMP service and uses other MXIMPContext sub interfaces to publish and access XIMP data.
All Presence events (context state, XIMP data, request completion etc. ones) are delivered through MXIMPContextObserver interface.
| Public Member Functions | |
|---|---|
| ~MXIMPContext () | |
| TXIMPRequestId | BindToL ( TUid , const TDesC16 &, const TDesC16 &, const TDesC16 &, TInt32 ) |
| TXIMPRequestId | BindToL ( TUid , const TDesC16 &, const TDesC16 &, const TDesC16 &, const TDesC16 &, TInt32 ) |
| TXIMPRequestId | BindToL ( TUid , TInt ) |
| TXIMPRequestId | BindToL ( TUid , const TDesC16 &, const TDesC16 &, TInt ) |
| MXIMPFeatureInfo * | GetContextFeaturesLC () |
| MXIMPObjectFactory & | ObjectFactory () |
| void | RegisterObserverL ( MXIMPContextObserver &, const TArray < TInt32 > *) |
| TXIMPRequestId | UnbindL () |
| void | UnregisterObserver ( MXIMPContextObserver &) |
| Inherited Functions | |
|---|---|
| MXIMPBase::GetInterface(TInt32,TIfGetOps) | |
| MXIMPBase::GetInterface(TInt32,TIfGetOps)const | |
| MXIMPBase::GetInterfaceId()const | |
| MXIMPBase::~MXIMPBase() | |
| Inherited Enumerations | |
|---|---|
| MXIMPBase:@65 | |
| MXIMPBase:TIfGetOps | |
| ~MXIMPContext | ( | ) | [inline, virtual] |
Public destructor. Objects can be deleted through this interface.
| TXIMPRequestId | BindToL | ( | TUid | aProtocolImpUid, |
| const TDesC16 & | aServiceAddress, | |||
| const TDesC16 & | aUsername, | |||
| const TDesC16 & | aPassword, | |||
| TInt32 | aIapId | |||
| ) | [pure virtual] | |||
Binds the XIMP context to remote XIMP service.
Binds the XIMP context to given XIMP service, with given credentials and by using defined protocol plug-in. Binding is asynchronous operation and evolves network interaction. Used protocol plug-in is identified explicitly with its implementation UID.
| TUid aProtocolImpUid | Protocol implementation UID identifying which PSC protocol implementation to use. |
| const TDesC16 & aServiceAddress | Service address string identifying the remote XIMP service. |
| const TDesC16 & aUsername | Username (credential) for accessing the remote XIMP service. |
| const TDesC16 & aPassword | Password (credential) for accessing the remote XIMP service. |
| TInt32 aIapId | Internet Accesspoint for accessing the remote XIMP service connection. |
| TXIMPRequestId | BindToL | ( | TUid | aProtocolImpUid, |
| const TDesC16 & | aServiceAddress, | |||
| const TDesC16 & | aUsername, | |||
| const TDesC16 & | aPassword, | |||
| const TDesC16 & | aClientId, | |||
| TInt32 | aIapId | |||
| ) | [pure virtual] | |||
| TXIMPRequestId | BindToL | ( | TUid | aProtocolImpUid, |
| TInt | aServiceId | |||
| ) | [pure virtual] | |||
Binds the XIMP context to remote XIMP service.
Binds the XIMP context to given XIMP service, with given credentials and by using defined protocol plug-in. Binding is asynchronous operation and evolves network interaction. Used protocol plug-in is identified explicitly with its implementation UID.
| TXIMPRequestId | BindToL | ( | TUid | aProtocolImpUid, |
| const TDesC16 & | aUsername, | |||
| const TDesC16 & | aPassword, | |||
| TInt | aServiceId | |||
| ) | [pure virtual] | |||
| MXIMPFeatureInfo * | GetContextFeaturesLC | ( | ) | const [pure virtual] |
Retrieves Presence Contex features.
Retrieves features supported by the Presence Contex. Features returned here may be "less" than what the protocol indicated, since connected remote service may limit available features.
| MXIMPObjectFactory & | ObjectFactory | ( | ) | const [pure virtual] |
Gets reference to object factory interface.
Returned object factory interface is used to instantiate XIMP objects.
| void | RegisterObserverL | ( | MXIMPContextObserver & | aObserver, |
| const TArray < TInt32 > * | aEventFilter = NULL | |||
| ) | [pure virtual] | |||
Reqisters XIMP context event observer.
Reqisters observer is notified from XIMP context events. XIMP Framework client side events are listed in MXIMPContextObserver header.
Event delivery uses client side active object to callback the reqistered observer. If client thread is blocked with User::WaitFor...() or other high priority active objects, event notification is delayed until XIMP Framework client side active objects get their execution turn. When client is blocked, XIMP Framework queues events, and delivers those later in FIFO order to observer. However, the XIMP Framework limits the que size and thus events might get dropped if the the client is blocked too long.
Data management relatred asynchronous & synchronous requests
Observer registeration and unregisteration
Presence context undbind
Presence contex destroy
| MXIMPContextObserver & aObserver | The observer to be notified from context events. If the observer is already registered, event filter associated to it is updated. |
| const TArray < TInt32 > * aEventFilter = NULL | List of event types that the observer accepts. Event types are identified with their event interface IDs. If NULL, all event types are delivered to observer. |
| TXIMPRequestId | UnbindL | ( | ) | [pure virtual] |
Unbinds the XIMP context from the to currently binded XIMP service. Unbinding is asynchronous operation and might evolve network operations. Unbinding or waiting unbinding completion isn't mandatory for the client. XIMPFw performs unbinding implicitly when the bound MXIMPContext object is destroyed.
| void | UnregisterObserver | ( | MXIMPContextObserver & | aObserver | ) | [pure virtual] |
Unregisters context event observer.
| MXIMPContextObserver & 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.