An object that encapsulates the details of a client request. More...

#include <e32cmn.h>

Inheritance diagram for RMessage2:

Public Types
enum	TSessionMessages { EConnect =-1 , EDisConnect =-2 }
	Defines internal message types. More...

Public Member Functions
	RMessage2 ()
	Default constructor.

IMPORT_C	RMessage2 (const RMessagePtr2 &aPtr)
	Constructs an RMessage2 from an RMessagePtr2.

void	SetAuthorised () const
	Sets this message to an authorised state.

void	ClearAuthorised () const
	Sets the authorised flag to a state of not authorised.

TBool	Authorised () const
	Returns whether this message has been authorised by CPolicyServer.

TInt	Function () const
	Gets the the number of the function requested by the client.

TInt	Int0 () const
	Gets the first message argument as an integer value.

TInt	Int1 () const
	Gets the second message argument as an integer value.

TInt	Int2 () const
	Gets the third message argument as an integer value.

TInt	Int3 () const
	Gets the fourth message argument as an integer value.

const TAny *	Ptr0 () const
	Gets the first message argument as a pointer type.

const TAny *	Ptr1 () const
	Gets the second message argument as a pointer type.

const TAny *	Ptr2 () const
	Gets the third message argument as a pointer type.

const TAny *	Ptr3 () const
	Gets the fourth message argument as a pointer type.

CSession2 *	Session () const
	Gets a pointer to the session.

Public Member Functions inherited from RMessagePtr2
	RMessagePtr2 ()
	Default constructor.

TBool	IsNull () const
	Tests whether this message handle is empty.

TInt	Handle () const
	Gets the message handle value.

IMPORT_C void	Complete (TInt aReason) const
	Frees this message.

IMPORT_C void	Complete (RHandleBase aHandle) const
	Duplicates the specified handle in the client thread, and returns this handle as a message completion code.

IMPORT_C TInt	GetDesLength (TInt aParam) const
	Gets the length of a descriptor argument in the client's process.

IMPORT_C TInt	GetDesLengthL (TInt aParam) const
	Gets the length of a descriptor argument in the client's process, leaving on failure.

IMPORT_C TInt	GetDesMaxLength (TInt aParam) const
	Gets the maximum length of a descriptor argument in the client's process.

IMPORT_C TInt	GetDesMaxLengthL (TInt aParam) const
	Gets the maximum length of a descriptor argument in the client's process, leaving on failure.

IMPORT_C void	ReadL (TInt aParam, TDes8 &aDes, TInt aOffset=0) const
	Reads data from the specified offset within the 8-bit descriptor argument, into the specified target descriptor, and leaving on failure.

IMPORT_C void	ReadL (TInt aParam, TDes16 &aDes, TInt aOffset=0) const
	Reads data from the specified offset within the 16-bit descriptor argument, into the specified target descriptor, and leaving on failure.

IMPORT_C void	WriteL (TInt aParam, const TDesC8 &aDes, TInt aOffset=0) const
	Writes data from the specified source descriptor to the specified offset within the 8-bit descriptor argument, and leaving on failure.

IMPORT_C void	WriteL (TInt aParam, const TDesC16 &aDes, TInt aOffset=0) const
	Writes data from the specified source descriptor to the specified offset within the 16-bit descriptor argument, and leaving on failure.

IMPORT_C TInt	Read (TInt aParam, TDes8 &aDes, TInt aOffset=0) const
	Reads data from the specified offset within the 8-bit descriptor argument, into the specified target descriptor.

IMPORT_C TInt	Read (TInt aParam, TDes16 &aDes, TInt aOffset=0) const
	Reads data from the specified offset within the 16-bit descriptor argument, into the specified target descriptor.

IMPORT_C TInt	Write (TInt aParam, const TDesC8 &aDes, TInt aOffset=0) const
	Writes data from the specified source descriptor to the specified offset within the 8-bit descriptor argument.

IMPORT_C TInt	Write (TInt aParam, const TDesC16 &aDes, TInt aOffset=0) const
	Writes data from the specified source descriptor to the specified offset within the 16-bit descriptor argument.

IMPORT_C void	Panic (const TDesC &aCategory, TInt aReason) const
	Panics the client.

IMPORT_C void	Kill (TInt aReason) const
	Kills the client.

IMPORT_C void	Terminate (TInt aReason) const
	Terminates the client.

IMPORT_C TInt	SetProcessPriority (TProcessPriority aPriority) const
	Sets the priority of the client's process.

void	SetProcessPriorityL (TProcessPriority aPriority) const
	Sets the priority of the client's process.

IMPORT_C TInt	Client (RThread &aClient, TOwnerType aOwnerType=EOwnerProcess) const
	Opens a handle on the client thread.

void	ClientL (RThread &aClient, TOwnerType aOwnerType=EOwnerProcess) const
	Opens a handle on the client thread.

IMPORT_C TUint	ClientProcessFlags () const

IMPORT_C const TRequestStatus *	ClientStatus () const
	Returns the pointer to the clients TRequestStatus associated with the message.

IMPORT_C TBool	ClientIsRealtime () const

IMPORT_C TSecureId	SecureId () const

IMPORT_C TVendorId	VendorId () const

TBool	HasCapability (TCapability aCapability, const char *aDiagnostic=0) const

void	HasCapabilityL (TCapability aCapability, const char *aDiagnosticMessage=0) const

TBool	HasCapability (TCapability aCapability1, TCapability aCapability2, const char *aDiagnostic=0) const

