Collapse all Symbian^3 Product Developer Library

CXIMPContextEventQueue Class Reference

class CXIMPContextEventQueue : public CBase

Event queue for client to process.

Inherits from

CXIMPContextEventQueue
- CBase

Public Member Functions
	~CXIMPContextEventQueue()
void	ActivatePreservedEventL(CXIMPApiEventBase &)
void	ActivateRequestCompleteEvent(CXIMPRequestCompleteEventImp &)
void	AddEventL(CXIMPEventCapsule &)
IMPORT_C void	DropTopEvent()
IMPORT_C TBool	HasElements()
IMPORT_C CXIMPContextEventQueue *	NewL()
void	RemoveRequestCompleteEvent(CXIMPRequestCompleteEventImp &)
IMPORT_C void	SelectTopEventIfNeededL()
TUint32	SessionIdOfQueue()
IMPORT_C void	SetEventFilter(CXIMPContextEventFilter &)
void	SetSessionIdOfQueue(TUint32)
IMPORT_C void	StartConsuming(MXIMPEventQueueObserver &)
IMPORT_C void	StopConsuming()
IMPORT_C const TDesC8 &	TopEventDataL()
IMPORT_C TXIMPRequestId	TopEventReqIdL()

Protected Member Functions
	CXIMPContextEventQueue()
void	ConstructL()

Private Member Functions
void	AddPreservedEventL(CXIMPApiEventBase &)
void	ClearQueuedEvents()
TInt	FindNextEvent(RPointerArray< CXIMPEventCapsule > &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Private Attributes
CXIMPContextEventFilter *	iEventFilter
RPointerArray< CXIMPEventCapsule >	iEvents
TUint32	iId
CXIMPEventCapsule *	iNextEventToGo
MXIMPEventQueueObserver *	iObserver
RPointerArray< CXIMPEventCapsule >	iPreservedEvents
RPointerArray< CXIMPEventCapsule >	iRequestCompleteEvents
TUint32	iTimeStamp

Constructor & Destructor Documentation

CXIMPContextEventQueue()

CXIMPContextEventQueue

(

)

[protected]

Construction

~CXIMPContextEventQueue()

~CXIMPContextEventQueue

(

)

Destruction

Member Functions Documentation

ActivatePreservedEventL(CXIMPApiEventBase &)

void

ActivatePreservedEventL

(

CXIMPApiEventBase &

aEvent

)

Activate preserved event for sending.

Parameters

CXIMPApiEventBase & aEvent

ActivateRequestCompleteEvent(CXIMPRequestCompleteEventImp &)

void

ActivateRequestCompleteEvent

(

CXIMPRequestCompleteEventImp &

aEvent

)

Activate new request complete event to queue.

Parameters

CXIMPRequestCompleteEventImp & aEvent

Event to activate.

AddEventL(CXIMPEventCapsule &)

void

AddEventL

(

CXIMPEventCapsule &

aEvent

)

Add new event to queue.

Parameters

CXIMPEventCapsule & aEvent

AddPreservedEventL(CXIMPApiEventBase &)

void

AddPreservedEventL

(

CXIMPApiEventBase &

aEvent

)

[private]

Add new preserved event to queue.

Parameters

CXIMPApiEventBase & aEvent

ClearQueuedEvents()

void

ClearQueuedEvents

(

)

[private]

Clear queued events.

ConstructL()

void

ConstructL

(

)

[protected]

Construction

DropTopEvent()

IMPORT_C void

DropTopEvent

(

)

FindNextEvent(RPointerArray< CXIMPEventCapsule > &)

TInt

FindNextEvent

(

RPointerArray< CXIMPEventCapsule > &

aArray

)

[private]

Find next ready event from array. Timestamp is used to choose first one. iNextEventToGo is filled with oldest event. iNextEventToGo can be filled with reference event before call.

Parameters

RPointerArray< CXIMPEventCapsule > & aArray

HasElements()

IMPORT_C TBool

HasElements

(

)

const

Check if there is elements.

NewL()

IMPORT_C CXIMPContextEventQueue *

NewL

(

)

[static]

Construction

RemoveRequestCompleteEvent(CXIMPRequestCompleteEventImp &)

void

RemoveRequestCompleteEvent

(

CXIMPRequestCompleteEventImp &

aEvent

)

Remove request complete event from queue

Parameters

CXIMPRequestCompleteEventImp & aEvent

Event to remove

SelectTopEventIfNeededL()

IMPORT_C void

SelectTopEventIfNeededL

(

)

SessionIdOfQueue()

TUint32

SessionIdOfQueue

(

)

const [inline]

Get id of queue.

SetEventFilter(CXIMPContextEventFilter &)

IMPORT_C void

SetEventFilter

(

CXIMPContextEventFilter &

aFilter

)

Set event filter for filtering events

Parameters

CXIMPContextEventFilter & aFilter

New filter.

SetSessionIdOfQueue(TUint32)

void

SetSessionIdOfQueue

(

TUint32

aId

)

[inline]

Set id of queue

Parameters

TUint32 aId

Id of queue.

StartConsuming(MXIMPEventQueueObserver &)

IMPORT_C void

StartConsuming

(

MXIMPEventQueueObserver &

aQueueObserver

)

Start consuming events.

Parameters

MXIMPEventQueueObserver & aQueueObserver

Observer to notify when event is ready

StopConsuming()

IMPORT_C void

StopConsuming

(

)

Stop event consuming.

TopEventDataL()

IMPORT_C const TDesC8 &

TopEventDataL

(

)

TopEventReqIdL()

IMPORT_C TXIMPRequestId

TopEventReqIdL

(

)

Member Data Documentation

CXIMPContextEventFilter * iEventFilter

CXIMPContextEventFilter *

iEventFilter

[private]

Event filter. Own.

RPointerArray< CXIMPEventCapsule > iEvents

RPointerArray< CXIMPEventCapsule >

iEvents

[private]

Events array. Reference to events own.

TUint32 iId

TUint32

iId

[private]

Queue ID.

CXIMPEventCapsule * iNextEventToGo

CXIMPEventCapsule *

iNextEventToGo

[private]

Helper variable to contain next event to go.

MXIMPEventQueueObserver * iObserver

MXIMPEventQueueObserver *

iObserver

[private]

Queue observer. Ref.

RPointerArray< CXIMPEventCapsule > iPreservedEvents

RPointerArray< CXIMPEventCapsule >

iPreservedEvents

[private]

Preserved events array. Reference to events own.

RPointerArray< CXIMPEventCapsule > iRequestCompleteEvents

RPointerArray< CXIMPEventCapsule >

iRequestCompleteEvents

[private]

Request complete events waiting for completion.

TUint32 iTimeStamp

TUint32

iTimeStamp

[private]

Timestamp for events.