Symbian^3 Product Developer Library >

Elements::RResponseMsg Class Reference

class Elements::RResponseMsg : protected RMessage2

The RResponseMsg class provides a controlled wrapper around an IPC client-provided RMessage2.

Inherits from

Public Member Functions
RResponseMsg()
RResponseMsg(const RMessage2 &, TInt, TInt, TInt)
RResponseMsg(const RMessage2 &, const Den::TApiExtIdentification &, TInt, TInt)
IMPORT_C voidComplete(TInt)
IMPORT_C voidComplete(Meta::SMetaDataECom &)
IMPORT_C voidComplete(Meta::SMetaDataECom &, TDes8 &)
IMPORT_C voidComplete(RHandleBase &)
TInt Function()
TInt GetDesLength(TInt)
TInt GetDesLengthL(TInt)
TInt GetDesMaxLength(TInt)
TInt GetDesMaxLengthL(TInt)
TBool HasCapability(TCapability, const char *)
TInt Int0()
TInt Int1()
TInt Int2()
TInt Int3()
IMPORT_C TIntInterfaceId()
TBool IsNull()
IMPORT_C voidPanic(const TDesC &, TInt)
const TAny *Ptr0()
const TAny *Ptr1()
const TAny *Ptr2()
const TAny *Ptr3()
TInt Read(TInt, TDes8 &, TInt)
TInt Read(TInt, TDes16 &, TInt)
IMPORT_C Meta::SMetaDataNetCtor *ReadClientReqMsg(TDes8 &)
voidReadL(TInt, TDes8 &, TInt)
voidReadL(TInt, TDes16 &, TInt)
IMPORT_C TIntScopeId()
TInt Write(TInt, const TDesC8 &, TInt)
TInt Write(TInt, const TDesC16 &, TInt)
voidWriteL(TInt, const TDesC8 &, TInt)
voidWriteL(TInt, const TDesC16 &, TInt)
Inherited Functions
RMessage2::Authorised()const
RMessage2::ClearAuthorised()const
RMessage2::RMessage2()
RMessage2::RMessage2(const RMessagePtr2 &)
RMessage2::Session()const
RMessage2::SetAuthorised()const
RMessagePtr2::Client(RThread &,TOwnerType)const
RMessagePtr2::ClientIsRealtime()const
RMessagePtr2::ClientL(RThread &,TOwnerType)const
RMessagePtr2::ClientProcessFlags()const
RMessagePtr2::ClientStatus()const
RMessagePtr2::Complete(RHandleBase)const
RMessagePtr2::Complete(TInt)const
RMessagePtr2::Handle()const
RMessagePtr2::HasCapability(TCapability,TCapability,const char *)const
RMessagePtr2::HasCapabilityL(TCapability,TCapability,const char *)const
RMessagePtr2::HasCapabilityL(TCapability,const char *)const
RMessagePtr2::Identity()const
RMessagePtr2::Kill(TInt)const
RMessagePtr2::RMessagePtr2()
RMessagePtr2::SecureId()const
RMessagePtr2::SetProcessPriority(TProcessPriority)const
RMessagePtr2::SetProcessPriorityL(TProcessPriority)const
RMessagePtr2::Terminate(TInt)const
RMessagePtr2::VendorId()const
Inherited Enumerations
RMessage2:TSessionMessages
Private Attributes
Den::TApiExtIdentification iInterfaceId
TInt8 iRequestMsgParam
TInt8 iResponseMsgParam
Inherited Attributes
RMessage2::iArgs
RMessage2::iFunction
RMessage2::iSessionPtr
RMessagePtr2::iHandle

Constructor & Destructor Documentation

RResponseMsg()

RResponseMsg()[inline, explicit]

RResponseMsg(const RMessage2 &, TInt, TInt, TInt)

IMPORT_CRResponseMsg(const RMessage2 &aMessage,
TIntaInterfaceId,
TIntaRequestMsgParam = -1,
TIntaResponseMsgParam = -1
)[explicit]

Parameters

const RMessage2 & aMessage
TInt aInterfaceId
TInt aRequestMsgParam = -1
TInt aResponseMsgParam = -1

RResponseMsg(const RMessage2 &, const Den::TApiExtIdentification &, TInt, TInt)

IMPORT_CRResponseMsg(const RMessage2 &aMessage,
const Den::TApiExtIdentification &aInterfaceId,
TIntaRequestMsgParam = -1,
TIntaResponseMsgParam = -1
)[explicit]

Parameters

const RMessage2 & aMessage
const Den::TApiExtIdentification & aInterfaceId
TInt aRequestMsgParam = -1
TInt aResponseMsgParam = -1

Member Functions Documentation

Complete(TInt)

IMPORT_C voidComplete(TIntaError)

Parameters

TInt aError

Complete(Meta::SMetaDataECom &)

IMPORT_C voidComplete(Meta::SMetaDataECom &aMsg)

Parameters

Meta::SMetaDataECom & aMsg

Complete(Meta::SMetaDataECom &, TDes8 &)

IMPORT_C voidComplete(Meta::SMetaDataECom &aMsg,
TDes8 &aDstBuff
)

Parameters

Meta::SMetaDataECom & aMsg
TDes8 & aDstBuff

