os/persistentdata/persistentstorage/centralrepository/cenrepsrv/clientrequest.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/persistentdata/persistentstorage/centralrepository/cenrepsrv/clientrequest.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,156 @@
     1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __CLIENTREQUEST_H__
    1.20 +#define __CLIENTREQUEST_H__
    1.21 +
    1.22 +#include <e32std.h>
    1.23 +
    1.24 +///////////////////////////////////////////////////////////////////////////////
    1.25 +// MClientRequest
    1.26 +///////////////////////////////////////////////////////////////////////////////
    1.27 +// Provides an interface identical to RMessage2.
    1.28 +// This facilitiates unit testing of the session by enabling RMessage2 to be
    1.29 +// replaced in unit test code.
    1.30 +///////////////////////////////////////////////////////////////////////////////
    1.31 +class MClientRequest
    1.32 +/**
    1.33 +@internalComponent
    1.34 +*/
    1.35 +	{
    1.36 +	public:
    1.37 +		virtual TInt Function() const = 0;
    1.38 +		virtual void Complete(TInt aReason) const = 0;	
    1.39 +		virtual void Panic(const TDesC& aCategory, TInt aReason) const = 0;
    1.40 +	public:
    1.41 +		virtual TInt Int0() const = 0;
    1.42 +		virtual TInt Int1() const = 0;
    1.43 +		virtual TInt Int2() const = 0;
    1.44 +		virtual TInt Int3() const = 0;
    1.45 +	public:
    1.46 +		virtual TInt GetDesLengthL(TInt aParam) const = 0;
    1.47 +		virtual TInt GetDesMaxLength(TInt aParam) const = 0;
    1.48 +		virtual void ReadL(TInt aParam, TDes8& aDes, TInt aOffset=0) const = 0;
    1.49 +		virtual void ReadL(TInt aParam, TDes& aDes,  TInt aOffset=0) const = 0;
    1.50 +		virtual void Read(TInt aParam, TDes8& aDes, TInt aOffset=0) const = 0;
    1.51 +		virtual void Read(TInt aParam, TDes& aDes,  TInt aOffset=0) const = 0;
    1.52 +		virtual TInt Write(TInt aParam, const TDesC8& aDes, TInt aOffset=0) const = 0;
    1.53 +		virtual void WriteL(TInt aParam, const TDesC8& aDes) const = 0;
    1.54 +		virtual void WriteL(TInt aParam, const TDesC& aDes, TInt aOffset=0) const = 0;
    1.55 +		virtual TBool CheckPolicy(const TSecurityPolicy& aSecurityPolicy,const char *aDiagnostic) const =0;
    1.56 +	};
    1.57 +
    1.58 +///////////////////////////////////////////////////////////////////////////////
    1.59 +///////////////////////////////////////////////////////////////////////////////
    1.60 +
    1.61 +# ifndef CENTRAL_REPOSITORY_SERVER_TESTING
    1.62 +///////////////////////////////////////////////////////////////////////////////
    1.63 +// TClientRequest
    1.64 +///////////////////////////////////////////////////////////////////////////////
    1.65 +// Concrete implementation of MClientRequest that acts as an adaptor for
    1.66 +// RMessage.
    1.67 +///////////////////////////////////////////////////////////////////////////////
    1.68 +class TClientRequest : public MClientRequest
    1.69 +/**
    1.70 +@internalComponent
    1.71 +*/
    1.72 +	{
    1.73 +	public:
    1.74 +		TClientRequest() {}
    1.75 +		TClientRequest(const RMessage2&);
    1.76 +		virtual TInt Function() const;
    1.77 +		virtual void Complete(TInt aReason) const;
    1.78 +		virtual void Panic(const TDesC& aCategory, TInt aReason) const;
    1.79 +		virtual TInt Int0() const;
    1.80 +		virtual TInt Int1() const;
    1.81 +		virtual TInt Int2() const;
    1.82 +		virtual TInt Int3() const;
    1.83 +		virtual TInt GetDesLengthL(TInt aParam) const;
    1.84 +		virtual TInt GetDesMaxLength(TInt aParam) const;
    1.85 +		virtual void ReadL(TInt aParam, TDes8& aDes, TInt aOffset=0) const;
    1.86 +		virtual void ReadL(TInt aParam, TDes& aDes,  TInt aOffset=0) const;
    1.87 +		virtual void Read(TInt aParam, TDes8& aDes, TInt aOffset=0) const;
    1.88 +		virtual void Read(TInt aParam, TDes& aDes,  TInt aOffset=0) const;
    1.89 +		virtual TInt Write(TInt aParam, const TDesC8& aDes, TInt aOffset=0) const;
    1.90 +		virtual void WriteL(TInt aParam, const TDesC8& aDes) const;
    1.91 +		virtual void WriteL(TInt aParam, const TDesC& aDes, TInt aOffset=0) const;
    1.92 +		virtual TBool CheckPolicy(const TSecurityPolicy& aSecurityPolicy,const char *aDiagnostic) const;
    1.93 +	private:
    1.94 +		RMessage2 iMessage;
    1.95 +	};
    1.96 +
    1.97 +///////////////////////////////////////////////////////////////////////////////
    1.98 +///////////////////////////////////////////////////////////////////////////////
    1.99 +# else //_UNIT_TESTING_
   1.100 +///////////////////////////////////////////////////////////////////////////////
   1.101 +// TClientRequest
   1.102 +///////////////////////////////////////////////////////////////////////////////
   1.103 +// Unit test version.
   1.104 +///////////////////////////////////////////////////////////////////////////////
   1.105 +class TClientRequest : public MClientRequest
   1.106 +/**
   1.107 +@internalComponent
   1.108 +*/
   1.109 +	{
   1.110 +	public:
   1.111 +		TClientRequest();
   1.112 +		TClientRequest(const RMessage2&) {}; // Needed for compilation, but not used in testing.
   1.113 +		virtual TInt Function() const;
   1.114 +		virtual void Complete(TInt aReason) const;
   1.115 +		virtual void Panic(const TDesC& aCategory, TInt aReason) const;
   1.116 +		virtual TInt Int0() const;
   1.117 +		virtual TInt Int1() const;
   1.118 +		virtual TInt Int2() const;
   1.119 +		virtual TInt Int3() const;
   1.120 +		virtual TInt GetDesLengthL(TInt aParam) const;
   1.121 +		virtual TInt GetDesMaxLength(TInt aParam) const;
   1.122 +		virtual void ReadL(TInt aParam, TDes8& aDes, TInt aOffset=0) const;
   1.123 +		virtual void ReadL(TInt aParam, TDes& aDes, TInt aOffset=0) const;
   1.124 +		virtual void Read(TInt aParam, TDes8& aDes, TInt aOffset=0) const;
   1.125 +		virtual void Read(TInt aParam, TDes& aDes,  TInt aOffset=0) const;
   1.126 +		virtual TInt Write(TInt aParam, const TDesC8& aDes, TInt aOffset=0) const;
   1.127 +		virtual void WriteL(TInt aParam, const TDesC8& aDes) const;
   1.128 +		virtual void WriteL(TInt aParam, const TDesC& aDes, TInt aOffset=0) const;
   1.129 +		virtual TBool CheckPolicy(const TSecurityPolicy& aSecurityPolicy,const char *aDiagnostic) const;
   1.130 +	public://debug only
   1.131 +		inline void SetParam(TInt aParam, TInt aValue);
   1.132 +		inline void SetParam(TInt aParam, TDes8* aValue);
   1.133 +		inline void SetPolicyCheck(TBool aPolicyCheck);
   1.134 +		inline TInt CompletionCode() const;
   1.135 +		
   1.136 +	private:
   1.137 +		TInt iFunction;
   1.138 +		TUint32 iCapability;
   1.139 +		mutable TInt iCompletion;
   1.140 +		TInt iParams[KMaxMessageArguments];
   1.141 +		mutable TRequestStatus* iStatus;
   1.142 +		TBool iStatusActive;
   1.143 +		TUid iIdentity;
   1.144 +		TBool iPolicyCheck;
   1.145 +	};
   1.146 +
   1.147 +///////////////////////////////////////////////////////////////////////////////
   1.148 +inline void TClientRequest::SetParam(TInt aParam, TInt aValue) { iParams[aParam] = aValue; }
   1.149 +inline void TClientRequest::SetParam(TInt aParam, TDes8* aValue) { iParams[aParam] = TInt(aValue); }
   1.150 +inline void TClientRequest::SetPolicyCheck(TBool aPolicyCheck) {iPolicyCheck=aPolicyCheck;}
   1.151 +
   1.152 +///////////////////////////////////////////////////////////////////////////////
   1.153 +///////////////////////////////////////////////////////////////////////////////
   1.154 +#endif //CENTRAL_REPOSITORY_SERVER_TESTING
   1.155 +
   1.156 +///////////////////////////////////////////////////////////////////////////////
   1.157 +///////////////////////////////////////////////////////////////////////////////
   1.158 +///////////////////////////////////////////////////////////////////////////////
   1.159 +#endif //__CLIENTREQUEST_H__