doc/wifi_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_NETWORK_WIFI_DOC_H__
  19 #define __TIZEN_NETWORK_WIFI_DOC_H__
  20
  21
  22 /**
  23  * @ingroup CAPI_NETWORK_WIFI_PACKAGE
  24  * @defgroup CAPI_NETWORK_WIFI_MODULE Wi-Fi (Deprecated)
  25  * @brief The Wi-Fi API provides functions for managing Wi-Fi and monitoring the state of Wi-Fi.
  26  * @section CAPI_NETWORK_WIFI_MODULE_HEADER Required Header
  27  * \#include <wifi.h>
  28  *
  29  * @section CAPI_NETWORK_WIFI_MODULE_OVERVIEW Overview
  30  * Wi-Fi allows your application to connect to a Wireless Local Area Network (WLAN) and to transfer data over the network.
  31  * The Wi-Fi Manager enables your application to activate and deactivate a local Wi-Fi device, and to connect to a WLAN network
  32  * in the infrastructure mode.
  33  *
  34  * @section CAPI_NETWORK_WIFI_MODULE_FEATURE Related Features
  35  * This API is related with the following features:\n
  36  * - http://tizen.org/feature/network.wifi\n
  37  * It is recommended to design applications with regard to features, for reliability.\n
  38  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  39  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  40  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  41  */
  42
  43
  44 /**
  45  * @ingroup CAPI_NETWORK_WIFI_MODULE
  46  * @defgroup CAPI_NETWORK_WIFI_MANAGEMENT_MODULE Wi-Fi Management
  47  * @brief The Wi-Fi API provides functions for managing Wi-Fi.
  48  * @section CAPI_NETWORK_WIFI_MANAGEMENT_MODULE_HEADER Required Header
  49  * \#include <wifi.h>
  50  *
  51  * @section CAPI_NETWORK_WIFI_MANAGEMENT_MODULE_OVERVEW Overview
  52  * The Wi-Fi Manager provides functions for managing Wi-Fi.
  53  * Using the Wi-Fi Manager, you can implement features that allow the users of your application to:
  54  * - Activate / Deactivate the Wi-Fi device.
  55  * - Connect to the access point.
  56  * - Scans the access points.
  57  *
  58  * @section CAPI_NETWORK_WIFI_MANAGEMENT_MODULE_FEATURE Related Features
  59  * This API is related with the following features:\n
  60  * - http://tizen.org/feature/network.wifi\n
  61  * It is recommended to design applications with regard to features, for reliability.\n
  62  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  63  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  64  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  65  */
  66
  67
  68 /**
  69  * @ingroup CAPI_NETWORK_WIFI_MODULE
  70  * @defgroup CAPI_NETWORK_WIFI_MONITOR_MODULE Wi-Fi Monitor
  71  * @brief The Wi-Fi API provides functions for monitoring the state of Wi-Fi.
  72  * @section CAPI_NETWORK_WIFI_MONITOR_MODULE_HEADER Required Header
  73  * \#include <wifi.h>
  74  *
  75  * @section CAPI_NETWORK_WIFI_MONITOR_MODULE_OVERVIEW Overview
  76  * The Wi-Fi Monitor allows monitoring the changes of Wi-Fi.
  77  *
  78  * @section CAPI_NETWORK_WIFI_MONITOR_MODULE_FEATURE Related Features
  79  * This API is related with the following features:\n
  80  * - http://tizen.org/feature/network.wifi\n
  81  * It is recommended to design applications with regard to features, for reliability.\n
  82  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  83  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  84  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  85  */
  86
  87
  88 /**
  89  * @ingroup CAPI_NETWORK_WIFI_MANAGEMENT_MODULE
  90  * @defgroup CAPI_NETWORK_WIFI_AP_MODULE AP
  91  * @brief The Access Point API provides functions for managing the Access Point.
  92  * @section CAPI_NETWORK_WIFI_AP_MODULE Required Header
  93  * \#include <wifi.h>
  94  *
  95  * @section CAPI_NETWORK_WIFI_AP_MODULE_OVERVIEW Overview
  96  * The Access Point API provides functions for managing the Access Point. You need to create the @a ap handle for using the functions.
  97  * You can use Wi-Fi information with the handle.
  98  *
  99  * @section CAPI_NETWORK_WIFI_AP_MODULE_FEATURE Related Features
 100  * This API is related with the following features:\n
 101  * - http://tizen.org/feature/network.wifi\n
 102  * It is recommended to design applications with regard to features, for reliability.\n
 103  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
 104  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 105  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
 106  */
 107
 108
 109 /**
 110  * @ingroup CAPI_NETWORK_WIFI_AP_MODULE
 111  * @defgroup CAPI_NETWORK_WIFI_AP_NETWORK_MODULE Network Information
 112  * @brief The Connection Information API provides functions for managing the network information.
 113  * @section CAPI_NETWORK_WIFI_AP_CONNECTION_MODULE Required Header
 114  * \#include <wifi.h>
 115  *
 116  * @section CAPI_NETWORK_WIFI_AP_CONNECTION_MODULE_OVERVIEW Overview
 117  * The Connection Information API provides functions for managing the network information. You can manage the network information using the functions.
 118  *
 119  * @section CAPI_NETWORK_WIFI_AP_MODULE_FEATURE Related Features
 120  * This API is related with the following features:\n
 121  * - http://tizen.org/feature/network.wifi\n
 122  * It is recommended to design applications with regard to features, for reliability.\n
 123  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
 124  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 125  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
 126  */
 127
 128
 129 /**
 130  * @ingroup CAPI_NETWORK_WIFI_AP_MODULE
 131  * @defgroup CAPI_NETWORK_WIFI_AP_SECURITY_MODULE Security Information
 132  * @brief The Security Information API provides functions for managing the Security information.
 133  * @section CAPI_NETWORK_WIFI_AP_SECURITY_MODULE Required Header
 134  * \#include <wifi.h>
 135  *
 136  * @section CAPI_NETWORK_WIFI_AP_SECURITY_MODULE_OVERVIEW Overview
 137  * The Security Information API provides functions for managing the Security information. You can manage the Security information using the functions.
 138  *
 139  * @section CAPI_NETWORK_WIFI_AP_SECURITY_MODULE_FEATURE Related Features
 140  * This API is related with the following features:\n
 141  * - http://tizen.org/feature/network.wifi\n
 142  * It is recommended to design applications with regard to features, for reliability.\n
 143  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
 144  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 145  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
 146  */
 147
 148
 149 /**
 150  * @ingroup CAPI_NETWORK_WIFI_AP_SECURITY_MODULE
 151  * @defgroup CAPI_NETWORK_WIFI_AP_SECURITY_EAP_MODULE EAP
 152  * @brief The EAP API provides functions for managing the EAP information.
 153  * @section CAPI_NETWORK_WIFI_AP_SECURITY_EAP_MODULE Required Header
 154  * \#include <wifi.h>
 155  *
 156  * @section CAPI_NETWORK_WIFI_AP_SECURITY_EAP_MODULE_OVERVIEW Overview
 157  * The EAP API provides functions for managing the EAP information. You can manage the EAP information using the functions.
 158  *
 159  * @section CAPI_NETWORK_WIFI_AP_SECURITY_EAP_MODULE_FEATURE Related Features
 160  * This API is related with the following features:\n
 161  * - http://tizen.org/feature/network.wifi\n
 162  * It is recommended to design applications with regard to features, for reliability.\n
 163  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
 164  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 165  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
 166  */
 167
 168
 169 /**
 170  * @ingroup CAPI_NETWORK_WIFI_MODULE
 171  * @defgroup CAPI_NETWORK_WIFI_CONFIG_MODULE Wi-Fi Configuration
 172  * @brief The Configuration API provides functions for managing the configuration of Wi-Fi.
 173  * @section CAPI_NETWORK_WIFI_CONFIG_MODULE Required Header
 174  * \#include <wifi.h>
 175  *
 176  * @section CAPI_NETWORK_WIFI_CONFIG_MODULE_OVERVIEW Overview
 177  * The Configuration API provides functions for managing the configuration of Wi-Fi. You can manage the configuration information using the functions.
 178  *
 179  * @section CAPI_NETWORK_WIFI_CONFIG_MODULE Related Features
 180  * This API is related with the following features:\n
 181  * - http://tizen.org/feature/network.wifi\n
 182  * It is recommended to design applications with regard to features, for reliability.\n
 183  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
 184  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 185  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
 186  */
 187
 188
 189 /**
 190  * @ingroup CAPI_NETWORK_WIFI_MODULE
 191  * @defgroup CAPI_NETWORK_WIFI_TDLS_MODULE Wi-Fi TDLS
 192  * @brief The TDLS APIs for managing TDLS.
 193  * @section CAPI_NETWORK_WIFI_TDLS_MODULE Required Header
 194  * \#include <wifi.h>
 195  *
 196  * @section CAPI_NETWORK_WIFI_TDLS_MODULE_OVERVIEW Overview
 197  * The TDLS APIs for managing TDLS.
 198  * @section CAPI_NETWORK_WIFI_TDLS_MODULE Related Features
 199  * This API is related with the following features:\n
 200  * - http://tizen.org/feature/network.wifi.tdls\n
 201  * It is recommended to design applications with regard to features, for reliability.\n
 202  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.
 203  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 204  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
 205  */
 206
 207
 208 #endif /* __TIZEN_NETWORK_WIFI_DOC_H__ */