Collapse all Symbian^3 Product Developer Library

CXIMPEventCapsule Class Reference

class CXIMPEventCapsule : public CObject

Event capsulation for shared ownership.

ximpprocessor.lib

Since: S60 v3.2

Inherits from

CXIMPEventCapsule
- CObject
  - CBase

Public Member Functions
IMPORT_C const TDesC8 &	EventData()
IMPORT_C TXIMPRequestId	EventReqId()
IMPORT_C TInt32	EventType()
IMPORT_C CXIMPEventCapsule *	NewL(CXIMPApiEventBase &, TBool)
IMPORT_C TBool	Ready()
IMPORT_C void	SetReady(TBool)
void	SetTimeStamp(TUint32)
IMPORT_C void	UpdateEventData(CXIMPApiEventBase &)
IMPORT_C void	UpdateEventDataL(CXIMPApiEventBase &)
TBool	operator<(const CXIMPEventCapsule &)

Private Member Functions
	CXIMPEventCapsule(TBool)
	~CXIMPEventCapsule()
void	ConstructL(CXIMPApiEventBase &)
void	InitReqId(const CXIMPApiEventBase &)

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()

Private Attributes
CBufFlat *	iBuffer
RBuf8	iEventBuf
TBool	iEventReady
TInt32	iEventType
TXIMPRequestId	iReqId
TUint32	iTimeStamp

Constructor & Destructor Documentation

CXIMPEventCapsule(TBool)

CXIMPEventCapsule

(

TBool

aEventReady

)

[private]

Parameters

TBool aEventReady

~CXIMPEventCapsule()

~CXIMPEventCapsule

(

)

[private]

Direct deletion not allowed. Deletion happens through reference counting.

Member Functions Documentation

ConstructL(CXIMPApiEventBase &)

void

ConstructL

(

CXIMPApiEventBase &

aEvent

)

[private]

Parameters

CXIMPApiEventBase & aEvent

EventData()

IMPORT_C const TDesC8 &

EventData

(

)

const

Reference to capsulated event

EventReqId()

IMPORT_C TXIMPRequestId

EventReqId

(

)

const

Req Id of capsulated event

EventType()

IMPORT_C TInt32

EventType

(

)

const

Event type for filtering events.

InitReqId(const CXIMPApiEventBase &)

void

InitReqId

(

const CXIMPApiEventBase &

aEvent

)

[private]

Initializes the reg id member if the passed event is req complete type.

Parameters

const CXIMPApiEventBase & aEvent

NewL(CXIMPApiEventBase &, TBool)

IMPORT_C CXIMPEventCapsule *	NewL	(	CXIMPApiEventBase &	aEvent,
			TBool	aEventReady = ETrue
		)	[static]

Construction . Event for capsulation. Ownership transferred.

Parameters

CXIMPApiEventBase & aEvent
TBool aEventReady = ETrue

Ready()

IMPORT_C TBool

Ready

(

)

const

Event is ready

SetReady(TBool)

IMPORT_C void

SetReady

(

TBool

aReady

)

Set event ready for sending.

Parameters

TBool aReady

SetTimeStamp(TUint32)

void

SetTimeStamp

(

TUint32

aTimeStamp

)

Set timestamp for order check.

Parameters

TUint32 aTimeStamp

UpdateEventData(CXIMPApiEventBase &)

IMPORT_C void

UpdateEventData

(

CXIMPApiEventBase &

aEvent

)

Parameters

CXIMPApiEventBase & aEvent

UpdateEventDataL(CXIMPApiEventBase &)

IMPORT_C void

UpdateEventDataL

(

CXIMPApiEventBase &

aEvent

)

Update event data.

Parameters

CXIMPApiEventBase & aEvent

operator<(const CXIMPEventCapsule &)

TBool

operator<

(

const CXIMPEventCapsule &

aOther

)

const

Check which one should be handled first.

Parameters

const CXIMPEventCapsule & aOther

Member Data Documentation

CBufFlat * iBuffer

CBufFlat *

iBuffer

[private]

Used for packing.

RBuf8 iEventBuf

RBuf8

iEventBuf

[private]

Capsulated event. Owns.

TBool iEventReady

TBool

iEventReady

[private]

If event is not ready this is set as ETrue

TInt32 iEventType

TInt32

iEventType

[private]

Event type for filtering

TXIMPRequestId iReqId

TXIMPRequestId

iReqId

[private]

Request ID.

TUint32 iTimeStamp

TUint32

iTimeStamp

[private]

Time stamp for order.