BSUL::CClientMessage Class Reference

#include <bsul/clientmessage.h>

class BSUL::CClientMessage : public CBase

Inherits from

  • BSUL::CClientMessage
    Public Member Functions
    virtual ~CClientMessage()
    virtual IMPORT_C voidCompleteRequestL(TInt)
    IMPORT_C TIntFunction()
    virtual IMPORT_C const TDesC &GetDes16L(TInt)
    virtual IMPORT_C const TDesC8 &GetDes8L(TInt)
    virtual IMPORT_C TIntGetDesLengthL(TInt)
    virtual IMPORT_C TIntGetDesMaxLengthL(TInt)
    virtual IMPORT_C TIntGetIntL(TInt)
    virtual IMPORT_C const TAny *GetPtrL(TInt)
    IMPORT_C voidInitialiseFrameworkL(const TClientMessageServerData &)
    IMPORT_C const RMessage2 &Message()
    IMPORT_C CClientMessage *NewL(const RMessage2 &)
    virtual IMPORT_C voidPanicClient(const TDesC &, TInt)
    virtual IMPORT_C voidReadL(TInt, TDes8 &, TInt)
    virtual IMPORT_C voidReadL(TInt, TDes16 &, TInt)
    virtual IMPORT_C voidValidateL()
    virtual IMPORT_C voidValidateL(TInt)
    virtual IMPORT_C voidWriteL(TInt, const TDesC8 &, TInt)
    virtual IMPORT_C voidWriteL(TInt, const TDesC16 &, TInt)
    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()

    Detailed Description

    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.

    Constructor & Destructor Documentation

    ~CClientMessage ( )

    IMPORT_C~CClientMessage()[virtual]

    Member Function Documentation

    CompleteRequestL ( TInt )

    IMPORT_C voidCompleteRequestL(TIntaError)[virtual]

    Function ( )

    IMPORT_C TIntFunction()

    GetDes16L ( TInt )

    IMPORT_C const TDesC &GetDes16L(TIntaParam)[virtual]

    GetDes8L ( TInt )

    IMPORT_C const TDesC8 &GetDes8L(TIntaParam)[virtual]

    GetDesLengthL ( TInt )

    IMPORT_C TIntGetDesLengthL(TIntaParam)[virtual]

    GetDesMaxLengthL ( TInt )

    IMPORT_C TIntGetDesMaxLengthL(TIntaParam)[virtual]

    GetIntL ( TInt )

    IMPORT_C TIntGetIntL(TIntaParam)[virtual]

    GetPtrL ( TInt )

    IMPORT_C const TAny *GetPtrL(TIntaParam)[virtual]

    InitialiseFrameworkL ( const TClientMessageServerData & )

    IMPORT_C voidInitialiseFrameworkL(const TClientMessageServerData &aServerData)[static]

    Message ( )

    IMPORT_C const RMessage2 &Message()

    NewL ( const RMessage2 & )

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

    PanicClient ( const TDesC &, TInt )

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

    ReadL ( TInt, TDes8 &, TInt )

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

    ReadL ( TInt, TDes16 &, TInt )

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

    ValidateL ( )

    IMPORT_C voidValidateL()[virtual]

    ValidateL ( TInt )

    IMPORT_C voidValidateL(TIntaParam)[virtual]

    WriteL ( TInt, const TDesC8 &, TInt )

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

    WriteL ( TInt, const TDesC16 &, TInt )

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