void	HasCapabilityL (TCapability aCapability1, TCapability aCapability2, const char *aDiagnosticMessage=0) const

TUid	Identity () const

Protected Attributes
TInt	iFunction
	The request type.

TInt	iArgs [KMaxMessageArguments]
	A copy of the message arguments.

const TAny *	iSessionPtr

Protected Attributes inherited from RMessagePtr2
TInt	iHandle

Friends
class	CServer2

class	RMessage

Detailed Description

An object that encapsulates the details of a client request.

API status: Published to all clients. Released API.

Definition at line 3464 of file e32cmn.h.

Member Enumeration Documentation

◆ TSessionMessages

enum RMessage2::TSessionMessages

Defines internal message types.

Enumerator
EConnect	A message type used internally that means connect.
EDisConnect	A message type used internally that means disconnect.

Definition at line 3472 of file e32cmn.h.

Constructor & Destructor Documentation

◆ RMessage2() [1/2]

RMessage2::RMessage2 ( )

inline

Default constructor.

(generated from Symbian Developer Library)

◆ RMessage2() [2/2]

IMPORT_C RMessage2::RMessage2 ( const RMessagePtr2 & aPtr )

explicit

Constructs an RMessage2 from an RMessagePtr2.

Parameters

aPtr	A reference to an existing RMessagePtr2 object.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Authorised()

TBool RMessage2::Authorised ( ) const

Returns whether this message has been authorised by CPolicyServer.

See RMessage2::SetAuthorised for implications of this state.

(generated from Symbian Developer Library)

◆ ClearAuthorised()

void RMessage2::ClearAuthorised ( ) const

Sets the authorised flag to a state of not authorised.

This is required as there is a default constructor for RMessage2 and one cannot guarantee that iFlags was initialised. This is called from CPolicyServer::RunL.

This is labelled as a const functions as everybody handles const RMessage2&'s. The constness is actually referring to the underlying RMessagePtr2 not the tranisent RMessage2 class.

(generated from Symbian Developer Library)

◆ Function()

TInt RMessage2::Function ( ) const

inline

Gets the the number of the function requested by the client.

(generated from Symbian Developer Library)

◆ Int0()

TInt RMessage2::Int0 ( ) const

inline

Gets the first message argument as an integer value.

(generated from Symbian Developer Library)

◆ Int1()

TInt RMessage2::Int1 ( ) const

inline

Gets the second message argument as an integer value.

(generated from Symbian Developer Library)

◆ Int2()

TInt RMessage2::Int2 ( ) const

inline

Gets the third message argument as an integer value.

(generated from Symbian Developer Library)

◆ Int3()

TInt RMessage2::Int3 ( ) const

inline

Gets the fourth message argument as an integer value.

(generated from Symbian Developer Library)

◆ Ptr0()

const TAny * RMessage2::Ptr0 ( ) const

inline

Gets the first message argument as a pointer type.

(generated from Symbian Developer Library)

◆ Ptr1()

const TAny * RMessage2::Ptr1 ( ) const

inline

Gets the second message argument as a pointer type.

(generated from Symbian Developer Library)

◆ Ptr2()

const TAny * RMessage2::Ptr2 ( ) const

inline

Gets the third message argument as a pointer type.

(generated from Symbian Developer Library)

◆ Ptr3()

const TAny * RMessage2::Ptr3 ( ) const

inline

Gets the fourth message argument as a pointer type.

(generated from Symbian Developer Library)

◆ Session()

CSession2 * RMessage2::Session ( ) const

inline

Gets a pointer to the session.

(generated from Symbian Developer Library)

◆ SetAuthorised()

void RMessage2::SetAuthorised ( ) const

Sets this message to an authorised state.

This is used only by CPolicyServer. This flags use by the policy server implies two things: 1) That the message has passed any appropriate security checks. (ie. one of the static policy check, CustomSecurityCheckL, or CustomFailureActionL, returned ETrue.) 2) That any leaves that occur subsequent to this flag being set happen only in the session's ServiceL. ie. Nothing can leave between this flag being set and the session's ServiceL being called.

This is labelled as a const functions as everybody handles const RMessage2&'s. The constness is actually referring to the underlying RMessagePtr2 not the tranisent RMessage2 class.

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

◆ CServer2

friend class CServer2

friend

Definition at line 3466 of file e32cmn.h.

◆ RMessage

friend class RMessage

friend

Definition at line 3525 of file e32cmn.h.

Member Data Documentation

◆ iArgs

TInt RMessage2::iArgs[KMaxMessageArguments]

protected

A copy of the message arguments.

Definition at line 3511 of file e32cmn.h.

◆ iFunction

TInt RMessage2::iFunction

protected

The request type.

Definition at line 3506 of file e32cmn.h.

◆ iSessionPtr

const TAny* RMessage2::iSessionPtr

protected

API status: Internal component API.

Definition at line 3520 of file e32cmn.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ TSessionMessages

Constructor & Destructor Documentation

◆ RMessage2() [1/2]

◆ RMessage2() [2/2]

Member Function Documentation

◆ Authorised()

◆ ClearAuthorised()

◆ Function()

◆ Int0()

◆ Int1()

◆ Int2()

◆ Int3()

◆ Ptr0()

◆ Ptr1()

◆ Ptr2()

◆ Ptr3()

◆ Session()

◆ SetAuthorised()

Friends And Related Symbol Documentation

◆ CServer2

◆ RMessage

Member Data Documentation

◆ iArgs

◆ iFunction

◆ iSessionPtr