1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/mmlibs/mmfw/inc/mmf/common/MmfIpc.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,100 @@
     1.4 +// Copyright (c) 2003-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 +// include\mmf\common\mmfipc.h
    1.18 +// Thin interface layer to use either V1 or V2 IPC calls as appropriate
    1.19 +// 
    1.20 +//
    1.21 +
    1.22 +#ifndef __MMF_COMMON_MMFIPC_H__
    1.23 +#define __MMF_COMMON_MMFIPC_H__
    1.24 +
    1.25 +#include <e32base.h>
    1.26 +
    1.27 +#ifdef __IPC_V2_PRESENT__
    1.28 +// if V2 code present than use it
    1.29 +#define __MMF_USE_IPC_V2__
    1.30 +#endif //__IPC_V2_PRESENT__
    1.31 +
    1.32 +
    1.33 +#ifdef __MMF_USE_IPC_V2__
    1.34 +typedef RMessage2 RMmfIpcMessage;
    1.35 +#else // __MMF_USE_IPC_V2__
    1.36 +// otherwise always use V1
    1.37 +typedef RMessage RMmfIpcMessage;
    1.38 +#endif // __MMF_USE_IPC_V2__
    1.39 +
    1.40 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    1.41 +#include <mmf/common/mmfipcserver.h>
    1.42 +#endif
    1.43 +
    1.44 +
    1.45 +// The following declarations are used instead of the native ones on the particular system variant:
    1.46 +//    RMmfIpcMessage replaces RMessage or RMessage2
    1.47 +//    CMmfIpcServer replaces CServer or CServer2
    1.48 +//    CMmfIpcSession replaces CSharableSession or CSession2
    1.49 +// They are used internally to the MMF component to provide configurability for the particular subsystem
    1.50 +
    1.51 +
    1.52 +#if defined(__VC32__)
    1.53 +#pragma warning( disable : 4097 )	// typedef-name used as synonym for class-name 
    1.54 +#endif
    1.55 +
    1.56 +
    1.57 +/**
    1.58 + * RSessionBase adaptor layer 
    1.59 + * Provides typechecking for client-side calls. 
    1.60 + *
    1.61 + * @publishedAll
    1.62 + */
    1.63 +
    1.64 +class RMmfSessionBase : public RSessionBase
    1.65 +	{
    1.66 +protected:
    1.67 +	// no parameter variants
    1.68 +	TInt SendReceive(TInt aFunction) const;
    1.69 +	void SendReceive(TInt aFunction, TRequestStatus& aStatus) const;
    1.70 +	// send number of parameters - no "result" parameter, just error/status 
    1.71 +	TInt SendReceive(TInt aFunction, TInt aParam0) const;
    1.72 +	TInt SendReceive(TInt aFunction, TInt aParam0, TInt aParam1) const;
    1.73 +	void SendReceive(TInt aFunction, TInt aParam0, TRequestStatus& aStatus) const;
    1.74 +	void SendReceive(TInt aFunction, TInt aParam0, TInt aParam1, TRequestStatus& aStatus) const;
    1.75 +	TInt SendReceive(TInt aFunction, const TDesC8& aParam0) const;
    1.76 +	TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1) const;
    1.77 +	TInt SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const;
    1.78 +	void SendReceive(TInt aFunction, const TDesC8& aParam0, TRequestStatus& aStatus) const;
    1.79 +	void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TRequestStatus& aStatus) const;
    1.80 +	void SendReceive(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const;
    1.81 +	// "last" parameter is result, so is passed as TDes8&
    1.82 +	TInt SendReceiveResult(TInt aFunction, TDes8& aResult) const;
    1.83 +	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult) const;
    1.84 +	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const;
    1.85 +	void SendReceiveResult(TInt aFunction, TDes8& aResult, TRequestStatus& aStatus) const;
    1.86 +	void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes8& aResult, TRequestStatus& aStatus) const;
    1.87 +	void SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const;
    1.88 +
    1.89 +	//TDesC versions
    1.90 +	void SendReceive(TInt aFunction, const TDesC& aParam0, TRequestStatus& aStatus) const;
    1.91 +	TInt SendReceive(TInt aFunction, const TDesC& aParam0) const;
    1.92 +	TInt SendReceiveResult(TInt aFunction, const TDesC8& aParam0, const TDesC8& aParam1, TDes& aResult) const;
    1.93 +
    1.94 +	// custom command versions for non-UID commands
    1.95 +	TInt SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2) const;
    1.96 +	TInt SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult) const;
    1.97 +	void SendReceive(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TRequestStatus& aStatus) const;
    1.98 +	void SendReceiveResult(TInt aFunction, TInt aParam0, const TDesC8& aParam1, const TDesC8& aParam2, TDes8& aResult, TRequestStatus& aStatus) const;
    1.99 +	};
   1.100 +	
   1.101 +#include <mmf/common/mmfipc.inl>
   1.102 +
   1.103 +#endif // __MMF_COMMON_MMFIPC_H__