1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/mmlibs/mmfw/inc/mmf/mcustomcommand.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,98 @@
     1.4 +//mcustomcommand.h
     1.5 +
     1.6 +/*
     1.7 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.8 +* All rights reserved.
     1.9 +* This component and the accompanying materials are made available
    1.10 +* under the terms of "Eclipse Public License v1.0"
    1.11 +* which accompanies this distribution, and is available
    1.12 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.13 +*
    1.14 +* Initial Contributors:
    1.15 +* Nokia Corporation - initial contribution.
    1.16 +*
    1.17 +* Contributors:
    1.18 +*
    1.19 +* Description:
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +/**
    1.27 + @file
    1.28 + @publishedPartner
    1.29 + @released
    1.30 +*/
    1.31 +
    1.32 +#ifndef __MCUSTOMCOMMAND_H
    1.33 +#define __MCUSTOMCOMMAND_H
    1.34 +
    1.35 +#include <e32std.h>
    1.36 +#include <mmf/common/mmfcontrollerframework.h>
    1.37 +
    1.38 +class MCustomCommand
    1.39 +	{
    1.40 +public:
    1.41 +	/*
    1.42 +	Send a synchronous custom command to server side.
    1.43 +	@param  aDestination. The destination of the custom command.
    1.44 +	@param  aFunction. Custom command. Meaning is dependent on Custom Interface in use.
    1.45 +	@param  aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
    1.46 +	@param  aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
    1.47 +	@param  aDataFrom. Response data from the server side CI - meaning of contents dependent on CI in use.
    1.48 +	@return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
    1.49 +	*/
    1.50 +	virtual TInt CustomCommandSync(const TMMFMessageDestinationPckg&  aDestination,
    1.51 +	                                     TInt                         aFunction,
    1.52 +	                               const TDesC8&                      aDataTo1,
    1.53 +	                               const TDesC8&                      aDataTo2,
    1.54 +	                                     TDes8&                       aDataFrom) = 0;
    1.55 +	/*
    1.56 +  	Send a synchronous custom command to server side.
    1.57 +	@param  aDestination. The destination of the custom command.
    1.58 +	@param  aFunction. Custom command. Meaning is dependent on Custom Interface in use.
    1.59 +	@param  aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
    1.60 +	@param  aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
    1.61 +	@return  Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
    1.62 +	*/
    1.63 +	virtual TInt CustomCommandSync(const TMMFMessageDestinationPckg&  aDestination,
    1.64 +	                                     TInt                         aFunction,
    1.65 +	                               const TDesC8&                      aDataTo1,
    1.66 +	                               const TDesC8&                      aDataTo2) = 0;
    1.67 +
    1.68 +	/*
    1.69 +        Send an asynchronous custom command to server side.
    1.70 +	@param  aDestination. The destination of the custom command.
    1.71 +	@param  aFunction. Custom command. Meaning is dependent on Custom Interface in use.
    1.72 +	@param  aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
    1.73 +	@param  aDataTo2.A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
    1.74 +	@param  aDataFrom. Response data from the server side CI - meaning of contents dependent on CI in use.
    1.75 +	@param  aStatus. Indicates the completion status of the request.
    1.76 +	@return  Result of the custom command.  KErrNone if successful, otherwise one of the system wide error codes.
    1.77 +	*/
    1.78 +	virtual void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination,
    1.79 +	                                      TInt                        aFunction,
    1.80 +	                                const TDesC8&                     aDataTo1,
    1.81 +	                                const TDesC8&                     aDataTo2,
    1.82 +	                                      TDes8&                      aDataFrom,
    1.83 +	                                      TRequestStatus&             aStatus) = 0;
    1.84 +	/*
    1.85 +	Send an asynchronous custom command to server side.
    1.86 +	@param  aDestination. The destination of the custom command.
    1.87 +	@param  aFunction. Custom command. Meaning is dependent on Custom Interface in use.
    1.88 +	@param  aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
    1.89 +	@param  aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
    1.90 +	@param  aStatus. Indicates the completion status of the request.
    1.91 +	@return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
    1.92 +	*/
    1.93 +	virtual void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination,
    1.94 +	                                      TInt                        aFunction,
    1.95 +	                                const TDesC8&                     aDataTo1,
    1.96 +	                                const TDesC8&                     aDataTo2,
    1.97 +	                                      TRequestStatus&             aStatus) = 0;
    1.98 +
    1.99 +	};
   1.100 +
   1.101 +#endif