Collapse all Symbian^3 Application Developer Library

Messages::TRuntimeCtxId Class Reference

class Messages::TRuntimeCtxId

TRuntimeCtxId is the baseclass intended for addressing message ( TSignalBase ) destinations, i.e.: As implied by the respective API, the sender of a TSignalBase must supply a TRuntimeCtxId object.

TRuntimeCtxId defines the maximum size of the addressing structure and its bedrock composition (namely: the destination thread of execution).

TSignalBase

Public Member Functions
	TRuntimeCtxId ()
	TRuntimeCtxId (const TRuntimeCtxId &)
IMPORT_C TBool	ComparePart (const TRuntimeCtxId &, TUint8 )
TBool	IsNull ()
IMPORT_C const TRuntimeCtxId &	NullId ()
IMPORT_C void	PostTo (const TRuntimeCtxId &, const TSignalBase &)
TUint8	Salt ()
TUint32	Scope ()
void	SetNull ()
TUint8	Size ()
IMPORT_C TInt	Store ( TDes8 &)
TUint16	Thread ()
TBool	operator!= (const TRuntimeCtxId &)
IMPORT_C const TRuntimeCtxId &	operator= (const TRuntimeCtxId &)
IMPORT_C TBool	operator== (const TRuntimeCtxId &)

Protected Member Functions
	TRuntimeCtxId ( TUint8 )

Private Attributes
TUint8	iSalt
TUint32	iScope
TUint8	iSize
TUint16	iThread

Constructor & Destructor Documentation

TRuntimeCtxId()

IMPORT_C

TRuntimeCtxId

(

)

[explicit]

TRuntimeCtxId(const TRuntimeCtxId &)

IMPORT_C

TRuntimeCtxId

(

const TRuntimeCtxId &

aRuntimeCtxId

)

Copy constructor

Parameters

const TRuntimeCtxId & aRuntimeCtxId

runtime context id to copy

TRuntimeCtxId(TUint8)

IMPORT_C

TRuntimeCtxId

(

TUint8

aSize

)

[protected, explicit]

Parameters

TUint8 aSize

size in bytes of the new id

Member Functions Documentation

ComparePart(const TRuntimeCtxId &, TUint8)

IMPORT_C TBool	ComparePart	(	const TRuntimeCtxId &	aRHS,
			TUint8	aSize
		)	const

Compare the first aSize bytes of this runtime context id with aRHS

Parameters

const TRuntimeCtxId & aRHS	runtime context id to compare against
TUint8 aSize	number of bytes to compare

IsNull()

TBool

IsNull

(

)

const [inline]

NullId()

IMPORT_C const TRuntimeCtxId &

NullId

(

)

[static]

PostTo(const TRuntimeCtxId &, const TSignalBase &)

IMPORT_C void	PostTo	(	const TRuntimeCtxId &	aPostFrom,
			const TSignalBase &	aMessage
		)	const

Post a message to the addressed object.

Parameters

const TRuntimeCtxId & aPostFrom	address of sender
const TSignalBase & aMessage	message to send

Salt()

TUint8

Salt

(

)

const [inline]

Scope()

TUint32

Scope

(

)

const [inline]

SetNull()

void

SetNull

(

)

[inline]

Make this id a null id

Size()

TUint8

Size

(

)

const [inline]

Store(TDes8 &)

IMPORT_C TInt

Store

(

TDes8 &

aDes

)

const

Serialise into a descriptor

Parameters

TDes8 & aDes

descriptor to serialise into

Thread()

TUint16

Thread

(

)

const [inline]

operator!=(const TRuntimeCtxId &)

TBool

operator!=

(

const TRuntimeCtxId &

aRHS

)

const [inline]

operator==

Parameters

const TRuntimeCtxId & aRHS

operator=(const TRuntimeCtxId &)

IMPORT_C const TRuntimeCtxId &

operator=

(

const TRuntimeCtxId &

aRHS

)

Assignment operator. Copies contents of the passed in runtime context id into this runtime context id.

Parameters

const TRuntimeCtxId & aRHS

runtime ctx id to copy

operator==(const TRuntimeCtxId &)

IMPORT_C TBool

operator==

(

const TRuntimeCtxId &

aRHS

)

const

Compare the contents of this runtime context id to the contents of another. Only iSize bytes are compared, so if aRHS is bigger than the runtime context id it is being compared to any byte greater than iSize will not be compared.