diff options
author | saerome.kim <saerome.kim@samsung.com> | 2018-02-26 21:21:33 +0900 |
---|---|---|
committer | saerome kim <saerome.kim@samsung.com> | 2018-02-28 22:50:27 +0900 |
commit | 7c0822431c49d0a9ff022efd1c26836f6de755a7 (patch) | |
tree | 6380332b0e03454d706a329aba32ce2ab6369110 | |
parent | d29d0fe43a5e79d508f197e0c2d9782a4f06ec81 (diff) | |
download | wifi-mesh-7c0822431c49d0a9ff022efd1c26836f6de755a7.tar.gz wifi-mesh-7c0822431c49d0a9ff022efd1c26836f6de755a7.tar.bz2 wifi-mesh-7c0822431c49d0a9ff022efd1c26836f6de755a7.zip |
Apply API documentation rules.
To be registered public Tizen APIs, whole API definitions must meet
Tizen API documentation rules, so this chage fix these rule violation.
Change-Id: I36025760ccac571f0aef9a32c5150d36e952592a
Signed-off-by: saerome.kim <saerome.kim@samsung.com>
-rw-r--r-- | include/wifi-mesh-internal.h | 474 | ||||
-rw-r--r-- | include/wifi-mesh.h | 315 |
2 files changed, 413 insertions, 376 deletions
diff --git a/include/wifi-mesh-internal.h b/include/wifi-mesh-internal.h index 33aae7f..84900f7 100644 --- a/include/wifi-mesh-internal.h +++ b/include/wifi-mesh-internal.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_WIFI_MESH_INTERNAL_H__ -#define __TIZEN_WIFI_MESH_INTERNAL_H__ +#ifndef __TIZEN_NETWORK_WIFI_MESH_INTERNAL_H__ +#define __TIZEN_NETWORK_WIFI_MESH_INTERNAL_H__ #include <glib.h> #include <tizen.h> @@ -29,9 +29,9 @@ extern "C" { */ /** - * @brief The HWMP type for mesh_hwmp_root_mode_e + * @brief The HWMP (Hybrid Wireless Mesh Protocol) type for mesh_hwmp_root_mode_e. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef enum { MESH_HWMP_ROOT_REACTIVE_MODE = 0, /**< Disable Proative Mode */ @@ -45,19 +45,19 @@ typedef enum { /** * @brief The mesh station information handle. - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef void* wifi_mesh_station_info_h; /** * @brief The mesh path information handle. - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef void* wifi_mesh_mpath_info_h; /** * @brief The mesh conf information handle. - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef void* wifi_mesh_meshconf_info_h; @@ -65,7 +65,7 @@ typedef void* wifi_mesh_meshconf_info_h; * @brief Gets the maximum data rate. * @details This function is to get the maximum data rate * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[out] data_rate The maximum data rate. @@ -83,7 +83,7 @@ int wifi_mesh_network_get_data_rate(wifi_mesh_network_h network, int *data_rate) * @brief Sets the maximum data rate. * @details This function is to set the maximum data rate * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] data_rate The maximum data rate. @@ -98,10 +98,10 @@ int wifi_mesh_network_get_data_rate(wifi_mesh_network_h network, int *data_rate) int wifi_mesh_network_set_data_rate(wifi_mesh_network_h network, int data_rate); /** - * @brief Cancel scanning for the mesh network. - * @details Stop scanning process of mesh network. + * @brief Cancels scanning for the mesh network. + * @details Stops scanning process of mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @@ -119,10 +119,10 @@ int wifi_mesh_network_set_data_rate(wifi_mesh_network_h network, int data_rate); int wifi_mesh_cancel_scan(wifi_mesh_h handle); /** - * @brief Sets gate options + * @brief Sets gate options. * @details This function sets mesh gate options. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] gate_announce Enable / Disable Gate Announce to peers @@ -145,10 +145,10 @@ int wifi_mesh_cancel_scan(wifi_mesh_h handle); int wifi_mesh_set_gate(wifi_mesh_h handle, int gate_announce, int hwmp_root_mode, bool stp); /** - * @brief Unsets gate options + * @brief Unsets gate options. * @details This function unsets mesh gate options. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @@ -164,10 +164,13 @@ int wifi_mesh_set_gate(wifi_mesh_h handle, int gate_announce, int hwmp_root_mode int wifi_mesh_unset_gate(wifi_mesh_h handle); /** - * @brief Called after wifi_mesh_get_stations_info() + * @brief This callback function is called after wifi_mesh_get_stations_info(). * @details This function can receive joined station information from mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @station should not be released. + * @remarks The @station can be used only in the callback. To use outside, make a copy. * * @param[out] station mesh station information handle * @param[out] user_data user data pointer @@ -179,10 +182,10 @@ int wifi_mesh_unset_gate(wifi_mesh_h handle); typedef void (*wifi_mesh_found_station_cb)(wifi_mesh_station_info_h station, void* user_data); /** - * @brief Get information of all connected stations. - * @details Get information about all stations present in the currently connected mesh network. + * @brief Gets information of all connected stations. + * @details Gets information about all stations present in the currently connected mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] sta_type Type of Station @@ -203,13 +206,15 @@ int wifi_mesh_get_stations_info(wifi_mesh_h handle, void *user_data); /** - * @brief Get BSSID of connected stations. - * @details Get BSSID information of a peer + * @brief Gets BSSID of connected stations. + * @details Gets BSSID information of a peer + * + * @since_tizen 5.0 * - * @since_tizen 4.0 + * @remarks The @bssid should be released using free(). * * @param[in] station The Wi-Fi mesh station handle - * @param[in] bssid A pointer to get BSSID information + * @param[out] bssid A pointer to get BSSID information * * * @return 0 on success, otherwise a negative error value. @@ -256,13 +261,13 @@ int wifi_mesh_get_stations_info(wifi_mesh_h handle, int wifi_mesh_get_sta_bssid(wifi_mesh_station_info_h station, gchar** bssid); /** - * @brief Get inactive time of a connected station. - * @details Get inactive time information of a peer + * @brief Gets inactive time of a connected station. + * @details Gets inactive time information of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] inactive_time A time of inactive period + * @param[out] inactive_time A time of inactive period * * * @return 0 on success, otherwise a negative error value. @@ -309,13 +314,13 @@ int wifi_mesh_get_sta_bssid(wifi_mesh_station_info_h station, gchar** bssid); int wifi_mesh_get_sta_inactive_time(wifi_mesh_station_info_h station, guint* inactive_time); /** - * @brief Get rx bytes of a connected station. - * @details Get rx bytes information of a peer + * @brief Gets rx bytes of a connected station. + * @details Gets rx bytes information of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] rx_bytes a number of received bytes + * @param[out] rx_bytes a number of received bytes * * * @return 0 on success, otherwise a negative error value. @@ -362,13 +367,13 @@ int wifi_mesh_get_sta_inactive_time(wifi_mesh_station_info_h station, guint* ina int wifi_mesh_get_sta_rx_bytes(wifi_mesh_station_info_h station, guint64* rx_bytes); /** - * @brief Get rx packets of a connected station. - * @details Get rx packets information of a peer + * @brief Gets rx packets of a connected station. + * @details Gets rx packets information of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] rx_packets a number of received packets + * @param[out] rx_packets a number of received packets * * * @return 0 on success, otherwise a negative error value. @@ -415,13 +420,13 @@ int wifi_mesh_get_sta_rx_bytes(wifi_mesh_station_info_h station, guint64* rx_byt int wifi_mesh_get_sta_rx_packets(wifi_mesh_station_info_h station, guint* rx_packets); /** - * @brief Get tx packets counts of a connected station. - * @details Get tx packets information of a peer + * @brief Gets tx packets counts of a connected station. + * @details Gets tx packets information of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] tx_packets a number of sent packets + * @param[out] tx_bytes a number of sent packets * * * @return 0 on success, otherwise a negative error value. @@ -468,13 +473,13 @@ int wifi_mesh_get_sta_rx_packets(wifi_mesh_station_info_h station, guint* rx_pac int wifi_mesh_get_sta_tx_bytes(wifi_mesh_station_info_h station, guint64* tx_bytes); /** - * @brief Get tx packets of a connected station. - * @details Get rx packets information of a peer + * @brief Gets tx packets of a connected station. + * @details Gets rx packets information of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] tx_packets a number of sent packets + * @param[out] tx_packets a number of sent packets * * * @return 0 on success, otherwise a negative error value. @@ -521,13 +526,13 @@ int wifi_mesh_get_sta_tx_bytes(wifi_mesh_station_info_h station, guint64* tx_byt int wifi_mesh_get_sta_tx_packets(wifi_mesh_station_info_h station, guint* tx_packets); /** - * @brief Get a re-trial number of transmits at a connected station. - * @details Get a re-trial number of transmits information at a peer + * @brief Gets a re-trial number of transmits at a connected station. + * @details Gets a re-trial number of transmits information at a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] tx_retries a re-try number of transmits + * @param[out] tx_retries a re-try number of transmits * * * @return 0 on success, otherwise a negative error value. @@ -574,13 +579,13 @@ int wifi_mesh_get_sta_tx_packets(wifi_mesh_station_info_h station, guint* tx_pac int wifi_mesh_get_sta_tx_retries(wifi_mesh_station_info_h station, guint* tx_retries); /** - * @brief Get tx-fail counts of a connected station. - * @details Get a number of transmit failure information of a peer + * @brief Gets tx-fail counts of a connected station. + * @details Gets a number of transmit failure information of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] tx_failed a number of transmits-failures + * @param[out] tx_failed a number of transmits-failures * * * @return 0 on success, otherwise a negative error value. @@ -627,13 +632,13 @@ int wifi_mesh_get_sta_tx_retries(wifi_mesh_station_info_h station, guint* tx_ret int wifi_mesh_get_sta_tx_failed(wifi_mesh_station_info_h station, guint* tx_failed); /** - * @brief Get a number of beacon loss at a connected station. - * @details Get a number of beacon loss counts of a peer + * @brief Gets a number of beacon loss at a connected station. + * @details Gets a number of beacon loss counts of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] beacon_loss a number of transmits-failures + * @param[out] beacon_loss a number of transmits-failures * * * @return 0 on success, otherwise a negative error value. @@ -680,13 +685,13 @@ int wifi_mesh_get_sta_tx_failed(wifi_mesh_station_info_h station, guint* tx_fail int wifi_mesh_get_sta_beacon_loss(wifi_mesh_station_info_h station, guint* beacon_loss); /** - * @brief Get a number of received beacons at a connected station. - * @details Get a number of received beacon counts of a peer + * @brief Gets a number of received beacons at a connected station. + * @details Gets a number of received beacon counts of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] beacon_rx a number of transmits-failures + * @param[out] beacon_rx a number of transmits-failures * * * @return 0 on success, otherwise a negative error value. @@ -733,13 +738,13 @@ int wifi_mesh_get_sta_beacon_loss(wifi_mesh_station_info_h station, guint* beaco int wifi_mesh_get_sta_beacon_rx(wifi_mesh_station_info_h station, guint64* beacon_rx); /** - * @brief Get a number of dropped packets number with ambiguous reason at a connected station. - * @details Get a number of dropped packets number with ambiguous reason of a peer + * @brief Gets a number of dropped packets number with ambiguous reason at a connected station. + * @details Gets a number of dropped packets number with ambiguous reason of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] rx_drop_misc a number of dropped packets even if a peer received + * @param[out] rx_drop_misc a number of dropped packets even if a peer received * * * @return 0 on success, otherwise a negative error value. @@ -786,13 +791,13 @@ int wifi_mesh_get_sta_beacon_rx(wifi_mesh_station_info_h station, guint64* beaco int wifi_mesh_get_sta_rx_drop_misc(wifi_mesh_station_info_h station, guint64* rx_drop_misc); /** - * @brief Get instant received signal strength at a connected station. - * @details Get instant received signal strength of a peer + * @brief Gets instant received signal strength at a connected station. + * @details Gets instant received signal strength of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] signal Instant received signal strength + * @param[out] signal Instant received signal strength * * * @return 0 on success, otherwise a negative error value. @@ -839,13 +844,13 @@ int wifi_mesh_get_sta_rx_drop_misc(wifi_mesh_station_info_h station, guint64* rx int wifi_mesh_get_sta_signal(wifi_mesh_station_info_h station, gint* signal); /** - * @brief Get average received signal strength at a connected station. - * @details Get average received signal strength of a peer + * @brief Gets average received signal strength at a connected station. + * @details Gets average received signal strength of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] signal_avg average received signal strength + * @param[out] signal_avg average received signal strength * * * @return 0 on success, otherwise a negative error value. @@ -892,13 +897,13 @@ int wifi_mesh_get_sta_signal(wifi_mesh_station_info_h station, gint* signal); int wifi_mesh_get_sta_signal_avg(wifi_mesh_station_info_h station, gint* signal_avg); /** - * @brief Get transmit bit-rate at a connected station. - * @details Get transmit bit-rate of a peer + * @brief Gets transmit bit-rate at a connected station. + * @details Gets transmit bit-rate of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] tx_bitrate Tx bit rate + * @param[out] tx_bitrate Tx bit rate * * * @return 0 on success, otherwise a negative error value. @@ -945,13 +950,13 @@ int wifi_mesh_get_sta_signal_avg(wifi_mesh_station_info_h station, gint* signal_ int wifi_mesh_get_sta_tx_bitrate(wifi_mesh_station_info_h station, guint* tx_bitrate); /** - * @brief Get received bit-rate at a connected station. - * @details Get received bit-rate of a peer + * @brief Gets received bit-rate at a connected station. + * @details Gets received bit-rate of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] rx_bitrate Tx bit rate + * @param[out] rx_bitrate Tx bit rate * * * @return 0 on success, otherwise a negative error value. @@ -998,13 +1003,13 @@ int wifi_mesh_get_sta_tx_bitrate(wifi_mesh_station_info_h station, guint* tx_bit int wifi_mesh_get_sta_rx_bitrate(wifi_mesh_station_info_h station, guint* rx_bitrate); /** - * @brief Get local-link identifier at a connected station. + * @brief Gets local-link identifier at a connected station. * @details Get local-link identifier of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] mesh_llid Local-link identifier + * @param[out] mesh_llid Local-link identifier * * * @return 0 on success, otherwise a negative error value. @@ -1051,13 +1056,13 @@ int wifi_mesh_get_sta_rx_bitrate(wifi_mesh_station_info_h station, guint* rx_bit int wifi_mesh_get_sta_mesh_llid(wifi_mesh_station_info_h station, gushort* mesh_llid); /** - * @brief Get peer-link identifier at a connected station. + * @brief Gets peer-link identifier at a connected station. * @details Get peer-link identifier of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] mesh_plid Peer-link identifier + * @param[out] mesh_plid Peer-link identifier * * * @return 0 on success, otherwise a negative error value. @@ -1104,13 +1109,16 @@ int wifi_mesh_get_sta_mesh_llid(wifi_mesh_station_info_h station, gushort* mesh_ int wifi_mesh_get_sta_mesh_plid(wifi_mesh_station_info_h station, gushort* mesh_plid); /** - * @brief Get peer-link status at a connected station. + * @brief Gets peer-link status at a connected station. * @details Get peer-link status of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @mesh_plink should not be released. + * @remarks The @mesh_plink is available until wifi_mesh_station_info_h is released. * * @param[in] station The Wi-Fi mesh station handle - * @param[in] mesh_plink Peer-link status such as "ESTAB" + * @param[out] mesh_plink Peer-link status such as "ESTAB" * * * @return 0 on success, otherwise a negative error value. @@ -1157,14 +1165,13 @@ int wifi_mesh_get_sta_mesh_plid(wifi_mesh_station_info_h station, gushort* mesh_ int wifi_mesh_get_sta_mesh_plink(wifi_mesh_station_info_h station, guchar* mesh_plink); /** - * @brief Get local-link power save mode at a connected station. + * @brief Gets local-link power save mode at a connected station. * @details Get local-link power save mode of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] local_ps_mode Local-link power save - * + * @param[out] local_ps_mode Local-link power save * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -1210,14 +1217,13 @@ int wifi_mesh_get_sta_mesh_plink(wifi_mesh_station_info_h station, guchar* mesh_ int wifi_mesh_get_sta_local_ps_mode(wifi_mesh_station_info_h station, guint* local_ps_mode); /** - * @brief Get peer-link power save mode at a connected station. + * @brief Gets peer-link power save mode at a connected station. * @details Get peer-link power save mode of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] peer_ps_mode Peer-link power save - * + * @param[out] peer_ps_mode Peer-link power save * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -1263,14 +1269,13 @@ int wifi_mesh_get_sta_local_ps_mode(wifi_mesh_station_info_h station, guint* loc int wifi_mesh_get_sta_peer_ps_mode(wifi_mesh_station_info_h station, guint* peer_ps_mode); /** - * @brief Get non-peer-link power save mode at a connected station. + * @brief Gets non-peer-link power save mode at a connected station. * @details Get non-peer-link power save mode of a peer * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] non_peer_ps_mode Non-peer-link power save - * + * @param[out] non_peer_ps_mode Non-peer-link power save * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -1316,14 +1321,13 @@ int wifi_mesh_get_sta_peer_ps_mode(wifi_mesh_station_info_h station, guint* peer int wifi_mesh_get_sta_non_peer_ps_mode(wifi_mesh_station_info_h station, guint* non_peer_ps_mode); /** - * @brief Get to know whether a connected station authorized or not. + * @brief Gets to know whether a connected station authorized or not. * @details Get to know whether a peer authorized or not. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] authorized Authorized or not - * + * @param[out] authorized Authorized or not * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -1369,14 +1373,13 @@ int wifi_mesh_get_sta_non_peer_ps_mode(wifi_mesh_station_info_h station, guint* int wifi_mesh_get_sta_authorized(wifi_mesh_station_info_h station, gboolean* authorized); /** - * @brief Get to know whether a connected station athenticated or not. + * @brief Gets to know whether a connected station athenticated or not. * @details Get to know whether a peer athenticated or not. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] authenticated Athenticated or not - * + * @param[out] authenticated Athenticated or not * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -1422,13 +1425,13 @@ int wifi_mesh_get_sta_authorized(wifi_mesh_station_info_h station, gboolean* aut int wifi_mesh_get_sta_authenticated(wifi_mesh_station_info_h station, gboolean* authenticated); /** - * @brief Get to know whether a connected station associated or not. + * @brief Gets to know whether a connected station associated or not. * @details Get to know whether a peer associated or not. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] associated Associated or not + * @param[out] associated Associated or not * * * @return 0 on success, otherwise a negative error value. @@ -1475,13 +1478,13 @@ int wifi_mesh_get_sta_authenticated(wifi_mesh_station_info_h station, gboolean* int wifi_mesh_get_sta_associated(wifi_mesh_station_info_h station, gboolean* associated); /** - * @brief Get preamble type long or short. + * @brief Gets preamble type long or short. * @details Get preamble type of a peer. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] preamble Long or short + * @param[out] preamble Long or short * * * @return 0 on success, otherwise a negative error value. @@ -1528,13 +1531,13 @@ int wifi_mesh_get_sta_associated(wifi_mesh_station_info_h station, gboolean* ass int wifi_mesh_get_sta_preamble(wifi_mesh_station_info_h station, gboolean* preamble); /** - * @brief Get to know a station can support Wireless Multimedia Extension. + * @brief Gets to know a station can support Wireless Multimedia Extension. * @details Get to know a station can support Wireless Multimedia Extension (in other word, Wi-Fi Multimedia). * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] wmm_wme WMM supported or not + * @param[out] wmm_wme WMM supported or not * * * @return 0 on success, otherwise a negative error value. @@ -1581,13 +1584,13 @@ int wifi_mesh_get_sta_preamble(wifi_mesh_station_info_h station, gboolean* pream int wifi_mesh_get_sta_wmm_wme(wifi_mesh_station_info_h station, gboolean* wmm_wme); /** - * @brief Get to know a station can support management frame protection. + * @brief Gets to know a station can support management frame protection. * @details Get to know a peer can support management frame protection such as WPA1 or WPA2. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] mfp MFP(Management Frame Protection) supported or not + * @param[out] mfp MFP (Management Frame Protection) supported or not * * * @return 0 on success, otherwise a negative error value. @@ -1634,13 +1637,13 @@ int wifi_mesh_get_sta_wmm_wme(wifi_mesh_station_info_h station, gboolean* wmm_wm int wifi_mesh_get_sta_mfp(wifi_mesh_station_info_h station, gboolean* mfp); /** - * @brief Get to know a station can support tunneled direct link setup. - * @details Get to know a peer can support management TDLS(Tunneled Direct Link Setup). + * @brief Gets to know a station can support tunneled direct link setup. + * @details Get to know a peer can support management TDLS (Tunneled Direct Link Setup). * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] tdls_peer TDLS supported or not + * @param[out] tdls_peer TDLS supported or not * * * @return 0 on success, otherwise a negative error value. @@ -1687,14 +1690,14 @@ int wifi_mesh_get_sta_mfp(wifi_mesh_station_info_h station, gboolean* mfp); int wifi_mesh_get_sta_tdls_peer(wifi_mesh_station_info_h station, gboolean* tdls_peer); /** - * @brief Get DTIM period of a connected station. - * @details Get DTIM(Delivery Traffic Indication Message) period of a peer. + * @brief Gets DTIM period of a connected station. + * @details Get DTIM (Delivery Traffic Indication Message) period of a peer. * For example 1024 means that this station sends beacon at every beacon interval. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] dtim_period DTIM period + * @param[out] dtim_period DTIM period * * * @return 0 on success, otherwise a negative error value. @@ -1741,14 +1744,13 @@ int wifi_mesh_get_sta_tdls_peer(wifi_mesh_station_info_h station, gboolean* tdls int wifi_mesh_get_sta_dtim_period(wifi_mesh_station_info_h station, guchar* dtim_period); /** - * @brief Get DTIM interval of a connected station. - * @details Get DTIM(Delivery Traffic Indication Message) intervl of a peer. - * For example 100 means that this station sends beacon at 100 * 1 TU(1024) us. + * @brief Gets beacon interval of a connected station. + * @details Get beacon intervl of a peer. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] dtim_period DTIM period + * @param[out] beacon_interval DTIM period * * * @return 0 on success, otherwise a negative error value. @@ -1795,13 +1797,13 @@ int wifi_mesh_get_sta_dtim_period(wifi_mesh_station_info_h station, guchar* dtim int wifi_mesh_get_sta_beacon_interval(wifi_mesh_station_info_h station, gushort* beacon_interval); /** - * @brief Get to know a station can support RTS(Request-to-Send) / CTS(Clear-to-Send). + * @brief Gets to know a station can support RTS (Request-to-Send) / CTS (Clear-to-Send). * @details Get to know a peer can support CTS protection mode. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] cts_protection CTS/RTS supported or not + * @param[out] cts_protection CTS/RTS supported or not * * * @return 0 on success, otherwise a negative error value. @@ -1848,13 +1850,13 @@ int wifi_mesh_get_sta_beacon_interval(wifi_mesh_station_info_h station, gushort* int wifi_mesh_get_sta_cts_protection(wifi_mesh_station_info_h station, gboolean* cts_protection); /** - * @brief Get to know a station can support short preamble. + * @brief Gets to know a station can support short preamble. * @details Get to know a peer can support short preamble. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] short_preamble Short preamble supported or not + * @param[out] short_preamble Short preamble supported or not * * * @return 0 on success, otherwise a negative error value. @@ -1901,13 +1903,13 @@ int wifi_mesh_get_sta_cts_protection(wifi_mesh_station_info_h station, gboolean* int wifi_mesh_get_sta_short_preamble(wifi_mesh_station_info_h station, gboolean* short_preamble); /** - * @brief Get to know a station can support short slot. + * @brief Gets to know a station can support short slot. * @details Get to know a peer can support short slot. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] short_slot_time Short slot supported or not + * @param[out] short_slot_time Short slot supported or not * * * @return 0 on success, otherwise a negative error value. @@ -1954,13 +1956,13 @@ int wifi_mesh_get_sta_short_preamble(wifi_mesh_station_info_h station, gboolean* int wifi_mesh_get_sta_short_slot_time(wifi_mesh_station_info_h station, gboolean* short_slot_time); /** - * @brief Get to know how many time elapsed since a station joined. + * @brief Gets to know how many time elapsed since a station joined. * @details GGet to know how many time elapsed since a peer joined. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] station The Wi-Fi mesh station handle - * @param[in] connected_time Connection time elapsed + * @param[out] connected_time Connection time elapsed * * * @return 0 on success, otherwise a negative error value. @@ -2007,10 +2009,13 @@ int wifi_mesh_get_sta_short_slot_time(wifi_mesh_station_info_h station, gboolean int wifi_mesh_get_sta_connected_time(wifi_mesh_station_info_h station, guint* connected_time); /** - * @brief Called after wifi_mesh_get_stations_info() + * @brief Called after wifi_mesh_get_stations_info(). * @details This function can receive joined station information from mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @path should not be released. + * @remarks The @path can be used only in the callback. To use outside, make a copy. * * @param[out] path mesh path information handle * @param[out] user_data user data pointer @@ -2022,10 +2027,10 @@ int wifi_mesh_get_sta_connected_time(wifi_mesh_station_info_h station, guint* co typedef void (*mesh_found_mpath_cb)(wifi_mesh_mpath_info_h path, void* user_data); /** - * @brief Get information of all mesh paths. + * @brief Gets information of all mesh paths. * @details Get information about all mesh paths present in the currently connected mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] cb The callback function to receive mesh path information @@ -2043,14 +2048,17 @@ typedef void (*mesh_found_mpath_cb)(wifi_mesh_mpath_info_h path, void* user_data int wifi_mesh_get_mpath_info(wifi_mesh_h handle, mesh_found_mpath_cb cb, void *user_data); /** - * @brief Get a destination address. + * @brief Gets a destination address. * @details The first column represents the MAC address of destination node that can be * 1 or more than 1 hop away in the network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] dest_addr Destination MAC address + * @remarks The @dest_addr should not be released. + * @remarks The @dest_addr is available until wifi_mesh_mpath_info_h is released. + * + * @param[in] mpath The adjacent mesh path information + * @param[out] dest_addr Destination MAC address * * * @return 0 on success, otherwise a negative error value. @@ -2073,15 +2081,18 @@ int wifi_mesh_get_mpath_info(wifi_mesh_h handle, mesh_found_mpath_cb cb, void *u int wifi_mesh_get_mpath_dest_addr(wifi_mesh_mpath_info_h mpath, gchar** dest_addr); /** - * @brief Get a next hop address. + * @brief Gets a next hop address. * @details Second column indicates the MAC address of next hop for the destination * node/address. The first and second columns can be same if destination node is just one * hop away or it is peer/neighbor node. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] next_hop Destination MAC address + * @remarks The @next_hop should not be released. + * @remarks The @next_hop is available until wifi_mesh_mpath_info_h is released. + * + * @param[in] mpath The adjacent mesh path information + * @param[out] next_hop Destination MAC address * * * @return 0 on success, otherwise a negative error value. @@ -2104,15 +2115,18 @@ int wifi_mesh_get_mpath_dest_addr(wifi_mesh_mpath_info_h mpath, gchar** dest_add int wifi_mesh_get_mpath_next_hop(wifi_mesh_mpath_info_h mpath, gchar** next_hop); /** - * @brief Get a control interface. + * @brief Gets a control interface. * @details The third column tells about the interface who contains this information or * where packet is forwarded. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @iface should not be released. + * @remarks The @iface is available until wifi_mesh_mpath_info_h is released. * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] iface Network interface name * + * @param[in] mpath The adjacent mesh path information + * @param[out] iface Network interface name * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -2134,14 +2148,14 @@ int wifi_mesh_get_mpath_next_hop(wifi_mesh_mpath_info_h mpath, gchar** next_hop) int wifi_mesh_get_mpath_iface(wifi_mesh_mpath_info_h mpath, gchar** iface); /** - * @brief Get a serial number of the current control packet. + * @brief Gets a serial number of the current control packet. * @details The fourth column is about the PREQ sequence number. It is used to detect and * break the loop while path is being investigated. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] sn Sequence number + * @param[in] mpath The adjacent mesh path information + * @param[out] sn Sequence number * * * @return 0 on success, otherwise a negative error value. @@ -2164,15 +2178,15 @@ int wifi_mesh_get_mpath_iface(wifi_mesh_mpath_info_h mpath, gchar** iface); int wifi_mesh_get_mpath_sn(wifi_mesh_mpath_info_h mpath, guint* sn); /** - * @brief Get a metric number. + * @brief Gets a metric number. * @details The fifth column contains value for ALM and telling how the path healthy is. * This information depends on the number of hops from asked interface to destination * interface/address. Therefore each value is different from other destination. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] metric Metric + * @param[in] mpath The adjacent mesh path information + * @param[out] metric Metric * * * @return 0 on success, otherwise a negative error value. @@ -2195,13 +2209,13 @@ int wifi_mesh_get_mpath_sn(wifi_mesh_mpath_info_h mpath, guint* sn); int wifi_mesh_get_mpath_metric(wifi_mesh_mpath_info_h mpath, guint* metric); /** - * @brief Get a queue length in the Wi-Fi driver. + * @brief Gets a queue length in the Wi-Fi driver. * @details This column gives MAC layer queue status at path discovery time. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] qlen Queue length + * @param[in] mpath The adjacent mesh path information + * @param[out] qlen Queue length * * * @return 0 on success, otherwise a negative error value. @@ -2224,14 +2238,14 @@ int wifi_mesh_get_mpath_metric(wifi_mesh_mpath_info_h mpath, guint* metric); int wifi_mesh_get_mpath_qlen(wifi_mesh_mpath_info_h mpath, guint* qlen); /** - * @brief Get a time of next destination available. + * @brief Gets a time of next destination available. * @details The eighth column holds path expiry duration in (TUs) for the given interface * to destination interface. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] exptime Expiration time + * @param[in] mpath The adjacent mesh path information + * @param[out] exptime Expiration time * * * @return 0 on success, otherwise a negative error value. @@ -2254,16 +2268,16 @@ int wifi_mesh_get_mpath_qlen(wifi_mesh_mpath_info_h mpath, guint* qlen); int wifi_mesh_get_mpath_exptime(wifi_mesh_mpath_info_h mpath, guint* exptime); /** - * @brief Get a time of discovery timeout. + * @brief Gets a time of discovery timeout. * @details This field tells about the buffered broadcast/multicast data on mesh STA. * During the mesh DTIM period, the mesh STA transmits broadcast traffic for its neighbors. * The mesh STA with power saving capability must switch from doze to awaken state for * every DTIM of their peer mesh STAs. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] discovery_timeout Discovery timeout value + * @param[in] mpath The adjacent mesh path information + * @param[out] discovery_timeout Discovery timeout value * * * @return 0 on success, otherwise a negative error value. @@ -2287,14 +2301,14 @@ int wifi_mesh_get_mpath_disc_timeout(wifi_mesh_mpath_info_h mpath, guint* discovery_timeout); /** - * @brief Get a number of discovery re-trial. + * @brief Gets a number of discovery re-trial. * @details The column number tenth shows that how many retries have occurred while path * from source interface to destination address was being discovered. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] discovery_retries Discovery retial number + * @param[in] mpath The adjacent mesh path information + * @param[out] discovery_retries Discovery retial number * * * @return 0 on success, otherwise a negative error value. @@ -2318,14 +2332,14 @@ int wifi_mesh_get_mpath_disc_retries(wifi_mesh_mpath_info_h mpath, guchar* discovery_retries); /** - * @brief Get flags + * @brief Gets flags. * @details The last column contains bit masking type values for different stat flags for * paths. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[in] station The Wi-Fi mesh station handle - * @param[in] flags Different status flags + * @param[in] mpath The adjacent mesh path information + * @param[out] flags Different status flags * * * @return 0 on success, otherwise a negative error value. @@ -2351,7 +2365,7 @@ int wifi_mesh_get_mpath_flags(wifi_mesh_mpath_info_h mpath, guchar* flags); * @brief Sets network device interface name. * @details This function provides the ability to manually select interfaces for advanced users. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] mesh An interface name for mesh network @@ -2369,11 +2383,13 @@ int wifi_mesh_set_interfaces(wifi_mesh_h handle, const char *mesh, const char* gate, const char *softap); /** - * @brief Get information of mesh configurations. + * @brief Gets information of mesh configurations. * @details Get information about mesh configurations present in the currently * connected mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @meshconf should be released using wifi_mesh_destroy_meshconf_info(). * * @param[in] handle The Wi-Fi mesh handle * @param[out] meshconf The Mesh conf information handle @@ -2393,7 +2409,7 @@ int wifi_mesh_get_meshconf_info(wifi_mesh_h handle, /** * @brief Destroys the Mesh Configuration Info handle. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Mesh conf information handle * @@ -2410,10 +2426,10 @@ int wifi_mesh_get_meshconf_info(wifi_mesh_h handle, */ int wifi_mesh_destroy_meshconf_info(wifi_mesh_meshconf_info_h meshconf); -/* +/** * @brief Gets the retry timeout value of Mesh Configuration. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] retry_timeout Retry timeout value @@ -2430,10 +2446,10 @@ int wifi_mesh_destroy_meshconf_info(wifi_mesh_meshconf_info_h meshconf); int wifi_mesh_get_meshconf_retry_timeout(wifi_mesh_meshconf_info_h meshconf, gushort *retry_timeout); -/* - * @brief Gets the HWMP Max PREQ Retries. +/** + * @brief Gets the HWMP (Hybrid Wireless Mesh Protocol) Max PREQ Retries. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] hwmp_max_preq_retries HWMP Max PREQ Retries @@ -2452,10 +2468,10 @@ int wifi_mesh_get_meshconf_hwmp_max_preq_retries( wifi_mesh_meshconf_info_h meshconf, guchar *hwmp_max_preq_retries); -/* - * @brief Gets the Confirm Timeout +/** + * @brief Gets the Confirm Timeout. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] confirm_timeout Confirm Timeout @@ -2472,10 +2488,10 @@ int wifi_mesh_get_meshconf_hwmp_max_preq_retries( int wifi_mesh_get_meshconf_confirm_timeout(wifi_mesh_meshconf_info_h meshconf, gushort *confirm_timeout); -/* +/** * @brief Gets the Path Refresh Time. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] path_refresh_time Path Refresh Time @@ -2492,10 +2508,10 @@ int wifi_mesh_get_meshconf_confirm_timeout(wifi_mesh_meshconf_info_h meshconf, int wifi_mesh_get_meshconf_path_refresh_time(wifi_mesh_meshconf_info_h meshconf, guint *path_refresh_time); -/* +/** * @brief Gets the Holding Timeout. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] holding_timeout Holding Timeout @@ -2512,10 +2528,10 @@ int wifi_mesh_get_meshconf_path_refresh_time(wifi_mesh_meshconf_info_h meshconf, int wifi_mesh_get_meshconf_holding_timeout(wifi_mesh_meshconf_info_h meshconf, gushort *holding_timeout); -/* +/** * @brief Gets the Minimum Discovery Timeout. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] min_disc_timeout Minimum Discovery Timeout @@ -2532,10 +2548,10 @@ int wifi_mesh_get_meshconf_holding_timeout(wifi_mesh_meshconf_info_h meshconf, int wifi_mesh_get_meshconf_min_disc_timeout(wifi_mesh_meshconf_info_h meshconf, gushort *min_disc_timeout); -/* +/** * @brief Gets the Max Peer Links. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] max_peer_links Max Peer Links @@ -2552,10 +2568,10 @@ int wifi_mesh_get_meshconf_min_disc_timeout(wifi_mesh_meshconf_info_h meshconf, int wifi_mesh_get_meshconf_max_peer_links(wifi_mesh_meshconf_info_h meshconf, gushort *max_peer_links); -/* - * @brief Gets the HWMP PREQ Minimum Interval. +/** + * @brief Gets the HWMP (Hybrid Wireless Mesh Protocol) PREQ Minimum Interval. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] hwmp_preq_min_interval HWMP PREQ Minimum Interval @@ -2573,10 +2589,10 @@ int wifi_mesh_get_meshconf_hwmp_preq_min_interval( wifi_mesh_meshconf_info_h meshconf, gushort *hwmp_preq_min_interval); -/* - * @brief Gets the TTL. +/** + * @brief Gets the TTL (Time To Live). * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] ttl TTL @@ -2593,10 +2609,10 @@ int wifi_mesh_get_meshconf_hwmp_preq_min_interval( int wifi_mesh_get_meshconf_ttl( wifi_mesh_meshconf_info_h meshconf, guchar *ttl); -/* - * @brief Gets the HWMP Active Path Timeout. +/** + * @brief Gets the HWMP (Hybrid Wireless Mesh Protocol) Active Path Timeout. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] hwmp_active_path_timeout HWMP Active Path Timeout @@ -2614,10 +2630,10 @@ int wifi_mesh_get_meshconf_hwmp_active_path_timeout( wifi_mesh_meshconf_info_h meshconf, guint *hwmp_active_path_timeout); -/* - * @brief Gets the Element TTL. +/** + * @brief Gets the Element TTL (Time To Live). * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] element_ttl Element TTL @@ -2634,10 +2650,10 @@ int wifi_mesh_get_meshconf_hwmp_active_path_timeout( int wifi_mesh_get_meshconf_element_ttl(wifi_mesh_meshconf_info_h meshconf, guchar *element_ttl); -/* - * @brief Gets the HWMP RANN Interval. +/** + * @brief Gets the HWMP RANN (Root Announcement) Interval. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] hwmp_rann_interval HWMP RANN Interval @@ -2655,10 +2671,10 @@ int wifi_mesh_get_meshconf_hwmp_rann_interval( wifi_mesh_meshconf_info_h meshconf, gushort *hwmp_rann_interval); -/* +/** * @brief Gets the Gate Announcement value. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] meshconf The Wi-Fi mesh conf handle * @param[out] gate_announcements Gate Announcement @@ -2680,4 +2696,4 @@ int wifi_mesh_get_meshconf_gate_announcements( } #endif -#endif /* __TIZEN_WIFI_MESH_INTERNAL_H__ */ +#endif /* __TIZEN_NETWORK_WIFI_MESH_INTERNAL_H__ */ diff --git a/include/wifi-mesh.h b/include/wifi-mesh.h index c717744..1391d3c 100644 --- a/include/wifi-mesh.h +++ b/include/wifi-mesh.h @@ -14,8 +14,8 @@ * limitations under the License. */ -#ifndef __TIZEN_WIFI_MESH_H__ -#define __TIZEN_WIFI_MESH_H__ +#ifndef __TIZEN_NETWORK_WIFI_MESH_H__ +#define __TIZEN_NETWORK_WIFI_MESH_H__ #include <tizen.h> @@ -28,26 +28,27 @@ extern "C" { */ /** -* @addtogroup CAPI_NETWORK_WIFI_MESH_MODULE -* @{ -*/ + * @addtogroup CAPI_NETWORK_WIFI_MESH_MODULE + * @{ + */ /** * @brief The Wi-Fi mesh handle. - * @since_tizen 4.0 -*/ + * @since_tizen 5.0 + */ typedef void *wifi_mesh_h; -/*********************************************************************** - TEMP -***********************************************************************/ +/** + * @brief The Wi-Fi mesh error base. + * @since_tizen 5.0 + */ #ifndef TIZEN_ERROR_MESH #define TIZEN_ERROR_MESH -0x02F60000 #endif /** * @brief Enumeration for the Wi-Fi mesh error type. - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef enum { WIFI_MESH_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ @@ -71,40 +72,41 @@ typedef enum { /** * @addtogroup CAPI_NETWORK_WIFI_MESH_MONITOR_MODULE +* @since_tizen 5.0 * @{ */ /** - * @brief The maximum length of mesh id + * @brief The maximum length of mesh id. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ #define MAX_MESHID_LEN 32 /** - * @brief The maximum length of BSSID + * @brief The maximum length of BSSID. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ #define MAX_BSSID_LEN 18 /** - * @brief The maximum length of passphrase + * @brief The maximum length of passphrase. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ #define MAX_PASSPHRASE_LEN (64+1) /** - * @brief The maximum length of IPv4 Address + * @brief The maximum length of IPv4 Address. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ #define MAX_IPV4_ADDRESS_LEN 16 /** * @brief Enumeration for the security type of the Wi-Fi Mesh network. - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef enum { MESH_SECURITY_NONE = 0, /**< Open network */ @@ -113,7 +115,7 @@ typedef enum { /** * @brief Enumeration for the connection state of the Wi-Fi Mesh network. - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef enum { WIFI_MESH_CONNECTION_STATE_DISCONNECTED = 0, /**< Wi-Fi Mesh network is disconnected */ @@ -124,7 +126,7 @@ typedef enum { /** * @brief Enumeration for address family of the Wi-Fi Mesh network. - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef enum { WIFI_MESH_ADDRESS_FAMILY_IPV4 = 0, /**< IPV4 Address type */ @@ -133,7 +135,7 @@ typedef enum { /** * @brief Enumeration for the IP Config Type of the Wi-Fi Mesh network. - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef enum { WIFI_MESH_IP_CONFIG_TYPE_UNKNOWN = 0, /**< Unknown IP Config Type */ @@ -151,9 +153,9 @@ typedef enum { } wifi_mesh_station_type_e; /** - * @brief The events for wifi_mesh_event_cb + * @brief The events for wifi_mesh_event_cb. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef enum { WIFI_MESH_EVENT_ENABLED = 0x00, /**< This event is received after enabling mesh network */ @@ -167,7 +169,7 @@ typedef enum { * @brief The structure type for the WIFI_MESH_EVENT_ENABLED callback data. * @details The result of creating or joining mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef struct { int result; /**< The result of creating or joining mesh network */ @@ -177,7 +179,7 @@ typedef struct { * @brief The structure type for the WIFI_MESH_EVENT_STATION_JOIN or WIFI_MESH_EVENT_STATION_LEFT callback data. * @details Result of join or left event of other station. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef struct { char bssid[MAX_BSSID_LEN]; /**< The BSSID of the station that generated the event */ @@ -188,7 +190,7 @@ typedef struct { * @brief The structure type for the WIFI_MESH_EVENT_CONNECTION_STATE callback data. * @details The state of mesh network connection. * - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef struct { char mesh_id[MAX_MESHID_LEN]; /**< The Mesh ID of the network that generated the event */ @@ -203,7 +205,7 @@ typedef struct { * @details This function can receive events from the devices in the network. * ex) enable, station information, connection state and etc * - * @since_tizen 4.0 + * @since_tizen 5.0 */ typedef struct { union { @@ -214,31 +216,31 @@ typedef struct { } wifi_mesh_event_data_s; /** -* @} -*/ + * @} + */ /** -* @addtogroup CAPI_NETWORK_WIFI_MESH_MODULE -* @{ -*/ + * @addtogroup CAPI_NETWORK_WIFI_MESH_MODULE + * @{ + */ /** * @brief The Wi-Fi mesh network profile handle. - * @since_tizen 4.0 -*/ + * @since_tizen 5.0 + */ typedef void* wifi_mesh_network_h; /** * @brief The Wi-Fi mesh network peer handle. - * @since_tizen 4.0 -*/ + * @since_tizen 5.0 + */ typedef void* wifi_mesh_peer_h; /** * @brief Creates a network handle. * @details This function is to allocate new mesh network information * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[out] network The mesh network information handle, we will allocate mesh * network information structure internally. @@ -259,7 +261,7 @@ int wifi_mesh_network_new(wifi_mesh_network_h* network); * @brief Clones a network handle. * @details This function is to clone mesh network information * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[out] dst The target Wi-Fi mesh network information handle, we will allocate mesh * network information structure internally. @@ -281,7 +283,7 @@ int wifi_mesh_network_clone(wifi_mesh_network_h* dst, wifi_mesh_network_h src); * @brief Creates network handle with parameters. * @details This function is to allocate new mesh network information * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[out] network The mesh network information handle, we will allocate mesh * network information structure internally. @@ -310,7 +312,7 @@ int wifi_mesh_network_new_with(wifi_mesh_network_h* network, const char *meshid, * @brief Destroys network handle. * @details This function is to destroy mesh network information * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The target Wi-Fi mesh network information handle. * @@ -330,9 +332,10 @@ int wifi_mesh_network_destroy(wifi_mesh_network_h network); /** * @brief Gets a Wi-Fi mesh network id. * @details This function is to return mesh network id - * @remark The returned string should be freed when no longer needed. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @meshid should be released using free(). * * @param[in] network The Wi-Fi mesh network information handle. * @param[out] meshid The mesh network id. @@ -350,7 +353,7 @@ int wifi_mesh_network_get_meshid(wifi_mesh_network_h network, char **meshid); * @brief Sets a Wi-Fi mesh network id. * @details This function is to set Wi-Fi mesh network id * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] meshid The mesh network id. @@ -367,12 +370,13 @@ int wifi_mesh_network_set_meshid(wifi_mesh_network_h network, const char *meshid /** * @brief Gets BSSID. * @details This function is to get basic service set id - * @remark The returned string should be freed when no longer needed. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @bssid should be released using free(). * * @param[in] network The Wi-Fi mesh network information handle. - * @param[in] bssid The basic service set id. + * @param[out] bssid The basic service set id. * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -387,7 +391,7 @@ int wifi_mesh_network_get_bssid(wifi_mesh_network_h network, char **bssid); * @brief Sets BSSID. * @details This function is to set basic service set id * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] bssid The basic service set id. @@ -405,7 +409,7 @@ int wifi_mesh_network_set_bssid(wifi_mesh_network_h network, const char *bssid); * @brief Gets channel. * @details This function is to get channel * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[out] channel The operating channel number. @@ -423,7 +427,7 @@ int wifi_mesh_network_get_channel(wifi_mesh_network_h network, int *channel); * @brief Sets channel. * @details This function is to get channel * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] channel The operating channel number. @@ -439,12 +443,12 @@ int wifi_mesh_network_set_channel(wifi_mesh_network_h network, int channel); /** * @brief Gets RSSI. - * @details This function is to get rssi + * @details This function is to get RSSI * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. - * @param[out] rssi The received signal strength indicator. + * @param[out] RSSI The received signal strength indicator. * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -453,16 +457,16 @@ int wifi_mesh_network_set_channel(wifi_mesh_network_h network, int channel); * @see wifi_mesh_network_set_rssi() * */ -int wifi_mesh_network_get_rssi(wifi_mesh_network_h network, int *rssi); +int wifi_mesh_network_get_rssi(wifi_mesh_network_h network, int *RSSI); /** * @brief Sets RSSI. - * @details This function is to set rssi + * @details This function is to set RSSI * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. - * @param[in] rssi The received signal strength indicator. + * @param[in] RSSI The received signal strength indicator. * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -471,13 +475,13 @@ int wifi_mesh_network_get_rssi(wifi_mesh_network_h network, int *rssi); * @see wifi_mesh_network_get_rssi() * */ -int wifi_mesh_network_set_rssi(wifi_mesh_network_h network, int rssi); +int wifi_mesh_network_set_rssi(wifi_mesh_network_h network, int RSSI); /** * @brief Gets the security type. * @details This function is to get the security type. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[out] security The security type for network. @@ -495,7 +499,7 @@ int wifi_mesh_network_get_security(wifi_mesh_network_h network, wifi_mesh_securi * @brief Sets the security type. * @details This function is to set the security type. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] security The security type for network. @@ -513,7 +517,7 @@ int wifi_mesh_network_set_security(wifi_mesh_network_h network, wifi_mesh_securi * @brief Sets the passphrase for network connection. * @details This function is to set the passphrase. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] passphrase The passphrase for network connection. @@ -531,7 +535,7 @@ int wifi_mesh_network_set_passphrase(wifi_mesh_network_h network, const char* pa * @brief Gets the connection state. * @details This function is to get the connection state * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[out] state The maximum data rate. @@ -544,10 +548,10 @@ int wifi_mesh_network_set_passphrase(wifi_mesh_network_h network, const char* pa int wifi_mesh_network_get_connection_state(wifi_mesh_network_h network, wifi_mesh_connection_state_e *state); /** - * @brief Gets the IP Config Type + * @brief Gets the IP Config Type. * @details This function is to gets the IP Config Type * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] address_family Address Family @@ -563,10 +567,12 @@ int wifi_mesh_network_get_ip_config_type(wifi_mesh_network_h network, wifi_mesh_ip_config_type_e *ip_type); /** - * @brief Gets the IP Address + * @brief Gets the IP Address. * @details This function is to gets the IP Address * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks You must release @ip_address using free(). * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] address_family Address Family @@ -581,10 +587,12 @@ int wifi_mesh_network_get_ip_address(wifi_mesh_network_h network, wifi_mesh_address_family_e address_family, char **ip_address); /** - * @brief Gets the Subnet Mask + * @brief Gets the Subnet Mask. * @details This function is to gets the subnet mask * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks You must release @subnet_mask using free(). * * @param[in] network The Wi-Fi mesh network information handle. * @param[in] address_family Address Family @@ -601,9 +609,10 @@ int wifi_mesh_network_get_subnet_mask(wifi_mesh_network_h network, /** * @brief Gets address from the Wi-Fi mesh peer. * @details This function is to return mesh network id - * @remark The returned string should be freed when no longer needed. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks You must release @address using free(). * * @param[in] peer The mesh peer information handle. * @param[out] address The address of mesh peer. @@ -617,55 +626,62 @@ int wifi_mesh_peer_get_address(wifi_mesh_peer_h peer, char **address); /** * @brief Initializes a Wi-Fi Mesh network. - * @since_tizen 4.0 - * @privlevel public - * @remarks You must release @a handle using wifi_mesh_deinitialize(). + * @since_tizen 5.0 + * + * @privilege %http://tizen.org/privilege/wifi.admin + * + * @remarks You must release @handle using wifi_mesh_deinitialize(). + * * @param[out] handle The Wi-Fi mesh handle + * * @return @c 0 on success, otherwise negative error value * @retval #WIFI_MESH_ERROR_NONE Successful - * @retval #WIFI_MESH_ERROR_ALREADY_INITIALIZED Already initialized - * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MESH_ERROR_INVALID_OPERATION Invalid operation - * @retval #WIFI_MESH_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_MESH_ERROR_PERMISSION_DENIED Permission Denied - * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Out of memory - * @retval #WIFI_MESH_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_MESH_ERROR_ALREADY_INITIALIZED Already initialized + * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MESH_ERROR_INVALID_OPERATION Invalid operation + * @retval #WIFI_MESH_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_MESH_ERROR_PERMISSION_DENIED Permission Denied + * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Out of memory + * @retval #WIFI_MESH_ERROR_NOT_SUPPORTED Not supported */ int wifi_mesh_initialize(wifi_mesh_h *handle); /** * @brief Deinitializes the Wi-Fi Mesh network. - * @since_tizen 4.0 + * @since_tizen 5.0 + * * @param[in] handle The Wi-Fi mesh handle + * * @return 0 on success, otherwise negative error value - * @retval #WIFI_MESH_ERROR_NONE Successful - * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #WIFI_MESH_ERROR_INVALID_OPERATION Invalid operation - * @retval #WIFI_MESH_ERROR_OPERATION_FAILED Operation failed - * @retval #WIFI_MESH_ERROR_NOT_SUPPORTED Not supported + * @retval #WIFI_MESH_ERROR_NONE Successful + * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #WIFI_MESH_ERROR_INVALID_OPERATION Invalid operation + * @retval #WIFI_MESH_ERROR_OPERATION_FAILED Operation failed + * @retval #WIFI_MESH_ERROR_NOT_SUPPORTED Not supported */ int wifi_mesh_deinitialize(wifi_mesh_h handle); /** - * @brief Specifies the type of function passed to wifi_mesh_enable() + * @brief Specifies the type of function passed to wifi_mesh_enable(). * @details This function can receive events from the Wi-Fi mesh network. * ex) enabled state, scan result * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @remarks You can receive below events. - * @see #WIFI_MESH_EVENT_ENABLED - * @see #WIFI_MESH_EVENT_SCAN_DONE - * @see #WIFI_MESH_EVENT_STATION_JOIN - * @see #WIFI_MESH_EVENT_STATION_LEFT + * @remarks The @event should not be released. + * @remarks The @event can be used only in the callback. * * @param[out] event_type The event identification * @param[out] event parameter data pointer - * @param[in] user_data The user data passed from callback registration function + * @param[out] user_data The user data passed from callback registration function * - * @pre The callback must be registered with wifi_mesh_enable() + * @pre The callback must be registered using wifi_mesh_enable(). * * @see wifi_mesh_set_event_cb() + * @see #WIFI_MESH_EVENT_ENABLED + * @see #WIFI_MESH_EVENT_SCAN_DONE + * @see #WIFI_MESH_EVENT_STATION_JOIN + * @see #WIFI_MESH_EVENT_STATION_LEFT */ typedef void (*wifi_mesh_event_cb)(wifi_mesh_event_e event_type, wifi_mesh_event_data_s* event, void *user_data); @@ -674,7 +690,7 @@ typedef void (*wifi_mesh_event_cb)(wifi_mesh_event_e event_type, * @brief Sets event handler for the Wi-Fi mesh network service. * @details Sets event handler to get events from the Wi-Fi mesh network service. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] event_handler The event handler @@ -694,10 +710,10 @@ int wifi_mesh_set_event_cb(wifi_mesh_h handle, wifi_mesh_event_cb event_handler, void *user_data); /** - * @brief Enable the Wi-Fi mesh service. + * @brief Makes the Wi-Fi mesh service enable. * @details All this function to start Wi-Fi mesh service * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @remarks You must free all resources of the mesh by calling wifi_mesh_deinitialize() * if mesh service is no longer needed. @@ -718,16 +734,15 @@ int wifi_mesh_set_event_cb(wifi_mesh_h handle, int wifi_mesh_enable(wifi_mesh_h handle); /** - * @brief disable the Wi-Fi mesh service. + * @brief Makes the Wi-Fi mesh service disable. * @details all this function to stop Wi-Fi mesh service * - * @since_tizen 4.0 - * - * @param[in] handle The Wi-Fi mesh handle + * @since_tizen 5.0 * * @remarks You must free all resources of the mesh by calling wifi_mesh_deinitialize() * if mesh service is no longer needed. * + * @param[in] handle The Wi-Fi mesh handle * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful @@ -742,14 +757,13 @@ int wifi_mesh_enable(wifi_mesh_h handle); int wifi_mesh_disable(wifi_mesh_h handle); /** - * @brief Scan Wi-Fi mesh networks. + * @brief Scans Wi-Fi mesh networks. * @details Scan all Wi-Fi mesh network to get network state. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * - * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter @@ -762,16 +776,15 @@ int wifi_mesh_disable(wifi_mesh_h handle); int wifi_mesh_scan(wifi_mesh_h handle); /** - * @brief Scan for the specific mesh network. + * @brief Scans for the specific mesh network. * @details Scan specific SSID and channel to get specific Wi-Fi mesh networks. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] ssid Specific SSID to scan * @param[in] channel The channel number to scan * - * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter @@ -784,10 +797,13 @@ int wifi_mesh_scan(wifi_mesh_h handle); int wifi_mesh_specific_scan(wifi_mesh_h handle, const char* ssid, int channel); /** - * @brief Called after wifi_mesh_foreach_found_network() + * @brief Called after wifi_mesh_foreach_found_network(). * @details This function can receive scan results from Wi-Fi mesh networks. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @network should not be released. + * @remarks The @network can be used only in the callback. To use outside, make a copy. * * @param[out] network mesh bss information handle * @param[out] user_data user data pointer @@ -799,16 +815,15 @@ int wifi_mesh_specific_scan(wifi_mesh_h handle, const char* ssid, int channel); typedef void (*wifi_mesh_found_network_cb)(wifi_mesh_network_h network, void* user_data); /** - * @brief Gets found Wi-Fi mesh network bss information + * @brief Gets found Wi-Fi mesh network bss information. * @details This function returns network information found through wifi_mesh_found_network_cb. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] cb callback function pointer to inform bss information * @param[in] user_data user data pointer * - * * @return 0 on success, otherwise a negative error value. * @retval #WIFI_MESH_ERROR_NONE Successful * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter @@ -822,12 +837,15 @@ int wifi_mesh_foreach_found_network(wifi_mesh_h handle, wifi_mesh_found_network_cb cb, void *user_data); /** - * @brief Called after wifi_mesh_foreach_connected_peers() + * @brief Called after wifi_mesh_foreach_connected_peers(). * @details This function can receive connected peers on the Wi-Fi mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * - * @param[out] network The mesh peer information handle + * @remarks The @peer should not be released. + * @remarks The @peer can be used only in the callback. To use outside, make a copy. + * + * @param[out] peer The mesh peer information handle * @param[out] user_data user data pointer * * @pre The callback must be registered with wifi_mesh_foreach_connected_peers() @@ -837,10 +855,10 @@ int wifi_mesh_foreach_found_network(wifi_mesh_h handle, typedef void (*wifi_mesh_connected_peer_cb)(wifi_mesh_peer_h peer, void* user_data); /** - * @brief Gets found Wi-Fi mesh network peer information + * @brief Gets found Wi-Fi mesh network peer information. * @details This function returns network information found through wifi_mesh_connected_peer_cb. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] cb callback function pointer to inform peer information @@ -860,11 +878,11 @@ int wifi_mesh_foreach_connected_peers(wifi_mesh_h handle, wifi_mesh_connected_peer_cb cb, void *user_data); /** - * @brief Start the Wi-Fi mesh network. + * @brief Starts the Wi-Fi mesh network. * @details This function is to create a Wi-Fi mesh network and do auto-connection * using saved Wi-Fi mesh network configuration * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @@ -879,11 +897,11 @@ int wifi_mesh_foreach_connected_peers(wifi_mesh_h handle, int wifi_mesh_start(wifi_mesh_h handle); /** - * @brief Stop the Wi-Fi mesh network. + * @brief Stops the Wi-Fi mesh network. * @details This function is to disconnect the current Wi-Fi mesh network and * destroy all related to the Wi-Fi mesh network * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @@ -898,10 +916,10 @@ int wifi_mesh_start(wifi_mesh_h handle); int wifi_mesh_stop(wifi_mesh_h handle); /** - * @brief Get the Wi-Fi mesh enable state. + * @brief Gets the Wi-Fi mesh enable state. * @details Check if mesh is enabled in current device. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[out] is_started The state of mesh. @@ -919,10 +937,10 @@ int wifi_mesh_stop(wifi_mesh_h handle); int wifi_mesh_is_started(wifi_mesh_h handle, bool *is_started); /** - * @brief Get the Wi-Fi mesh connection state. + * @brief Gets the Wi-Fi mesh connection state. * @details Check if current device is joined Wi-Fi mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[out] is_joined The state of mesh network connection. @@ -943,7 +961,7 @@ int wifi_mesh_is_joined(wifi_mesh_h handle, bool* is_joined); * @brief Gets current joined Wi-Fi mesh network information. * @details Return current joined Wi-Fi mesh network information.. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[out] network Wi-Fi Mesh bss information handle @@ -960,10 +978,10 @@ int wifi_mesh_is_joined(wifi_mesh_h handle, bool* is_joined); int wifi_mesh_get_joined_network(wifi_mesh_h handle, wifi_mesh_network_h* network); /** - * @brief Sets softap options + * @brief Sets softap options. * @details This function sets softap options. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] ssid The SSID @@ -987,10 +1005,13 @@ int wifi_mesh_set_softap(wifi_mesh_h handle, const char* ssid, const char* key, int channel, bool visibility, int max_stations, int security); /** - * @brief Gets softap options + * @brief Gets softap options. * @details This function gets softap options. * - * @since_tizen 4.0 + * @since_tizen 5.0 + * + * @remarks The @ssid should be released using free(). + * @remarks The @key should be released using free(). * * @param[in] handle The Wi-Fi mesh handle * @param[out] ssid The SSID @@ -1016,10 +1037,10 @@ int wifi_mesh_get_softap(wifi_mesh_h handle, char **ssid, int *channel, int *security, char **key); /** - * @brief Enables softap + * @brief Makes softap enable. * @details This function enables softap. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @@ -1036,10 +1057,10 @@ int wifi_mesh_get_softap(wifi_mesh_h handle, char **ssid, int *channel, int wifi_mesh_enable_softap(wifi_mesh_h handle); /** - * @brief Disable softap + * @brief Makes softap disable. * @details This function disables softap. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @@ -1057,10 +1078,10 @@ int wifi_mesh_enable_softap(wifi_mesh_h handle); int wifi_mesh_disable_softap(wifi_mesh_h handle); /** - * @brief Check softap status + * @brief Checks softap status. * @details This function checks softap status * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[out] status Status of SoftAP @@ -1078,10 +1099,10 @@ int wifi_mesh_disable_softap(wifi_mesh_h handle); int wifi_mesh_is_softap_started(wifi_mesh_h handle, bool *status); /** - * @brief Creates new Wi-Fi mesh network configuration + * @brief Creates new Wi-Fi mesh network configuration. * @details This function creates new mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] network Wi-Fi Mesh bss information handle @@ -1100,10 +1121,10 @@ int wifi_mesh_is_softap_started(wifi_mesh_h handle, bool *status); int wifi_mesh_create_network(wifi_mesh_h handle, wifi_mesh_network_h network); /** - * @brief Connects existing Wi-Fi mesh network + * @brief Connects existing Wi-Fi mesh network. * @details This function makes a connection to existing Wi-Fi mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] network Wi-Fi Mesh bss information handle @@ -1122,10 +1143,10 @@ int wifi_mesh_create_network(wifi_mesh_h handle, wifi_mesh_network_h network); int wifi_mesh_connect_network(wifi_mesh_h handle, wifi_mesh_network_h network); /** - * @brief Disconnects existing Wi-Fi mesh network + * @brief Disconnects existing Wi-Fi mesh network. * @details This function disconnects with existing Wi-Fi mesh network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] network Wi-Fi Mesh bss information handle @@ -1143,10 +1164,10 @@ int wifi_mesh_connect_network(wifi_mesh_h handle, wifi_mesh_network_h network); int wifi_mesh_disconnect_network(wifi_mesh_h handle, wifi_mesh_network_h network); /** - * @brief Forgets existing Wi-Fi mesh network + * @brief Forgets existing Wi-Fi mesh network. * @details This function removes the information of connected network. * - * @since_tizen 4.0 + * @since_tizen 5.0 * * @param[in] handle The Wi-Fi mesh handle * @param[in] network Wi-Fi Mesh bss information handle @@ -1173,4 +1194,4 @@ int wifi_mesh_forget_network(wifi_mesh_h handle, wifi_mesh_network_h network); } #endif -#endif /* __TIZEN_WIFI_MESH_H__ */ +#endif /* __TIZEN_NETWORK_WIFI_MESH_H__ */ |