Symbian^3 Product Developer Library >

BSUL::CClientMessage Class Reference

class BSUL::CClientMessage : public CBase

This class is used by a server to sanitise incoming messages. The class provides a wrapper around an RMessage2 object and provides a method for validation of the message against the constraints defined in the message schema. This class also provides methods for safely accessing the message arguments, and for error handling and logging of bad messages. This class is not intended for derivation.

Inherits from

  • BSUL::CClientMessage
Public Member Functions
~CClientMessage()
IMPORT_C voidCompleteRequestL(TInt)
IMPORT_C TIntFunction()
IMPORT_C const TDesC &GetDes16L(TInt)
IMPORT_C const TDesC8 &GetDes8L(TInt)
IMPORT_C TIntGetDesLengthL(TInt)
IMPORT_C TIntGetDesMaxLengthL(TInt)
IMPORT_C TIntGetIntL(TInt)
IMPORT_C const TAny *GetPtrL(TInt)
IMPORT_C voidInitialiseFrameworkL(const TClientMessageServerData &)
IMPORT_C const RMessage2 &Message()
IMPORT_C CClientMessage *NewL(const RMessage2 &)
IMPORT_C voidPanicClient(const TDesC &, TInt)
IMPORT_C voidReadL(TInt, TDes8 &, TInt)
IMPORT_C voidReadL(TInt, TDes16 &, TInt)
IMPORT_C voidValidateL()
IMPORT_C voidValidateL(TInt)
IMPORT_C voidWriteL(TInt, const TDesC8 &, TInt)
IMPORT_C voidWriteL(TInt, const TDesC16 &, TInt)
Private Member Functions
CClientMessage(const RMessage2 &, const TClientMessageServerData &)
voidCheckSecurityPolicyL(const TSecurityPolicy &)
voidCheckValidatedL(TInt)
voidConstructL()
const TClientMessageSchema *FindMessageSchema()
voidLogBadMessageL(TInt)
TBool LogBadMessages()
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
TBitFlags32 iFlags
const RMessage2 &iMessage
RPointerArray< CMessageParameterBase >iParameters
const TClientMessageServerData &iServerData

Constructor & Destructor Documentation

CClientMessage(const RMessage2 &, const TClientMessageServerData &)

CClientMessage(const RMessage2 &aMessage,
const TClientMessageServerData &aServerData
)[private]

Parameters

const RMessage2 & aMessage
const TClientMessageServerData & aServerData

~CClientMessage()

IMPORT_C~CClientMessage()[virtual]

Member Functions Documentation

CheckSecurityPolicyL(const TSecurityPolicy &)

voidCheckSecurityPolicyL(const TSecurityPolicy &aPolicy)[private, virtual]

Parameters

const TSecurityPolicy & aPolicy

CheckValidatedL(TInt)

voidCheckValidatedL(TIntaParam)[private]

Parameters

TInt aParam

CompleteRequestL(TInt)

IMPORT_C voidCompleteRequestL(TIntaError)[virtual]

Parameters

TInt aError

ConstructL()

voidConstructL()[private]

FindMessageSchema()

const TClientMessageSchema *FindMessageSchema()[private]

Function()

IMPORT_C TIntFunction()

GetDes16L(TInt)

IMPORT_C const TDesC &GetDes16L(TIntaParam)[virtual]

Parameters

TInt aParam

GetDes8L(TInt)

IMPORT_C const TDesC8 &GetDes8L(TIntaParam)[virtual]

Parameters

TInt aParam

GetDesLengthL(TInt)

IMPORT_C TIntGetDesLengthL(TIntaParam)[virtual]

Parameters

TInt aParam

GetDesMaxLengthL(TInt)

IMPORT_C TIntGetDesMaxLengthL(TIntaParam)[virtual]

Parameters

TInt aParam

GetIntL(TInt)

IMPORT_C TIntGetIntL(TIntaParam)[virtual]

Parameters

TInt aParam

GetPtrL(TInt)

IMPORT_C const TAny *GetPtrL(TIntaParam)[virtual]

Parameters

TInt aParam

InitialiseFrameworkL(const TClientMessageServerData &)

IMPORT_C voidInitialiseFrameworkL(const TClientMessageServerData &aServerData)[static]

Parameters

const TClientMessageServerData & aServerData

LogBadMessageL(TInt)

voidLogBadMessageL(TIntaError)[private, virtual]

Parameters

TInt aError

LogBadMessages()

TBool LogBadMessages()[private]

Message()

IMPORT_C const RMessage2 &Message()

NewL(const RMessage2 &)

IMPORT_C CClientMessage *NewL(const RMessage2 &aMessage)[static]

Parameters

const RMessage2 & aMessage

PanicClient(const TDesC &, TInt)

IMPORT_C voidPanicClient(const TDesC &aServer,
TIntaPanic
)[virtual]

Parameters

const TDesC & aServer
TInt aPanic

ReadL(TInt, TDes8 &, TInt)

IMPORT_C voidReadL(TIntaParam,
TDes8 &aDes,
TIntaOffset = 0
)[virtual]

Parameters

TInt aParam
TDes8 & aDes
TInt aOffset = 0

ReadL(TInt, TDes16 &, TInt)

IMPORT_C voidReadL(TIntaParam,
TDes16 &aDes,
TIntaOffset = 0
)[virtual]

Parameters

TInt aParam
TDes16 & aDes
TInt aOffset = 0

ValidateL()

IMPORT_C voidValidateL()[virtual]

ValidateL(TInt)

IMPORT_C voidValidateL(TIntaParam)[virtual]

Parameters

TInt aParam

WriteL(TInt, const TDesC8 &, TInt)

IMPORT_C voidWriteL(TIntaParam,
const TDesC8 &aDes,
TIntaOffset = 0
)[virtual]

Parameters

TInt aParam
const TDesC8 & aDes
TInt aOffset = 0

WriteL(TInt, const TDesC16 &, TInt)

IMPORT_C voidWriteL(TIntaParam,
const TDesC16 &aDes,
TIntaOffset = 0
)[virtual]

Parameters

TInt aParam
const TDesC16 & aDes
TInt aOffset = 0

Member Data Documentation

TBitFlags32 iFlags

TBitFlags32 iFlags[private]

const RMessage2 & iMessage

const RMessage2 &iMessage[private]

RPointerArray< CMessageParameterBase > iParameters

RPointerArray< CMessageParameterBase >iParameters[private]

const TClientMessageServerData & iServerData

const TClientMessageServerData &iServerData[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.