os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/cmmfdevsoundcifileblocklength.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/cmmfdevsoundcifileblocklength.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,220 @@
1.4 +// Copyright (c) 2006-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 CMMFDEVSOUNDCIFILEBLOCKLENGTH_H
1.20 +#define CMMFDEVSOUNDCIFILEBLOCKLENGTH_H
1.21 +
1.22 +#include <e32base.h>
1.23 +#include <mmf/common/mmfipc.h>
1.24 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.25 +#include <mmf/common/mmfipcserver.h>
1.26 +#endif
1.27 +#include <mmf/server/mmfdevsoundcustominterface.h>
1.28 +#include <mmf/server/mmfdevsoundcustomcommands.h>
1.29 +#include <mmf/server/devsoundstandardcustominterfaces.h>
1.30 +
1.31 +
1.32 +enum TMMFDevSoundCIBlockLengthCommands
1.33 + {
1.34 + EMMFDevSoundCIBlockLengthSetFileBlockLength = 0
1.35 + };
1.36 +
1.37 +/**
1.38 + * CMMFDevSoundCIFileBlockLengthMux
1.39 + *
1.40 + * implementation of the FileBlockLength custom interface pair
1.41 + */
1.42 +class CMMFDevSoundCIFileBlockLengthMux : public CBase,
1.43 + public MMMFDevSoundCustomInterfaceMuxPlugin,
1.44 + public MMMFDevSoundCustomInterfaceFileBlockLength
1.45 + {
1.46 +public:
1.47 + /**
1.48 + Attempt to open the interface.
1.49 + @param aInterfaceId
1.50 + The UID of the interface to open.
1.51 + @return one of the system wide error codes
1.52 + */
1.53 + virtual TInt OpenInterface(TUid aInterfaceId);
1.54 +
1.55 + /**
1.56 + Equivalent to destructor. Called to destroy plugin.
1.57 + */
1.58 + virtual void Release();
1.59 + /**
1.60 + Pass destructor key.
1.61 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.62 + @param aDestructorKey
1.63 + The Uid returned by REComSession::CreateImplementationL() or similar
1.64 + */
1.65 + virtual void PassDestructorKey(TUid aDestructorKey);
1.66 +
1.67 + /**
1.68 + Complete construction.
1.69 + Pass additional values from the construction phase, used subsequently by the plugin.
1.70 + @param aCustomUtility
1.71 + The custom interface utility used by the plugin to communicate with the remote
1.72 + server side DeMux plugin
1.73 + */
1.74 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);
1.75 +
1.76 + /**
1.77 + Return the custom interface
1.78 + @param aInterfaceId
1.79 + The UID of the required custom interface
1.80 + @return the custom interface supported by this plugin
1.81 + */
1.82 + virtual TAny* CustomInterface(TUid aInterfaceId);
1.83 +
1.84 + /**
1.85 + Instantiate a CMMFDevSoundCIFileBlockLengthMux class
1.86 + @return the pointer to the new class, cast to the Mux plugin mixin
1.87 + */
1.88 + static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();
1.89 +
1.90 +protected:
1.91 + // from MMMFDevSoundCustomInterfaceFileBlockLength
1.92 + virtual void SetFileBlockLength(TUint aBlockAlign);
1.93 +
1.94 + CMMFDevSoundCIFileBlockLengthMux();
1.95 + ~CMMFDevSoundCIFileBlockLengthMux();
1.96 +
1.97 +protected:
1.98 + TUid iKey;
1.99 + TInt iRemoteHandle;
1.100 + MMMFDevSoundCustomInterfaceMuxUtility* iUtility;
1.101 + };
1.102 +
1.103 +
1.104 +/**
1.105 + * DeMux side of pair
1.106 + */
1.107 +
1.108 +class CMMFDevSoundCIFileBlockLengthDeMux : public CBase,
1.109 + public MMMFDevSoundCustomInterfaceDeMuxPlugin
1.110 + {
1.111 +public:
1.112 + /**
1.113 + Instantiate a CMMFDevSoundCIFileBlockLengthDeMux class
1.114 + @return a pointer to the new class cast to the DeMux plugin mixin
1.115 + */
1.116 + static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();
1.117 +
1.118 + /**
1.119 + Attempt to open the interface.
1.120 + @param aInterfaceId
1.121 + The UID of the interface to open.
1.122 + @return a handle to the remote plugin
1.123 + */
1.124 + virtual TInt OpenInterface(TUid aInterfaceId);
1.125 +
1.126 + /**
1.127 + Equivalent to destructor. Called to destroy plugin.
1.128 + */
1.129 + virtual void Release();
1.130 + /**
1.131 + Pass destructor key.
1.132 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.133 + @param aDestructorKey
1.134 + The Uid returned by REComSession::CreateImplementationL() or similar
1.135 + */
1.136 + virtual void PassDestructorKey(TUid aDestructorKey);
1.137 +
1.138 + /**
1.139 + Set the target of the custom interface call
1.140 + @param aTarget
1.141 + The DevSound to call the custom interface on.
1.142 + */
1.143 + virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);
1.144 +
1.145 + /**
1.146 + Complete construction.
1.147 + @param aUtility
1.148 + The DeMux utility to use
1.149 + */
1.150 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);
1.151 +
1.152 + /**
1.153 + Refresh the current custom interface connections
1.154 + */
1.155 + virtual void RefreshL();
1.156 +
1.157 + // from MMMFDeMuxInterface
1.158 + /**
1.159 + Open the slave
1.160 + @param aInterface
1.161 + The UID of the requested interface
1.162 + @param aPackageBuf
1.163 + A package of data that can be supplied for initialisation
1.164 + @return the result of the operation
1.165 + */
1.166 + virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf);
1.167 +
1.168 + /**
1.169 + Close the slave
1.170 + @param aHandle
1.171 + The handle of the slave plugin
1.172 + */
1.173 + virtual void DoCloseSlaveL(TInt aHandle);
1.174 +
1.175 + // original RMessage is supplied so that remote demux plugin can extract necessary details
1.176 + // using DeMux utility
1.177 +
1.178 + /**
1.179 + Relay the synchronous custom command onto the slave
1.180 + @param aMessage
1.181 + The IPC message to be sent to the slave
1.182 + @return the result of the operation
1.183 + */
1.184 + virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);
1.185 +
1.186 + /**
1.187 + Relay the synchronous custom command onto the slave and obtain a result
1.188 + @param aMessage
1.189 + The IPC message to be sent to the slave
1.190 + @return the result of the operation
1.191 + */
1.192 + virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);
1.193 +
1.194 + /**
1.195 + Relay an asynchronous command onto the slave
1.196 + @param aMessage
1.197 + The IPC message to be sent to the slave
1.198 + */
1.199 + virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);
1.200 +
1.201 + /**
1.202 + Relay an asynchronous command onto the slave and obtain a result
1.203 + @param aMessage
1.204 + The IPC message to be sent to the slave@param aMessage
1.205 + */
1.206 + virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);
1.207 +
1.208 +protected:
1.209 + ~CMMFDevSoundCIFileBlockLengthDeMux();
1.210 + CMMFDevSoundCIFileBlockLengthDeMux();
1.211 +
1.212 + // implementation of FileBlockLength custom interface
1.213 + void DoSetFileBlockLengthL(TUint aBlockAlign);
1.214 +
1.215 +protected:
1.216 + MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;
1.217 + MMMFDevSoundCustomInterfaceTarget* iTarget;
1.218 + MMMFDevSoundCustomInterfaceFileBlockLength* iFileBlockLengthInterface;
1.219 + TUid iKey;
1.220 +
1.221 + };
1.222 +
1.223 +#endif