Collapse all Symbian^3 Product Developer Library

CXIMPSubscriptionItemBase Class Reference

class CXIMPSubscriptionItemBase : public CObject

PSC subscription implementation

Since: S60 v3.2

Inherits from

CXIMPSubscriptionItemBase
- CObject
  - CBase

Public Member Functions
	CXIMPSubscriptionItemBase(MXIMPItemParentBase &)
IMPORT_C void	ActivateSubscriberL(CXIMPSubscriptionItemBase *)
IMPORT_C void	ActivateSubscriberL(MXIMPPscContext *)
IMPORT_C void	AddSubscriberL(MXIMPPscContext *)
IMPORT_C void	AddSubscriberL(CXIMPSubscriptionItemBase *)
IMPORT_C void	BaseConstructL()
IMPORT_C void	ChangeStatusAfterAdd()
IMPORT_C void	ChangeStatusAfterRemove()
IMPORT_C TBool	CleanIfExpired()
IMPORT_C MXIMPPscContext &	Context(TInt)
IMPORT_C TInt	ContextCount()
IMPORT_C TInt	CountOfSubscribers()
IMPORT_C const MXIMPDataSubscriptionState &	DataSubscriptionState()
IMPORT_C void	ForceClose()
IMPORT_C TBool	IsContext(MXIMPPscContext *)
TInt	OrderOfContexts(const MXIMPPscContext &, const MXIMPPscContext &)
TInt	OrderOfItems(const CXIMPSubscriptionItemBase &, const CXIMPSubscriptionItemBase &)
IMPORT_C void	RemoveSubscriber(MXIMPPscContext *)
IMPORT_C void	RemoveSubscriber(CXIMPSubscriptionItemBase *)
IMPORT_C void	SetDataSubscriptionStateL(CXIMPDataSubscriptionStateImp &)
IMPORT_C CXIMPDataSubscriptionStateImp *	StatusLC(MXIMPPscContext *)
IMPORT_C TSubscriptionStatus	SubscriptionStatus(MXIMPPscContext *)
IMPORT_C void	SynthesiseSubscriptionEventToAllCtxsL()
IMPORT_C void	UpdateExpirationL()
IMPORT_C void	UpdateSubscriptionStateL(TSubscriptionEvent)

Protected Member Functions
	~CXIMPSubscriptionItemBase()
void	CleanExpired()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CObject::AccessCount()const
	CObject::CObject()
	CObject::Close()
	CObject::Dec()
	CObject::Extension_(TUint,TAny &,TAny )
	CObject::FullName()const
	CObject::Inc()
	CObject::Name()const
	CObject::Open()
	CObject::Owner()const
	CObject::SetName(const TDesC *)
	CObject::SetNameL(const TDesC *)
	CObject::SetOwner(CObject *)
	CObject::UniqueID()const
	CObject::~CObject()

Public Member Enumerations
enum	TSubscriptionEvent { ECompleteDataReceived }
enum	TSubscriptionStatus { ENotSubscribedAtAll, ESubscribedForOtherCtxOnly, ESubscribedForCtxOnly, ESubscribedForCtxAndOthers }

Protected Attributes
RPointerArray< MXIMPPscContext >	iContexts
TTime	iExpireTime
RPointerArray< CXIMPSubscriptionItemBase >	iItems
MXIMPItemParentBase &	iParent
RPointerArray< MXIMPPscContext >	iPreContexts
RPointerArray< CXIMPSubscriptionItemBase >	iPreItems
CXIMPDataSubscriptionStateImp *	iSubscriptionState

Constructor & Destructor Documentation

CXIMPSubscriptionItemBase(MXIMPItemParentBase &)

IMPORT_C

CXIMPSubscriptionItemBase

(

MXIMPItemParentBase &

aParent

)

Construction

Parameters

MXIMPItemParentBase & aParent

~CXIMPSubscriptionItemBase()

IMPORT_C

~CXIMPSubscriptionItemBase

(

)

[protected, virtual]

Destruction

Remember to inform parent about delete.

Member Functions Documentation

ActivateSubscriberL(CXIMPSubscriptionItemBase *)

IMPORT_C void

ActivateSubscriberL

(

CXIMPSubscriptionItemBase *

aItem

)

Activate subscriber for item.

Parameters

CXIMPSubscriptionItemBase * aItem

ActivateSubscriberL(MXIMPPscContext *)

IMPORT_C void

ActivateSubscriberL

(

MXIMPPscContext *

aContext

)

MXIMPSubscriptionItem

Parameters

MXIMPPscContext * aContext

AddSubscriberL(MXIMPPscContext *)

IMPORT_C void

AddSubscriberL

(

MXIMPPscContext *

aContext

)

Add subscriber for item.

Parameters

MXIMPPscContext * aContext

AddSubscriberL(CXIMPSubscriptionItemBase *)

IMPORT_C void

AddSubscriberL

(

CXIMPSubscriptionItemBase *

aItem

)

Add subscriber for item.

Parameters

CXIMPSubscriptionItemBase * aItem

BaseConstructL()

IMPORT_C void

BaseConstructL

(

)

Base construction. Must be called from inherited classes ConstructL

ChangeStatusAfterAdd()

IMPORT_C void

ChangeStatusAfterAdd

(

)

Change status after subscriber is added/removed.

ChangeStatusAfterRemove()

IMPORT_C void

ChangeStatusAfterRemove

(

)

