|
1 /* |
|
2 * Copyright (c) 2006-2007 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: ECom interface definition for HSS management services. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef HSSMGMTINTERFACE_H |
|
21 #define HSSMGMTINTERFACE_H |
|
22 |
|
23 // INCLUDES |
|
24 #include "hssmgmtcommon.h" |
|
25 #include "hssmgmtscaninfo.h" |
|
26 #include "hssiapsettings.h" |
|
27 |
|
28 |
|
29 // CLASS DECLARATION |
|
30 /** |
|
31 * @brief ECom interface class for HSS management services. |
|
32 * |
|
33 * This class contains the methods for managing HSS connections |
|
34 * and querying the statuses of various connection variables. |
|
35 */ |
|
36 class MHssMgmtInterface |
|
37 { |
|
38 public: |
|
39 |
|
40 /** |
|
41 * Activate the notification service. |
|
42 * |
|
43 * After the client has enabled the notification service, it can |
|
44 * receive asynchronous notifications from the server. |
|
45 * @param aCallback The class that implements the callback interface. |
|
46 */ |
|
47 virtual void ActivateNotificationsL( MHssMgmtNotifications& aCallback ) = 0; |
|
48 |
|
49 /** |
|
50 * Cancel the notification service. |
|
51 */ |
|
52 virtual void CancelNotifications() = 0; |
|
53 |
|
54 /** |
|
55 * Perform a scan and return the detected HSS networks. |
|
56 * @param aResults Results of the scan. |
|
57 * @return KErrNone if successful, otherwise one of the system-wide |
|
58 * error codes. |
|
59 */ |
|
60 virtual TInt GetScanResults( CHssMgmtScanInfo& aResults ) = 0; |
|
61 |
|
62 |
|
63 /** |
|
64 * Create and Protect IAP, register Client. |
|
65 * |
|
66 * @param aUid UID of the client. |
|
67 * @param aIapName Name of the IAP to be registered. |
|
68 * @param aWaitNote Indication of UI authentication, if in use TRUE, else FALSE. |
|
69 * @return IAP ID if successful, otherwise 0 is returned (0 can't be IAP id). |
|
70 */ |
|
71 virtual TUint Register( const TUid aUid, |
|
72 const TDesC& aIapName, |
|
73 const TUint aWaitNote ) = 0; |
|
74 |
|
75 |
|
76 /** |
|
77 * Delete IAP and unregister Client. |
|
78 * |
|
79 * @param aUid, UID of the client. |
|
80 * @param aIapId, ID of the IAP. |
|
81 * @param aNetworkId, ID of Network which IAP belongs to. |
|
82 * @return KErrNone, if IAP removal successful; |
|
83 * otherwise one of the other system-wide error codes. |
|
84 */ |
|
85 virtual TInt UnRegister( const TUid aUid, |
|
86 const TUint aIapId, |
|
87 const TUint aNetworkId ) = 0; |
|
88 |
|
89 /** |
|
90 * Change IAP settings. |
|
91 * |
|
92 * @param aIapId ID of the IAP. |
|
93 * @param aSettings Settings of the IAP. |
|
94 * @return KErrNone if HotSpot FW was able to receive message; |
|
95 * otherwise one of the other system-wide error codes. |
|
96 */ |
|
97 virtual TInt ChangeSettings( const TUint aIapId, |
|
98 const THssIapSettings &aSettings ) = 0; |
|
99 |
|
100 /** |
|
101 * Associate IAP with network. |
|
102 * |
|
103 * @param aIapId ID of the IAP. |
|
104 * @return KErrNone if HotSpot FW was able to receive message; |
|
105 * otherwise one of the other system-wide error codes. |
|
106 */ |
|
107 virtual TInt Join( const TUint aIapId ) = 0; |
|
108 |
|
109 /** |
|
110 * Cancel IAP association. |
|
111 * |
|
112 * @param aIapId ID of the IAP. |
|
113 * @return KErrNone if HotSpot FW was able to receive message; |
|
114 * otherwise one of the other system-wide error codes. |
|
115 */ |
|
116 virtual TInt CancelStart( const TUint aIapId ) = 0; |
|
117 |
|
118 /** |
|
119 * Stop associating IAP. |
|
120 * |
|
121 * @param aIapId ID of the IAP. |
|
122 * @return KErrNone if HotSpot FW was able to receive message; |
|
123 * otherwise one of the other system-wide error codes. |
|
124 */ |
|
125 virtual TInt Stop( const TUint aIapId ) = 0; |
|
126 |
|
127 /** |
|
128 * Inform login completion. |
|
129 * |
|
130 * @param aIapId ID of the IAP. |
|
131 * @param aStatus, Result of login procedure. |
|
132 * @return KErrNone if HotSpot FW was able to receive message; |
|
133 * otherwise one of the other system-wide error codes. |
|
134 */ |
|
135 virtual TInt LoginComplete( const TUint aIapId, const TInt aStatus ) = 0; |
|
136 |
|
137 /** |
|
138 * Inform logout completion. |
|
139 * |
|
140 * @param aIapId ID of the IAP. |
|
141 * @return KErrNone if HotSpot FW was able to receive message; |
|
142 * otherwise one of the other system-wide error codes. |
|
143 */ |
|
144 virtual TInt LogoutComplete( const TUint aIapId ) = 0; |
|
145 |
|
146 /** |
|
147 * Check status of BackgroundScan. |
|
148 * @return 0 if off, otherwise number as scan interval in seconds. |
|
149 */ |
|
150 virtual TUint32 CheckBackgroundScan() = 0; |
|
151 |
|
152 /** |
|
153 * Get the BSSID of the currently connected AP. |
|
154 * @param aBssId, MAC address of a connection |
|
155 * @return KErrNone if successful, |
|
156 * otherwise one of the other system-wide error codes. |
|
157 */ |
|
158 virtual TInt GetConnectionBssid( THssBssid& aBssId ) = 0; |
|
159 |
|
160 /** |
|
161 * Add an SSID list to the given IAP. |
|
162 * @param aIapId, IAP ID given. |
|
163 * @param aSsidList, SSID list to add to the IAP. |
|
164 * @return KErrNone if successful, |
|
165 * otherwise one of the other system-wide error codes. |
|
166 */ |
|
167 virtual TInt AddIapSsidList( |
|
168 TUint aIapId, |
|
169 const CArrayFixFlat<THssSsid>& aSsidList ) = 0; |
|
170 |
|
171 /** |
|
172 * Gets all Iaps of client |
|
173 * @param aUId, UID of client |
|
174 * @param aIapIdArray, Array for client's Iaps |
|
175 * @return None |
|
176 */ |
|
177 virtual TInt GetClientIaps( const TUid aUid, RArray<TUint>& aIapIdArray ) = 0; |
|
178 |
|
179 /** |
|
180 * Set login and logout timer values of this client. |
|
181 * If given values aren't suitable, the default values are set. |
|
182 * @param aClientUid, Client's UID: clients may have own timer values, |
|
183 * @param aLoginTimerValue, login timer value in seconds, |
|
184 * @param aLogoutTimerValue, logout timer value in seconds. |
|
185 * @return KErrNone if successful, |
|
186 * otherwise one of the other system-wide error codes. |
|
187 */ |
|
188 virtual TInt SetTimerValues ( |
|
189 TUid aClientUid, |
|
190 TUint aLoginTimerValue, |
|
191 TUint aLogoutTimerValue ) = 0; |
|
192 |
|
193 }; |
|
194 |
|
195 #endif // HSSMGMTINTERFACE_H |
|
196 |
|
197 // End of File |