Complete(RHandleBase &)

IMPORT_C voidComplete(RHandleBase &aHandle)

Parameters

RHandleBase & aHandle

Function()

TInt Function()const [inline]

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

GetDesLength(TInt)

TInt GetDesLength(TIntaParam)const [inline]

Parameters

TInt aParam

GetDesLengthL(TInt)

TInt GetDesLengthL(TIntaParam)const [inline]

Parameters

TInt aParam

GetDesMaxLength(TInt)

TInt GetDesMaxLength(TIntaParam)const [inline]

Parameters

TInt aParam

GetDesMaxLengthL(TInt)

TInt GetDesMaxLengthL(TIntaParam)const [inline]

Parameters

TInt aParam

HasCapability(TCapability, const char *)

TBool HasCapability(TCapabilityaCapability,
const char *aDiagnostic = 0
)const [inline]

Check if the process which sent this message has a given capability.

When a check fails the action taken is determined by the system wide Platform Security configuration. If PlatSecDiagnostics is ON, then a diagnostic message is emitted. If PlatSecEnforcement is OFF, then this function will return ETrue even though the check failed.

Parameters

TCapability aCapabilityThe capability to test.
const char * aDiagnostic = 0A string that will be emitted along with any diagnostic message that may be issued if the test finds the capability is not present. This string must be enclosed in the __PLATSEC_DIAGNOSTIC_STRING macro which enables it to be easily removed from the system.

Int0()

TInt Int0()const [inline]

Gets the first message argument as an integer value.

Int1()

TInt Int1()const [inline]

Gets the second message argument as an integer value.

Int2()

TInt Int2()const [inline]

Gets the third message argument as an integer value.

Int3()

TInt Int3()const [inline]

Gets the fourth message argument as an integer value.

InterfaceId()

IMPORT_C TIntInterfaceId()const

IsNull()

TBool IsNull()const [inline]

Tests whether this message handle is empty.

Panic(const TDesC &, TInt)

IMPORT_C voidPanic(const TDesC &aCategory,
TIntaReason
)const

Parameters

const TDesC & aCategory
TInt aReason

Ptr0()

const TAny *Ptr0()const [inline]

Gets the first message argument as a pointer type.

Ptr1()

const TAny *Ptr1()const [inline]

Gets the second message argument as a pointer type.

Ptr2()

const TAny *Ptr2()const [inline]

Gets the third message argument as a pointer type.

Ptr3()

const TAny *Ptr3()const [inline]

Gets the fourth message argument as a pointer type.

Read(TInt, TDes8 &, TInt)

TInt Read(TIntaReadParam,
TDes8 &aBuf,
TIntaOffset = 0
)const [inline]

Parameters

TInt aReadParam
TDes8 & aBuf
TInt aOffset = 0

Read(TInt, TDes16 &, TInt)

TInt Read(TIntaReadParam,
TDes16 &aBuf,
TIntaOffset = 0
)const [inline]

Parameters

TInt aReadParam
TDes16 & aBuf
TInt aOffset = 0

ReadClientReqMsg(TDes8 &)

IMPORT_C Meta::SMetaDataNetCtor *ReadClientReqMsg(TDes8 &aDstBuff)

Parameters

TDes8 & aDstBuff

ReadL(TInt, TDes8 &, TInt)

voidReadL(TIntaReadParam,
TDes8 &aBuf,
TIntaOffset = 0
)const [inline]

Parameters

TInt aReadParam
TDes8 & aBuf
TInt aOffset = 0

ReadL(TInt, TDes16 &, TInt)

voidReadL(TIntaReadParam,
TDes16 &aBuf,
TIntaOffset = 0
)const [inline]

Parameters

TInt aReadParam
TDes16 & aBuf
TInt aOffset = 0

ScopeId()

IMPORT_C TIntScopeId()const

Write(TInt, const TDesC8 &, TInt)

TInt Write(TIntaWriteParam,
const TDesC8 &aBuf,
TIntaOffset = 0
)const [inline]

Parameters

TInt aWriteParam
const TDesC8 & aBuf
TInt aOffset = 0

Write(TInt, const TDesC16 &, TInt)

TInt Write(TIntaWriteParam,
const TDesC16 &aBuf,
TIntaOffset = 0
)const [inline]

Parameters

TInt aWriteParam
const TDesC16 & aBuf
TInt aOffset = 0

WriteL(TInt, const TDesC8 &, TInt)

voidWriteL(TIntaWriteParam,
const TDesC8 &aBuf,
TIntaOffset = 0
)const [inline]

Parameters

TInt aWriteParam
const TDesC8 & aBuf
TInt aOffset = 0

WriteL(TInt, const TDesC16 &, TInt)

voidWriteL(TIntaWriteParam,
const TDesC16 &aBuf,
TIntaOffset = 0
)const [inline]

Parameters

TInt aWriteParam
const TDesC16 & aBuf
TInt aOffset = 0

Member Data Documentation

Den::TApiExtIdentification iInterfaceId

Den::TApiExtIdentification iInterfaceId[private]

TInt8 iRequestMsgParam

TInt8 iRequestMsgParam[private]

TInt8 iResponseMsgParam

TInt8 iResponseMsgParam[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.