*
* @since 2.0
*
- * The %WifiManager class provides methods for creating a %WifiManager instance, and managing the local Wi-Fi devices. It also allows the
- * listener to get the events from the local Wi-Fi devices.
+ * The %WifiManager class provides methods for creating a %WifiManager instance, and managing the local Wi-Fi devices.
+ * It also allows the listener to get the events from the local Wi-Fi devices.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
+ * For more information on the class features, see
+ * <a href="../org.tizen.native.appprogramming/html/guide/net/wi-fi_connectivity.htm">Wi-Fi Connectivity</a>.
*
* The following example demonstrates how to use the %WifiManager class.
*
: public Tizen::Base::Object
{
public:
- /**
- * This is the default constructor for this class.
- *
- * @since 2.0
- *
- * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize the instance.
- * @see Construct()
- */
- WifiManager(void);
+ /**
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ *
+ * @remarks After creating an instance of this class, the Construct() method must be called explicitly to
+ * initialize the instance.
+ * @see Construct()
+ */
+ WifiManager(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
- virtual ~WifiManager(void);
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
+ virtual ~WifiManager(void);
- /**
- * Initializes this instance of %WifiManager with the specified listener.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] listener A reference to the listener instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION This operation is not supported.
- * @remarks The @c listener instance must not be deleted before destructing this instance.
- */
- result Construct(IWifiManagerEventListener& listener);
+ /**
+ * Initializes this instance of %WifiManager with the specified listener.
+ *
+ * @since 2.0
+ *
+ * @feature %http://tizen.org/feature/network.wifi
+ *
+ * @return An error code
+ * @param[in] listener A reference to the listener instance
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_UNSUPPORTED_OPERATION The device does not support the Wi-Fi feature.For more information, see
+ * <a href=”../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm”>
+ * Application Filtering</a>.
+ * @remarks
+ * - The @c listener instance must not be deleted before destructing this instance.
+ * - Before calling this method, check whether the feature is supported by
+ * %Tizen::System::SystemInfo::GetValue() methods.
+ */
+ result Construct(IWifiManagerEventListener& listener);
- /**
- * Activates the local Wi-Fi device.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.admin
- *
- * @return An error code
- * @exception E_SUCCESS The activation is successful.
- * @exception E_FAILURE The method has failed to activate.
- * @exception E_IN_PROGRESS The activate process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * For example, the Wi-Fi is already activated.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiManagerEventListener::OnWifiActivated()
- */
- result Activate(void) const;
+ /**
+ * Activates the local Wi-Fi device.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The activation is successful.
+ * @exception E_FAILURE The method has failed to activate.
+ * @exception E_IN_PROGRESS The activate process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
+ * For example, the Wi-Fi is already activated.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiManagerEventListener::OnWifiActivated()
+ */
+ result Activate(void) const;
- /**
- * Deactivates the local Wi-Fi device.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.admin
- *
- * @return An error code
- * @exception E_SUCCESS The deactivation is successful.
- * @exception E_FAILURE The method has failed to deactivate.
- * @exception E_IN_PROGRESS The deactivate process is in progress.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * For example, the Wi-Fi is already deactivated.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see IWifiManagerEventListener::OnWifiDeactivated()
- */
- result Deactivate(void) const;
+ /**
+ * Deactivates the local Wi-Fi device.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.admin
+ *
+ * @return An error code
+ * @exception E_SUCCESS The deactivation is successful.
+ * @exception E_FAILURE The method has failed to deactivate.
+ * @exception E_IN_PROGRESS The deactivate process is in progress.
+ * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
+ * For example, the Wi-Fi is already deactivated.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @see IWifiManagerEventListener::OnWifiDeactivated()
+ */
+ result Deactivate(void) const;
- /**
- * Gets the current power status of the local Wi-Fi device.
- *
- * @since 2.0
- *
- * @return The current power status of the local Wi-Fi device
- */
- WifiPowerStatus GetPowerStatus(void) const;
+ /**
+ * Gets the current power status of the local Wi-Fi device.
+ *
+ * @since 2.0
+ *
+ * @return The current power status of the local Wi-Fi device
+ */
+ WifiPowerStatus GetPowerStatus(void) const;
- /**
- * Gets the MAC address of the Wi-Fi device.
- *
- * @since 2.0
- *
- * @return The MAC address in the form '00-00-00-00-00-00'
- * @remarks This MAC address is different from the MAC address provided by the WifiDirectDevice class.
- */
- Tizen::Base::String GetMacAddress(void) const;
+ /**
+ * Gets the MAC address of the Wi-Fi device.
+ *
+ * @since 2.0
+ *
+ * @return The MAC address in the form '00-00-00-00-00-00'
+ * @remarks This MAC address is different from the MAC address provided by the WifiDirectDevice class.
+ */
+ Tizen::Base::String GetMacAddress(void) const;
- /**
- * Checks whether the local device is activated.
- *
- * @since 2.0
- *
- * @return @c true if the local device is activated, @n
- * else @c false
- */
- bool IsActivated(void) const;
+ /**
+ * Checks whether the local device is activated.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the local device is activated, @n
+ * else @c false
+ */
+ bool IsActivated(void) const;
- /**
- * Checks whether the local device is connected with a remote Access Point(AP).
- *
- * @since 2.0
- *
- * @return @c true if the local device is connected with a remote Access Point(AP), @n
- * else @c false
- */
- bool IsConnected(void) const;
+ /**
+ * Checks whether the local device is connected with a remote Access Point(AP).
+ *
+ * @since 2.0
+ *
+ * @return @c true if the local device is connected with a remote Access Point(AP), @n
+ * else @c false
+ */
+ bool IsConnected(void) const;
- /**
- * Scans for a nearby BSS with both the infrastructure and independent modes.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.read
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_FAILURE The method has failed.
- * @exception E_INVALID_STATE This instance is in an invalid state.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks Only active scan (probing for Access Points(APs) and ad hoc stations in the range) is supported.
- * This operation does not work while the Wi-Fi Direct scanning or connection is in progress.
- * @see IWifiManagerEventListener::OnWifiScanCompletedN()
- */
- result Scan(void);
+ /**
+ * Scans for a nearby BSS with both the infrastructure and independent modes.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.read
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FAILURE The method has failed.
+ * @exception E_INVALID_STATE This instance is in an invalid state.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks
+ * - Only active scan (probing for Access Points(APs) and ad hoc stations in the range) is supported.
+ * - This operation does not work while the Wi-Fi Direct scanning or connection is in progress.
+ * @see IWifiManagerEventListener::OnWifiScanCompletedN()
+ */
+ result Scan(void);
- /**
- * Connects to a specific access point that is a BSS with an infrastructure mode.
- *
- * @since 2.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/wifi.admin
- *
- * @return An error code
- * @param[in] targetApInfo A BSS information representing the target access point
- * @exception E_SUCCESS The method is successful.
- * @exception E_FAILURE The method has failed.
- * @exception E_IN_PROGRESS The previous request is in progress.
- * @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * For example, the BSS type is an independent mode.
- * @exception E_INVALID_STATE This instance is in an invalid state.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks If a connection to another access point is already established, it will be disconnected and the new connection
- * of this method will be established.
- * @see IWifiManagerEventListener::OnWifiConnected()
- */
- result Connect(const WifiBssInfo& targetApInfo);
+ /**
+ * Connects to a specific access point that is a BSS with an infrastructure mode.
+ *
+ * @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/wifi.admin
+ *
+ * @return An error code
+ * @param[in] targetApInfo A BSS information representing the target access point
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_FAILURE The method has failed.
+ * @exception E_IN_PROGRESS The previous request is in progress.
+ * @exception E_INVALID_ARG The specified input parameter is invalid. @n
+ * For example, the BSS type is an independent mode.
+ * @exception E_INVALID_STATE This instance is in an invalid state.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks If a connection to another access point is already established, it will be disconnected and the new
+ * connection of this method will be established.
+ * @see IWifiManagerEventListener::OnWifiConnected()
+ */
+ result Connect(const WifiBssInfo& targetApInfo);
- /**
- * Sets the behavior mode of the Wi-Fi background system about connection and background scanning.
- *
- * @since 2.0
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/wifimanager
- *
- * @return An error code
- * @param[in] mode A Wi-Fi background system mode
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_OPERATION_FAILED The operation has failed.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- */
- result SetWifiSystemScanMode(WifiSystemScanMode mode);
+ /**
+ * Sets the behavior mode of the Wi-Fi background system about connection and background scanning.
+ *
+ * @since 2.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/wifimanager
+ *
+ * @return An error code
+ * @param[in] mode A Wi-Fi background system mode
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_OPERATION_FAILED The operation has failed.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ */
+ result SetWifiSystemScanMode(WifiSystemScanMode mode);
- /**
- * Adds the specified @c listener for receiving the notification when the state of current Wi-Fi connection is changed
- * or the result of Wi-Fi background scanning is updated.
- *
- * @since 2.0
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/wifimanager
- *
- * @return An error code
- * @param[in] listener The listener to add
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The listener is already added.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- */
- result AddSystemMonitoringEventListener(IWifiSystemMonitoringEventListener& listener);
+ /**
+ * Adds the specified @c listener for receiving the notification when the state of current Wi-Fi connection is changed
+ * or the result of Wi-Fi background scanning is updated.
+ *
+ * @since 2.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/wifimanager
+ *
+ * @return An error code
+ * @param[in] listener The listener to add
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_ALREADY_EXIST The listener is already added.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ */
+ result AddSystemMonitoringEventListener(IWifiSystemMonitoringEventListener& listener);
- /**
- * Removes the specified IWifiSystemMonitoringEventListener instance for receiving the notification. @n The removed listener
- * cannot listen to the events that are fired.
- *
- * @since 2.0
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/wifimanager
- *
- * @return An error code
- * @param[in] listener The listener to remove
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The listener is not found.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- */
- result RemoveSystemMonitoringEventListener(IWifiSystemMonitoringEventListener& listener);
+ /**
+ * Removes the specified IWifiSystemMonitoringEventListener instance for receiving the notification. @n The removed listener
+ * cannot listen to the events that are fired.
+ *
+ * @since 2.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/wifimanager
+ *
+ * @return An error code
+ * @param[in] listener The listener to remove
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The listener is not found.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ */
+ result RemoveSystemMonitoringEventListener(IWifiSystemMonitoringEventListener& listener);
- /**
- * Gets the state of current Wi-Fi connection.
- *
- * @since 2.0
- *
- * @return The state of the current Wi-Fi connection
- */
- WifiConnectionState GetConnectionState(void) const;
+ /**
+ * Gets the state of current Wi-Fi connection.
+ *
+ * @since 2.0
+ *
+ * @return The state of the current Wi-Fi connection
+ */
+ WifiConnectionState GetConnectionState(void) const;
- /**
- * Gets the information of current Wi-Fi connection target which the local device is connecting or connected with.
- *
- * @since 2.0
- *
- * @return A pointer to the WifiBssInfo instance representing the information of current Wi-Fi connection target, @n
- * else @c null if GetConnectionState() is ::WIFI_CONN_STATE_NOT_CONNECTED
- */
- WifiBssInfo* GetConnectionTargetInfoN(void) const;
+ /**
+ * Gets the information of current Wi-Fi connection target which the local device is connecting or connected with.
+ *
+ * @since 2.0
+ *
+ * @return A pointer to the WifiBssInfo instance representing the information of current Wi-Fi connection target, @n
+ * else @c null if GetConnectionState() is ::WIFI_CONN_STATE_NOT_CONNECTED
+ */
+ WifiBssInfo* GetConnectionTargetInfoN(void) const;
- /**
- * Updates the Wi-Fi BSS information which is saved in the underlying Wi-Fi system.
- *
- * @since 2.0
- * @privlevel platform
- * @privilege %http://tizen.org/privilege/wifimanager
- *
- * @return An error code
- * @param[in] bssInfo A BSS information representing the access point
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_OBJ_NOT_FOUND The specified input parameter is not found.
- * @exception E_OPERATION_FAILED The operation has failed.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
- *
- * @remarks The updated information is deleted when Wi-Fi is turned off if the BSS has never been connected before.
- */
- result UpdateBssInfo(const WifiBssInfo& bssInfo);
+ /**
+ * Updates the Wi-Fi BSS information which is saved in the underlying Wi-Fi system.
+ *
+ * @since 2.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/wifimanager
+ *
+ * @return An error code
+ * @param[in] bssInfo A BSS information representing the access point
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_OBJ_NOT_FOUND The specified input parameter is not found.
+ * @exception E_OPERATION_FAILED The operation has failed.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ *
+ * @remarks The updated information is deleted when Wi-Fi is turned off if the BSS has never been connected before.
+ */
+ result UpdateBssInfo(const WifiBssInfo& bssInfo);
- /**
- * Gets a list of the latest search results which the underlying Wi-Fi system scan periodically on background.
- *
- * @since 2.0
- *
- * @return A Tizen::Base::Collection::IList containing WifiBssInfo of existing Wi-Fi connections if successful, @n
- * else @c null
- */
- Tizen::Base::Collection::IList* GetSystemScanResultN(void) const;
+ /**
+ * Gets a list of the latest search results which the underlying Wi-Fi system scan periodically on background.
+ *
+ * @since 2.0
+ *
+ * @return A Tizen::Base::Collection::IList containing WifiBssInfo of existing Wi-Fi connections if successful, @n
+ * else @c null
+ */
+ Tizen::Base::Collection::IList* GetSystemScanResultN(void) const;
private:
- /**
- * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] value An instance of %WifiManager
- */
- WifiManager(const WifiManager& value);
+ //
+ // The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
+ //
+ WifiManager(const WifiManager& value);
- /**
- * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
- *
- * @param[in] rhs An instance of %WifiManager
- */
- WifiManager& operator=(const WifiManager& rhs);
+ //
+ // The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
+ //
+ WifiManager& operator=(const WifiManager& rhs);
private:
- _WifiManagerImpl* __pWifiManagerImpl;
+ _WifiManagerImpl* __pWifiManagerImpl;
- friend class _WifiManagerImpl;
+ friend class _WifiManagerImpl;
}; // WifiManager
} } } // Tizen::Net::Wifi
projects / platform / framework / native / net.git / blobdiff