CleanExpired()

void

CleanExpired

(

)

[protected, pure virtual]

Clean data because expiration

CleanIfExpired()

IMPORT_C TBool

CleanIfExpired

(

)

Clean item if expired.

Context(TInt)

IMPORT_C MXIMPPscContext &

Context

(

TInt

aIndex

)

Reference to context in index.

Parameters

TInt aIndex

ContextCount()

IMPORT_C TInt

ContextCount

(

)

const

Count of subscribed contexts.

CountOfSubscribers()

IMPORT_C TInt

CountOfSubscribers

(

)

Count of subscribers. Items counted as 1.

DataSubscriptionState()

IMPORT_C const MXIMPDataSubscriptionState &

DataSubscriptionState

(

)

ForceClose()

IMPORT_C void

ForceClose

(

)

Call RemoveSubscriber for all contexts registered to item.

IsContext(MXIMPPscContext *)

IMPORT_C TBool

IsContext

(

MXIMPPscContext *

aContext

)

const

Can context be found from contexts.

Parameters

MXIMPPscContext * aContext

OrderOfContexts(const MXIMPPscContext &, const MXIMPPscContext &)

TInt	OrderOfContexts	(	const MXIMPPscContext &	aFirst,
			const MXIMPPscContext &	aSecond
		)	[static]

For linear ordering by pointers

Parameters

const MXIMPPscContext & aFirst
const MXIMPPscContext & aSecond

OrderOfItems(const CXIMPSubscriptionItemBase &, const CXIMPSubscriptionItemBase &)

TInt	OrderOfItems	(	const CXIMPSubscriptionItemBase &	aFirst,
			const CXIMPSubscriptionItemBase &	aSecond
		)	[static]

For linear ordering by pointers

Parameters

const CXIMPSubscriptionItemBase & aFirst
const CXIMPSubscriptionItemBase & aSecond

RemoveSubscriber(MXIMPPscContext *)

IMPORT_C void

RemoveSubscriber

(

MXIMPPscContext *

aContext

)

Remove subscriber from item

Parameters

MXIMPPscContext * aContext

RemoveSubscriber(CXIMPSubscriptionItemBase *)

IMPORT_C void

RemoveSubscriber

(

CXIMPSubscriptionItemBase *

aItem

)

Remove subscriber from item

Parameters

CXIMPSubscriptionItemBase * aItem

SetDataSubscriptionStateL(CXIMPDataSubscriptionStateImp &)

IMPORT_C void

SetDataSubscriptionStateL

(

CXIMPDataSubscriptionStateImp &

aNewState

)

MXIMPSubscriptionItem

Parameters

CXIMPDataSubscriptionStateImp & aNewState

StatusLC(MXIMPPscContext *)

IMPORT_C CXIMPDataSubscriptionStateImp *

StatusLC

(

MXIMPPscContext *

aContext

)

const

Status for context

Parameters

MXIMPPscContext * aContext

SubscriptionStatus(MXIMPPscContext *)

IMPORT_C TSubscriptionStatus

SubscriptionStatus

(

MXIMPPscContext *

aContext

)

Subscriptionstatus for context.

ENotSubscribedAtAll - Subscribe not done by any context. ESubscribedForOtherCtxOnly - Subscribe done by others but not aContext ESubscribedForCtxOnly - Subscribe done by aContext only. ESubscribedForCtxAndOthers - Subscribe done by others and aContext.

Parameters

MXIMPPscContext * aContext

Check subscription status for aContext.

SynthesiseSubscriptionEventToAllCtxsL()

IMPORT_C void

SynthesiseSubscriptionEventToAllCtxsL

(

)

MXIMPSubscriptionItem

UpdateExpirationL()

IMPORT_C void

UpdateExpirationL

(

)

Update time to new expire time.

UpdateSubscriptionStateL(TSubscriptionEvent)

IMPORT_C void

UpdateSubscriptionStateL

(

TSubscriptionEvent

aUpdateState

)

Update subscription based on event happened.

Parameters

TSubscriptionEvent aUpdateState

Member Enumerations Documentation

Enum TSubscriptionEvent

Subscription update event. Update subscription based on event.

Enumerators

ECompleteDataReceived

Enum TSubscriptionStatus

Subscription status

Enumerators

ENotSubscribedAtAll
ESubscribedForOtherCtxOnly
ESubscribedForCtxOnly
ESubscribedForCtxAndOthers

Member Data Documentation

RPointerArray< MXIMPPscContext > iContexts

RPointerArray< MXIMPPscContext >

iContexts

[protected]

Subscribed contexts.

TTime iExpireTime

TTime

iExpireTime

[protected]

Time when ready for expire.

RPointerArray< CXIMPSubscriptionItemBase > iItems

RPointerArray< CXIMPSubscriptionItemBase >

iItems

[protected]

MXIMPItemParentBase & iParent

MXIMPItemParentBase &

iParent

[protected]

Parent object to inform when object is deleted. Used also for sending events.

RPointerArray< MXIMPPscContext > iPreContexts

RPointerArray< MXIMPPscContext >

iPreContexts

[protected]

RPointerArray< CXIMPSubscriptionItemBase > iPreItems

RPointerArray< CXIMPSubscriptionItemBase >

iPreItems

[protected]

CXIMPDataSubscriptionStateImp * iSubscriptionState

CXIMPDataSubscriptionStateImp *

iSubscriptionState

[protected]

Current presence info status.