2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
18 * @file FTelNetworkManager.h
19 * @brief This is the header file for the %NetworkManager class.
21 * This header file contains the declarations of the %NetworkManager class.
23 #ifndef _FTEL_NETWORK_MANAGER_H_
24 #define _FTEL_NETWORK_MANAGER_H_
28 #include <FTelNetworkInfo.h>
29 #include <FTelNetworkStatus.h>
32 namespace Tizen { namespace Telephony
34 class _NetworkManagerImpl;
35 class ITelephonyNetworkEventListener;
36 class ITelephonyNetworkSettingListener;
39 * @class NetworkManager
40 * @brief This class provides information about the current active network.
44 * The %NetworkManager class is used to register listeners who monitor network status changes,
45 * as well as get information about current active network.
47 * The following example demonstrates how to use the %NetworkManager class to get the network information.
52 * MyClass::GetNetworkManagerInfo(void)
54 * NetworkStatus networkStatus;
55 * NetworkInfo networkInfo;
57 * NetworkManager* pNetworkManager = new NetworkManager();
59 * result r = pNetworkManager->Construct(this);
62 * delete pNetworkManager;
66 * r = pNetworkManager->GetNetworkStatus(networkStatus);
69 * delete pNetworkManager;
73 * r = pNetworkManager->GetNetworkInfo(networkInfo);
76 * delete pNetworkManager;
80 * delete pNetworkManager;
85 * MyClass::OnTelephonyNetworkStatusChanged(const NetworkStatus& networkStatus)
87 * bool isCallAvail = networkStatus.IsCallServiceAvailable();
88 * bool isDataAvail = networkStatus.IsDataServiceAvailable();
89 * bool isRoaming = networkStatus.IsRoaming();
94 class _OSP_EXPORT_ NetworkManager
95 : public Tizen::Base::Object
99 * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
103 NetworkManager(void);
106 * This destructor overrides Tizen::Base::Object::~Object().
110 virtual ~NetworkManager(void);
113 * Initializes a new instance of this class. @n
114 * This is the two phase construction.
115 * If a @c null pointer is passed during the construction, then there
116 * is no listener for telephony network status change callbacks.
120 * @return An error code
121 * @param[in] pListener The listener for change in status of a telephony network
122 * @exception E_SUCCESS The method is successful.
123 * @exception E_SYSTEM A system error has occurred.
125 result Construct(ITelephonyNetworkEventListener* pListener);
128 * Gets the network status.
132 * @privilege http://tizen.org/privilege/telephony
134 * @return An error code
135 * @param[out] networkStatus The network status
136 * @exception E_SUCCESS The method is successful.
137 * @exception E_NETWORK_UNAVAILABLE The operation has failed because the device is in the offline mode.
138 * @exception E_SERVICE_UNAVAILABLE The operation has failed because the device is out of the coverage area or in the emergency mode.
139 * @exception E_SYSTEM A system error has occurred.
140 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
142 result GetNetworkStatus(NetworkStatus& networkStatus) const;
145 * Gets the network information.
149 * @privilege http://tizen.org/privilege/telephony
151 * @return An error code
152 * @param[out] networkInfo The network information
153 * @exception E_SUCCESS The method is successful.
154 * @exception E_NETWORK_UNAVAILABLE The operation has failed because the device is in the offline mode.
155 * @exception E_SERVICE_UNAVAILABLE The operation has failed because the device is out of the coverage area or in the emergency mode.
156 * @exception E_SYSTEM A system error has occurred.
157 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
159 result GetNetworkInfo(NetworkInfo& networkInfo) const;
162 * Sets the listener for receiving the responses of the search network and the network selection mode.
166 * @privlevel platform
167 * @privilege http://tizen.org/privilege/telephonymanager
169 * @return An error code
170 * @param[in] pListener An instance of ITelephonyNetworkSettingListener @n
171 * The parameter can be set to @c null to remove the listener.
172 * @exception E_SUCCESS The method is successful.
173 * @exception E_SYSTEM A system error has occurred.
174 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
176 result SetNetworkSettingListener(ITelephonyNetworkSettingListener* pListener);
179 * Gets the network selection mode.
183 * @privlevel platform
184 * @privilege http://tizen.org/privilege/telephonymanager
186 * @return An error code
187 * @exception E_SUCCESS The method is successful.
188 * @exception E_OPERATION_FAILED This request operation has failed due to an internal error.
189 * @exception E_SYSTEM A system error has occurred.
190 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
191 * @see ITelephonyNetworkSettingListener::OnTelephonyNetworkSelectionModeReceived()
193 result GetNetworkSelectionMode(void);
196 * Selects the manually searched network.
200 * @privlevel platform
201 * @privilege http://tizen.org/privilege/telephonymanager
203 * @return An error code
204 * @param[out] networkInfo The network information
205 * @exception E_SUCCESS The method is successful.
206 * @exception E_OPERATION_FAILED This request operation has failed due to an internal error.
207 * @exception E_SYSTEM A system error has occurred.
208 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
209 * @see ITelephonyNetworkSettingListener::OnTelephonyNetworkSelectionCompleted()
211 result SelectNetwork(const NetworkInfo& networkInfo);
214 * Selects the network automatically.
219 * @privilege http://tizen.org/privilege/telephonymanager
221 * @return An error code
222 * @exception E_SUCCESS The method is successful.
223 * @exception E_OPERATION_FAILED This request operation has failed due to an internal error.
224 * @exception E_SYSTEM A system error has occurred.
225 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
226 * @see ITelephonyNetworkSettingListener::OnTelephonyNetworkSelectionCompleted()
228 result SelectNetwork(void);
231 * Searches for an available network.
235 * @privlevel platform
236 * @privilege http://tizen.org/privilege/telephonymanager
238 * @return An error code
239 * @exception E_SUCCESS The method is successful.
240 * @exception E_OPERATION_FAILED This request operation has failed due to an internal error.
241 * @exception E_SYSTEM A system error has occurred.
242 * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
243 * @see ITelephonyNetworkSettingListener::OnTelephonyNetworkSearchCompletedN()
245 result SearchNetwork(void);
250 * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
252 * @param[in] rhs An instance of %NetworkManager
254 NetworkManager(const NetworkManager& rhs);
257 * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
259 * @param[in] rhs An instance of %NetworkManager
261 NetworkManager& operator =(const NetworkManager& rhs);
264 _NetworkManagerImpl * __pNetworkManagerImpl;
266 friend class _NetworkManagerImpl;
269 }} // Tizen::Telephony
270 #endif // _FTEL_NETWORK_MANAGER_H_