4 * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
6 * This component and the accompanying materials are made available
7 * under the terms of "Eclipse Public License v1.0"
8 * which accompanies this distribution, and is available
9 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
11 * Initial Contributors:
12 * Nokia Corporation - initial contribution.
29 #ifndef __MCUSTOMCOMMAND_H
30 #define __MCUSTOMCOMMAND_H
33 #include <mmf/common/mmfcontrollerframework.h>
39 Send a synchronous custom command to server side.
40 @param aDestination. The destination of the custom command.
41 @param aFunction. Custom command. Meaning is dependent on Custom Interface in use.
42 @param aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
43 @param aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
44 @param aDataFrom. Response data from the server side CI - meaning of contents dependent on CI in use.
45 @return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
47 virtual TInt CustomCommandSync(const TMMFMessageDestinationPckg& aDestination,
49 const TDesC8& aDataTo1,
50 const TDesC8& aDataTo2,
51 TDes8& aDataFrom) = 0;
53 Send a synchronous custom command to server side.
54 @param aDestination. The destination of the custom command.
55 @param aFunction. Custom command. Meaning is dependent on Custom Interface in use.
56 @param aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
57 @param aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
58 @return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
60 virtual TInt CustomCommandSync(const TMMFMessageDestinationPckg& aDestination,
62 const TDesC8& aDataTo1,
63 const TDesC8& aDataTo2) = 0;
66 Send an asynchronous custom command to server side.
67 @param aDestination. The destination of the custom command.
68 @param aFunction. Custom command. Meaning is dependent on Custom Interface in use.
69 @param aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
70 @param aDataTo2.A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
71 @param aDataFrom. Response data from the server side CI - meaning of contents dependent on CI in use.
72 @param aStatus. Indicates the completion status of the request.
73 @return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
75 virtual void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination,
77 const TDesC8& aDataTo1,
78 const TDesC8& aDataTo2,
80 TRequestStatus& aStatus) = 0;
82 Send an asynchronous custom command to server side.
83 @param aDestination. The destination of the custom command.
84 @param aFunction. Custom command. Meaning is dependent on Custom Interface in use.
85 @param aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
86 @param aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
87 @param aStatus. Indicates the completion status of the request.
88 @return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
90 virtual void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination,
92 const TDesC8& aDataTo1,
93 const TDesC8& aDataTo2,
94 TRequestStatus& aStatus) = 0;