epoc32/include/mmf/common/mmfipcserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
// include\mmf\common\mmfipc.h
williamr@4
    15
// Thin interface layer to use either V1 or V2 IPC calls as appropriate
williamr@4
    16
// 
williamr@4
    17
//
williamr@4
    18
williamr@4
    19
#ifndef __MMF_COMMON_MMFIPC_SERVER_H__
williamr@4
    20
#define __MMF_COMMON_MMFIPC_SERVER_H__
williamr@4
    21
williamr@4
    22
#include <e32base.h>
williamr@4
    23
#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    24
#include <mmf/common/mmfipc.h>
williamr@4
    25
#endif
williamr@4
    26
williamr@4
    27
// The following declarations are used instead of the native ones on the particular system variant:
williamr@4
    28
//    RMmfIpcMessage replaces RMessage or RMessage2
williamr@4
    29
//    CMmfIpcServer replaces CServer or CServer2
williamr@4
    30
//    CMmfIpcSession replaces CSharableSession or CSession2
williamr@4
    31
// They are used internally to the MMF component to provide configurability for the particular subsystem
williamr@4
    32
williamr@4
    33
#ifdef __MMF_USE_IPC_V2__
williamr@4
    34
williamr@4
    35
//typedef RMessage2 RMmfIpcMessage;
williamr@4
    36
williamr@4
    37
class CMmfIpcServer; // forward declaration
williamr@4
    38
williamr@4
    39
/**
williamr@4
    40
 * derive CMmfIpcSession from CSession2 so we can bridge the differences to old CSharableSession
williamr@4
    41
 *
williamr@4
    42
 * @internalTechnology
williamr@4
    43
 */
williamr@4
    44
 
williamr@4
    45
class CMmfIpcSession : public CSession2
williamr@4
    46
	{
williamr@4
    47
protected:
williamr@4
    48
	virtual void CreateL(const CMmfIpcServer& aServer);
williamr@4
    49
	CMmfIpcSession() {}
williamr@4
    50
	// from CSession2
williamr@4
    51
	void CreateL();
williamr@4
    52
	};
williamr@4
    53
williamr@4
    54
/*
williamr@4
    55
 * derive CMmfIpcServer from CServer2 so we can bridge difference to old CServer
williamr@4
    56
 *
williamr@4
    57
 * @internalTechnology
williamr@4
    58
 */
williamr@4
    59
 
williamr@4
    60
class CMmfIpcServer : public CServer2
williamr@4
    61
	{
williamr@4
    62
protected:
williamr@4
    63
	virtual CMmfIpcSession* NewSessionL(const TVersion& aVersion) const=0;
williamr@4
    64
	CMmfIpcServer(TInt aPriority,TServerType aType=EUnsharableSessions);
williamr@4
    65
private:
williamr@4
    66
	// derived from CServer2
williamr@4
    67
	CSession2* NewSessionL(const TVersion& aVersion,const RMessage2& aMessage) const;
williamr@4
    68
	};
williamr@4
    69
williamr@4
    70
#else // __MMF_USE_IPC_V2__
williamr@4
    71
williamr@4
    72
// otherwise always use V1
williamr@4
    73
//typedef RMessage RMmfIpcMessage;
williamr@4
    74
typedef CServer CMmfIpcServer;
williamr@4
    75
typedef CSharableSession CMmfIpcSession;
williamr@4
    76
williamr@4
    77
#endif // __MMF_USE_IPC_V2__
williamr@4
    78
williamr@4
    79
#if defined(__VC32__)
williamr@4
    80
#pragma warning( disable : 4097 )	// typedef-name used as synonym for class-name 
williamr@4
    81
#endif
williamr@4
    82
williamr@4
    83
williamr@4
    84
/**
williamr@4
    85
 * Adapt RMessage calls between IPC variants
williamr@4
    86
 *
williamr@4
    87
 * @internalTechnology
williamr@4
    88
 */
williamr@4
    89
williamr@4
    90
class MmfMessageUtil 
williamr@4
    91
	{
williamr@4
    92
public:
williamr@4
    93
	static TInt Read(const RMmfIpcMessage& aMessage, TInt aParam, TDes8& aResult);
williamr@4
    94
	static TInt Write(const RMmfIpcMessage& aMessage, TInt aParam, const TDesC8& aValue);
williamr@4
    95
	static void ReadL(const RMmfIpcMessage& aMessage, TInt aParam, TDes8& aResult);
williamr@4
    96
	static void WriteL(const RMmfIpcMessage& aMessage, TInt aParam, const TDesC8& aValue);
williamr@4
    97
	};
williamr@4
    98
	
williamr@4
    99
#include <mmf/common/mmfipcserver.inl>
williamr@4
   100
williamr@4
   101
#endif // __MMF_COMMON_MMFIPC_SERVER_H__