Symaptic: os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/underflowautostopcontrolci.h@260cb5ec6c19

     1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // Implementation of Underflow auto stop control custom interface pair

    15 //

    16 //

    18 #ifndef UNDERFLOWAUTOSTOPCONTROLCI_H

    19 #define UNDERFLOWAUTOSTOPCONTROLCI_H

    21 #include <e32base.h>

    22 #include <mmf/common/mmfipc.h>

    23 #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

    24 #include <mmf/common/mmfipcserver.h>

    25 #endif

    26 #include <mmf/server/mmfdevsoundcustominterface.h>

    27 #include <mmf/server/mmfdevsoundcustomcommands.h>

    28 #include <mmf/server/devsoundstandardcustominterfaces.h>

    29 #include <mmf/plugin/mmfdevsoundcustominterface.hrh>

    31 /**

    32 Enum to represent the method called by this custom interface

    33 @internalComponent

    34 @prototype

    35 @file

    36 */

    37 enum TMMFDevSoundCIUnderflowAutoStopControlCommands

    38 	{

    39 	EMMFDevSoundCIUnderflowAutoStopCtrlTurnOffUnderflowAutoStop

    40 	};

    42 /**

    43 Implementation of the Underflow auto stop control custom interface Mux

    44 @internalComponent

    45 @prototype

    46 @file

    47 */

    48 class CMMFUnderflowAutoStopControlMux : public CBase,

    49 										public MMMFDevSoundCustomInterfaceMuxPlugin,

    50 										public MMMFUnderflowAutoStopControl

    51 	{

    52 public:

    54 	// from MMMFDevSoundCustomInterfaceMuxPlugin

    55 	/**

    56 	Attempt to open the interface.

    57 	@param  aInterfaceId

    58 		    The UID of the interface to open.

    59 	@return one of the system wide error codes

    60 	*/

    61 	virtual TInt OpenInterface(TUid aInterfaceId);

    63 	/**

    64 	Equivalent to destructor.  Called to destroy plugin.

    65 	*/

    66 	virtual void Release();

    68 	/**

    69 	Pass destructor key.

    70 	Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()

    71 	@param aDestructorKey

    72 		   The Uid returned by REComSession::CreateImplementationL() or similar

    73 	*/

    74 	virtual void PassDestructorKey(TUid aDestructorKey);

    76 	/**

    77 	Complete construction.

    78 	Pass additional values from the construction phase, used subsequently by the plugin.

    79 	@param aCustomUtility

    80 		   The custom interface utility used by the plugin to communicate with the remote

    81 		   server side DeMux plugin

    82 	@leave This method may leave with one of the system-wide error codes.

    83 	*/

    84 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);

    86 	/**

    87 	Return the custom interface

    88 	@param  aInterfaceId

    89 		    The UID of the required custom interface

    90 	@return the custom interface supported by this plugin

    91 	*/

    92 	virtual TAny* CustomInterface(TUid aInterfaceId);

    94 	/**

    95 	Instantiate a CI Mux class

    96 	@return the pointer to the new class, cast to the Mux plugin mixin

    97 	@leave  This method may leave with one of the system-wide error codes.

    98 	*/

    99 	static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();

   101 	// from MMMFUnderflowAutoStopControl

   102 	//@see MMMFUnderflowAutoStopControl

   103 	virtual TInt MmuascTurnOffUnderflowAutoStop();

   105 protected:

   106 	CMMFUnderflowAutoStopControlMux();

   107 	~CMMFUnderflowAutoStopControlMux();

   109 protected:

   110 	TUid iKey;

   111 	TInt iRemoteHandle;

   112 	MMMFDevSoundCustomInterfaceMuxUtility* iUtility;

   113 	};

   116 /**

   117 Implementation of the Underflow auto stop control custom interface DeMux

   118 @internalComponent

   119 @prototype

   120 @file

   121 */

   122 class CMMFUnderflowAutoStopControlDeMux : public CBase,

   123 										  public MMMFDevSoundCustomInterfaceDeMuxPlugin

   124 	{

   125 public:

   126 	/**

   127 	Instantiate a CMMFUnderflowAutoStopControlDeMux class

   128 	@return a pointer to the new class cast to the DeMux plugin mixin

   129 	@leave  This method may leave with one of the system-wide error codes.

   130 	*/

   131 	static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();

   133 	/**

   134 	Attempt to open the interface.

   135 	@param  aInterfaceId

   136 		    The UID of the interface to open.

   137 	@return a handle to the remote plugin

   138 	*/

   139 	virtual TInt OpenInterface(TUid aInterfaceId);

   141 	/**

   142 	Equivalent to destructor.  Called to destroy plugin.

   143 	*/

   144 	virtual void Release();

   146 	/**

   147 	Pass destructor key.

   148 	Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()

   149 	@param aDestructorKey

   150 		   The Uid returned by REComSession::CreateImplementationL() or similar

   151 	*/

   152 	virtual void PassDestructorKey(TUid aDestructorKey);

   154 	/**

   155 	Set the target of the custom interface call

   156 	@param aTarget

   157 		   The DevSound to call the custom interface on.

   158 	*/

   159 	virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);

   161 	/**

   162 	Complete construction.

   163 	@param aUtility

   164 		   The DeMux utility to use

   165 	@leave This method may leave with one of the system-wide error codes.

   166 	*/

   167 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);

   169 	/**

   170 	Refresh the current custom interface connections

   171 	@leave This method may leave with one of the system-wide error codes.

   172 	*/

   173 	virtual void RefreshL();

   175 	// from MMMFDevSoundCustomInterfaceDeMuxPlugin

   176 	/**

   177 	Open the slave

   178 	@param  aInterface

   179 		    The UID of the requested interface

   180 	@param  aPackageBuf

   181 		    A package of data that can be supplied for initialisation

   182 	@return the result of the operation

   183 	@leave  This method may leave with one of the system-wide error codes.

   184 	*/

   185 	virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf);

   187 	/**

   188 	Close the slave

   189 	@param aHandle

   190 		   The handle of the slave plugin

   191 	@leave This method may leave with one of the system-wide error codes.

   192 	*/

   193 	virtual void DoCloseSlaveL(TInt aHandle);

   195 	// original RMessage is supplied so that remote DeMux plugin can extract necessary details

   196 	// using DeMux utility

   198 	/**

   199 	Relay the synchronous custom command onto the slave

   200 	@param  aMessage

   201 		    The IPC message to be sent to the slave

   202 	@return the result of the operation

   203 	@leave  This method may leave with one of the system-wide error codes.

   204 	*/

   205 	virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);

   207 	/**

   208 	Relay the synchronous custom command onto the slave and obtain a result

   209 	@param  aMessage

   210 		    The IPC message to be sent to the slave

   211 	@return the result of the operation

   212 	@leave  This method may leave with one of the system-wide error codes.

   213 	*/

   214 	virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);

   216 	/**

   217 	Relay an asynchronous command onto the slave

   218 	@param aMessage

   219 		   The IPC message to be sent to the slave

   220 	@leave This method may leave with one of the system-wide error codes.

   221 	*/

   222 	virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);

   224 	/**

   225 	Relay an asynchronous command onto the slave and obtain a result

   226 	@param aMessage

   227 		   The IPC message to be sent to the slave@param aMessage

   228 	@leave This method may leave with one of the system-wide error codes.

   229 	*/

   230 	virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);

   232 protected:

   233 	~CMMFUnderflowAutoStopControlDeMux();

   234 	CMMFUnderflowAutoStopControlDeMux();

   236 	// from mirror MmuascTurnOffUnderflowAutoStop method.

   237 	TInt DoMmuascTurnOffUnderflowAutoStopL();

   239 protected:

   240 	MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;

   241 	MMMFDevSoundCustomInterfaceTarget*		 iTarget;

   242 	TUid							iKey;

   243 	MMMFUnderflowAutoStopControl*	iInterfaceUnderflowAutoStopCtrl;

   244 	};

   246 #endif

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--