|
1 /* |
|
2 * Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * Name : sipremoteprofile.h |
|
16 * Part of : SIP Profile Client |
|
17 * Interface : private |
|
18 * Version : 1.0 |
|
19 * |
|
20 */ |
|
21 |
|
22 |
|
23 |
|
24 |
|
25 /** |
|
26 @internalComponent |
|
27 */ |
|
28 |
|
29 #ifndef RSIPPROFILE_H |
|
30 #define RSIPPROFILE_H |
|
31 |
|
32 // INCLUDES |
|
33 |
|
34 #include <e32std.h> |
|
35 #include "sipprofilecs.h" |
|
36 |
|
37 // FORWARD DECLARATIONS |
|
38 |
|
39 // CLASS DECLARATION |
|
40 |
|
41 /** |
|
42 * The class that provides connection to profile server over ITC. |
|
43 * |
|
44 * @lib sipprofilecli.lib |
|
45 */ |
|
46 class RSIPProfile: public RSessionBase |
|
47 { |
|
48 public: |
|
49 |
|
50 /** |
|
51 * Default constructor |
|
52 */ |
|
53 RSIPProfile(); |
|
54 |
|
55 /** |
|
56 * Connect to profile server |
|
57 * @return KErrNone if successfull |
|
58 */ |
|
59 TInt Connect(); |
|
60 |
|
61 /** |
|
62 * Close connection to profile server |
|
63 */ |
|
64 void Close(); |
|
65 |
|
66 /** |
|
67 * Gets the version number of the server |
|
68 * @return version number of server |
|
69 */ |
|
70 TVersion Version() const; |
|
71 |
|
72 /** |
|
73 * Send syncronous request to the server |
|
74 * @param aArgs, the message argument array |
|
75 * @param aFunction, opcode specifying the requested service |
|
76 * @return KErrNone if successfull |
|
77 */ |
|
78 TInt Send(TIpcArgs& aArgs, TSipProfileItcFunctions aFunction); |
|
79 |
|
80 /** |
|
81 * Send asyncronous request to the server, events allowed |
|
82 * @param aArgs, the message argument array |
|
83 * @param aStatus, a status of the asynchronous request |
|
84 */ |
|
85 void Receive(TIpcArgs& aArgs, TRequestStatus& aStatus); |
|
86 |
|
87 /** |
|
88 * Cancel asyncronous request to the server, events cancelled |
|
89 * @param aPtr, pointer to the message argument array |
|
90 * @param aStatus, a status of the asynchronous request |
|
91 */ |
|
92 void CancelReceive(); |
|
93 |
|
94 private: |
|
95 |
|
96 /** |
|
97 * Panic this client |
|
98 * @param aReason, a panic reason code |
|
99 */ |
|
100 void Panic(TInt aReason); |
|
101 |
|
102 private: |
|
103 |
|
104 TBool iConnected; |
|
105 }; |
|
106 |
|
107 #endif |