sl@0: //mcustomcommand.h
sl@0: 
sl@0: /*
sl@0: * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:  @file
sl@0:  @publishedPartner
sl@0:  @released
sl@0: */
sl@0: 
sl@0: #ifndef __MCUSTOMCOMMAND_H
sl@0: #define __MCUSTOMCOMMAND_H
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <mmf/common/mmfcontrollerframework.h>
sl@0: 
sl@0: class MCustomCommand
sl@0: 	{
sl@0: public:
sl@0: 	/*
sl@0: 	Send a synchronous custom command to server side.
sl@0: 	@param  aDestination. The destination of the custom command.
sl@0: 	@param  aFunction. Custom command. Meaning is dependent on Custom Interface in use.
sl@0: 	@param  aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
sl@0: 	@param  aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
sl@0: 	@param  aDataFrom. Response data from the server side CI - meaning of contents dependent on CI in use.
sl@0: 	@return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
sl@0: 	*/
sl@0: 	virtual TInt CustomCommandSync(const TMMFMessageDestinationPckg&  aDestination,
sl@0: 	                                     TInt                         aFunction,
sl@0: 	                               const TDesC8&                      aDataTo1,
sl@0: 	                               const TDesC8&                      aDataTo2,
sl@0: 	                                     TDes8&                       aDataFrom) = 0;
sl@0: 	/*
sl@0:   	Send a synchronous custom command to server side.
sl@0: 	@param  aDestination. The destination of the custom command.
sl@0: 	@param  aFunction. Custom command. Meaning is dependent on Custom Interface in use.
sl@0: 	@param  aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
sl@0: 	@param  aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
sl@0: 	@return  Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
sl@0: 	*/
sl@0: 	virtual TInt CustomCommandSync(const TMMFMessageDestinationPckg&  aDestination,
sl@0: 	                                     TInt                         aFunction,
sl@0: 	                               const TDesC8&                      aDataTo1,
sl@0: 	                               const TDesC8&                      aDataTo2) = 0;
sl@0: 
sl@0: 	/*
sl@0:         Send an asynchronous custom command to server side.
sl@0: 	@param  aDestination. The destination of the custom command.
sl@0: 	@param  aFunction. Custom command. Meaning is dependent on Custom Interface in use.
sl@0: 	@param  aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
sl@0: 	@param  aDataTo2.A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
sl@0: 	@param  aDataFrom. Response data from the server side CI - meaning of contents dependent on CI in use.
sl@0: 	@param  aStatus. Indicates the completion status of the request.
sl@0: 	@return  Result of the custom command.  KErrNone if successful, otherwise one of the system wide error codes.
sl@0: 	*/
sl@0: 	virtual void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination,
sl@0: 	                                      TInt                        aFunction,
sl@0: 	                                const TDesC8&                     aDataTo1,
sl@0: 	                                const TDesC8&                     aDataTo2,
sl@0: 	                                      TDes8&                      aDataFrom,
sl@0: 	                                      TRequestStatus&             aStatus) = 0;
sl@0: 	/*
sl@0: 	Send an asynchronous custom command to server side.
sl@0: 	@param  aDestination. The destination of the custom command.
sl@0: 	@param  aFunction. Custom command. Meaning is dependent on Custom Interface in use.
sl@0: 	@param  aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
sl@0: 	@param  aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
sl@0: 	@param  aStatus. Indicates the completion status of the request.
sl@0: 	@return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
sl@0: 	*/
sl@0: 	virtual void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination,
sl@0: 	                                      TInt                        aFunction,
sl@0: 	                                const TDesC8&                     aDataTo1,
sl@0: 	                                const TDesC8&                     aDataTo2,
sl@0: 	                                      TRequestStatus&             aStatus) = 0;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #endif