Collapse all Symbian^3 Product Developer Library

CSensrvMessage Class Reference

class CSensrvMessage : public CBase

Wraps the client message for sensor server internal handling.

Since: S60 5.0

Inherits from

CSensrvMessage
- CBase

Public Member Functions
	~CSensrvMessage()
void	Complete(TInt)
TInt	Function()
TInt	GetChannelId(TSensrvChannelId &)
TInt	GetDesLength(TInt)
TInt	GetDesMaxLength(TInt)
const RMessage2 &	GetMessage()
void	GetSecurityInfo(TSecurityInfo &)
TInt	Handle()
void	Initialize(const RMessage2 &)
CSensrvMessage *	NewL()
TInt	Read(const TInt, TDes8 &)
void	ReadInt(const TInt, TInt &)
TSecureId	SecureId()
CSensrvSession *	Session()
TInt	Write(TInt, const TDesC8 &, TInt)

Private Member Functions
	CSensrvMessage()

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
RMessage2	iMessage

Constructor & Destructor Documentation

CSensrvMessage()

CSensrvMessage

(

)

[private]

C++ constructor for external message.

~CSensrvMessage()

~CSensrvMessage

(

)

[virtual]

Destructor.

Since: S60 5.0

Member Functions Documentation

Complete(TInt)

void

Complete

(

TInt

aReason

)

Completes the message

Since: S60 5.0

Parameters

TInt aReason

Completion reason identifier. Usually error code.

Function()

TInt

Function

(

)

const [inline]

Gets the function requested by client.

Since: S60 5.0

GetChannelId(TSensrvChannelId &)

TInt

GetChannelId

(

TSensrvChannelId &

aChannelId

)

const

Extracts channel id from message.

Since: S60 5.0

Parameters

TSensrvChannelId & aChannelId

The found channel id is returned here.

GetDesLength(TInt)

TInt

GetDesLength

(

TInt

aParam

)

const

Gets message parameter descriptor lenght.

Since: S60 5.0

Parameters

TInt aParam

Index of message parameter

GetDesMaxLength(TInt)

TInt

GetDesMaxLength

(

TInt

aParam

)

const

Gets message parameter descriptor maximum lenght.

Since: S60 5.0

Parameters

TInt aParam

Index of message parameter

GetMessage()

const RMessage2 &

GetMessage

(

)

const [inline]

Returns the message as read only.

Since: S60 5.0

GetSecurityInfo(TSecurityInfo &)

void

GetSecurityInfo

(

TSecurityInfo &

aSecurityInfo

)

const

Gets the security info of the client message

Since: S60 5.0

Parameters

TSecurityInfo & aSecurityInfo

This object will contain client security info

Handle()

TInt

Handle

(

)

const [inline]

Returns message handle. Used to determine if message is still valid.

Since: S60 5.0

Initialize(const RMessage2 &)

void

Initialize

(

const RMessage2 &

aMessage

)

Initializes the message. Must be done before message is used first time and before use after each complete.

Since: S60 5.0

Parameters

const RMessage2 & aMessage

Client message to wrap

NewL()

CSensrvMessage *

NewL

(

)

[static]

Two-phased constructor for external message

Since: S60 5.0

Read(const TInt, TDes8 &)

TInt	Read	(	const TInt	aParam,
			TDes8 &	aDes
		)	const

Reads data from wrapped message.

Since: S60 5.0

Parameters

const TInt aParam	The index value identifying the argument. This is a value in the range 0 to (KMaxMessageArguments-1) inclusive.
TDes8 & aDes	The target descriptor into which the client data is to be written.

ReadInt(const TInt, TInt &)

void	ReadInt	(	const TInt	aParam,
			TInt &	aInt
		)	const

Reads integer data from wrapped message.

Since: S60 5.0

Parameters

const TInt aParam	The index value identifying the argument. This is a value in the range 0 to (KMaxMessageArguments-1) inclusive.
TInt & aInt	The target integer where the value is read.

SecureId()

TSecureId

SecureId

(

)

const

Gets client process SID

Since: S60 5.0

Session()

CSensrvSession *

Session

(

)

Gets session related to this message.

Since: S60 5.0

Write(TInt, const TDesC8 &, TInt)

TInt	Write	(	TInt	aParam,
			const TDesC8 &	aDes,
			TInt	aOffset = 0
		)

Writes return data to wrapped message.

Since: S60 5.0

Parameters

TInt aParam	Parameter index to write
const TDesC8 & aDes	Source descriptor for written data.
TInt aOffset = 0	The offset from the start of the client's descriptor. If not explicitly specified, the offset defaults to zero.

Member Data Documentation

RMessage2 iMessage

RMessage2

iMessage

[private]

Wrapped message