|
sl@0
|
1 |
//mcustomcommand.h
|
|
sl@0
|
2 |
|
|
sl@0
|
3 |
/*
|
|
sl@0
|
4 |
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
5 |
* All rights reserved.
|
|
sl@0
|
6 |
* This component and the accompanying materials are made available
|
|
sl@0
|
7 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
8 |
* which accompanies this distribution, and is available
|
|
sl@0
|
9 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
10 |
*
|
|
sl@0
|
11 |
* Initial Contributors:
|
|
sl@0
|
12 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Contributors:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
* Description:
|
|
sl@0
|
17 |
*
|
|
sl@0
|
18 |
*/
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
/**
|
|
sl@0
|
24 |
@file
|
|
sl@0
|
25 |
@publishedPartner
|
|
sl@0
|
26 |
@released
|
|
sl@0
|
27 |
*/
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
#ifndef __MCUSTOMCOMMAND_H
|
|
sl@0
|
30 |
#define __MCUSTOMCOMMAND_H
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
#include <e32std.h>
|
|
sl@0
|
33 |
#include <mmf/common/mmfcontrollerframework.h>
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
class MCustomCommand
|
|
sl@0
|
36 |
{
|
|
sl@0
|
37 |
public:
|
|
sl@0
|
38 |
/*
|
|
sl@0
|
39 |
Send a synchronous custom command to server side.
|
|
sl@0
|
40 |
@param aDestination. The destination of the custom command.
|
|
sl@0
|
41 |
@param aFunction. Custom command. Meaning is dependent on Custom Interface in use.
|
|
sl@0
|
42 |
@param aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
|
|
sl@0
|
43 |
@param aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
|
|
sl@0
|
44 |
@param aDataFrom. Response data from the server side CI - meaning of contents dependent on CI in use.
|
|
sl@0
|
45 |
@return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
virtual TInt CustomCommandSync(const TMMFMessageDestinationPckg& aDestination,
|
|
sl@0
|
48 |
TInt aFunction,
|
|
sl@0
|
49 |
const TDesC8& aDataTo1,
|
|
sl@0
|
50 |
const TDesC8& aDataTo2,
|
|
sl@0
|
51 |
TDes8& aDataFrom) = 0;
|
|
sl@0
|
52 |
/*
|
|
sl@0
|
53 |
Send a synchronous custom command to server side.
|
|
sl@0
|
54 |
@param aDestination. The destination of the custom command.
|
|
sl@0
|
55 |
@param aFunction. Custom command. Meaning is dependent on Custom Interface in use.
|
|
sl@0
|
56 |
@param aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
|
|
sl@0
|
57 |
@param aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
|
|
sl@0
|
58 |
@return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
59 |
*/
|
|
sl@0
|
60 |
virtual TInt CustomCommandSync(const TMMFMessageDestinationPckg& aDestination,
|
|
sl@0
|
61 |
TInt aFunction,
|
|
sl@0
|
62 |
const TDesC8& aDataTo1,
|
|
sl@0
|
63 |
const TDesC8& aDataTo2) = 0;
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
/*
|
|
sl@0
|
66 |
Send an asynchronous custom command to server side.
|
|
sl@0
|
67 |
@param aDestination. The destination of the custom command.
|
|
sl@0
|
68 |
@param aFunction. Custom command. Meaning is dependent on Custom Interface in use.
|
|
sl@0
|
69 |
@param aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
|
|
sl@0
|
70 |
@param aDataTo2.A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
|
|
sl@0
|
71 |
@param aDataFrom. Response data from the server side CI - meaning of contents dependent on CI in use.
|
|
sl@0
|
72 |
@param aStatus. Indicates the completion status of the request.
|
|
sl@0
|
73 |
@return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
74 |
*/
|
|
sl@0
|
75 |
virtual void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination,
|
|
sl@0
|
76 |
TInt aFunction,
|
|
sl@0
|
77 |
const TDesC8& aDataTo1,
|
|
sl@0
|
78 |
const TDesC8& aDataTo2,
|
|
sl@0
|
79 |
TDes8& aDataFrom,
|
|
sl@0
|
80 |
TRequestStatus& aStatus) = 0;
|
|
sl@0
|
81 |
/*
|
|
sl@0
|
82 |
Send an asynchronous custom command to server side.
|
|
sl@0
|
83 |
@param aDestination. The destination of the custom command.
|
|
sl@0
|
84 |
@param aFunction. Custom command. Meaning is dependent on Custom Interface in use.
|
|
sl@0
|
85 |
@param aDataTo1. A buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
|
|
sl@0
|
86 |
@param aDataTo2. A 2nd buffer of data to be supplied to the receiver - meaning of contents dependent on CI in use.
|
|
sl@0
|
87 |
@param aStatus. Indicates the completion status of the request.
|
|
sl@0
|
88 |
@return Result of the custom command. KErrNone if successful, otherwise one of the system wide error codes.
|
|
sl@0
|
89 |
*/
|
|
sl@0
|
90 |
virtual void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination,
|
|
sl@0
|
91 |
TInt aFunction,
|
|
sl@0
|
92 |
const TDesC8& aDataTo1,
|
|
sl@0
|
93 |
const TDesC8& aDataTo2,
|
|
sl@0
|
94 |
TRequestStatus& aStatus) = 0;
|
|
sl@0
|
95 |
|
|
sl@0
|
96 |
};
|
|
sl@0
|
97 |
|
|
sl@0
|
98 |
#endif
|