*/
/**
- * @addtogroup CAPI_NETWORK_WIFI_MESH_MODULE
+ * @addtogroup CAPI_NETWORK_WIFI_MESH_MANAGER_MODULE
* @{
*/
*/
/**
- * @addtogroup CAPI_NETWORK_WIFI_MESH_MONITOR_MODULE
+ * @addtogroup CAPI_NETWORK_WIFI_MESH_MANAGER_MODULE
* @since_tizen 5.0
* @{
*/
} wifi_mesh_event_data_s;
/**
- * @}
- */
-
-/**
- * @addtogroup CAPI_NETWORK_WIFI_MESH_MODULE
- * @{
- */
-
-/**
* @brief The Wi-Fi mesh network profile handle.
* @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
- *
+ * @brief Initializes a Wi-Fi Mesh network.
* @since_tizen 5.0
*
- * @param[out] network The mesh network information handle, we will allocate mesh
- * network information structure internally.
+ * @privilege %http://tizen.org/privilege/wifi.admin
*
- * @return 0 on success, otherwise a negative error value.
- * @retval #WIFI_MESH_ERROR_NONE Successful
- * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Memory error
+ * @remarks You must release @a handle using wifi_mesh_deinitialize().
*
- * @see wifi_mesh_network_clone()
- * @see wifi_mesh_network_new_with()
- * @see wifi_mesh_network_destroy()
+ * @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
*/
-int wifi_mesh_network_new(wifi_mesh_network_h* network);
+int wifi_mesh_initialize(wifi_mesh_h *handle);
/**
- * @brief Clones a network handle.
- * @details This function is to clone mesh network information
- *
+ * @brief Deinitializes the Wi-Fi Mesh network.
* @since_tizen 5.0
*
- * @param[out] dst The target Wi-Fi mesh network information handle, we will allocate mesh
- * network information structure internally.
- * @param[in] src The source mesh network information handle.
+ * @param[in] handle The Wi-Fi mesh handle
*
- * @return 0 on success, otherwise a negative error value.
+ * @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_OUT_OF_MEMORY Memory error
- *
- * @see wifi_mesh_network_new()
- * @see wifi_mesh_network_new_with()
- * @see wifi_mesh_network_destroy()
- *
+ * @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_network_clone(wifi_mesh_network_h* dst, wifi_mesh_network_h src);
+int wifi_mesh_deinitialize(wifi_mesh_h handle);
/**
- * @brief Creates network handle with parameters.
- * @details This function is to allocate new mesh network information
+ * @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 5.0
*
- * @param[out] network The mesh network information handle, we will allocate mesh
- * network information structure internally.
- * @param[in] meshid The Mesh Network ID
- * @param[in] bssid The Basic Service Set ID
- * @param[in] channel The operating channel number
- * @param[in] rssi The Received Signal Strength Indicator
- * @param[in] security The security type for network
- * @param[in] passphrase The passphrase for network connection
+ * @remarks The @a event should not be released.
+ * @remarks The @a event can be used only in the callback.
*
- * @return 0 on success, otherwise a negative error value.
- * @retval #WIFI_MESH_ERROR_NONE Successful
- * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Memory error
+ * @param[out] event_type The event identification
+ * @param[out] event parameter data pointer
+ * @param[out] user_data The user data passed from callback registration function
*
- * @see wifi_mesh_network_clone()
- * @see wifi_mesh_network_new_with()
- * @see wifi_mesh_network_destroy()
+ * @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
*/
-int wifi_mesh_network_new_with(wifi_mesh_network_h* network, const char *meshid,
- const char *bssid, int channel, int rssi, wifi_mesh_security_type_e security,
- const char *passphrase);
+typedef void (*wifi_mesh_event_cb)(wifi_mesh_event_e event_type,
+ wifi_mesh_event_data_s* event, void *user_data);
/**
- * @brief Destroys network handle.
- * @details This function is to destroy mesh network information
+ * @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 5.0
*
- * @param[in] network The target Wi-Fi mesh network information handle.
+ * @param[in] handle The Wi-Fi mesh handle
+ * @param[in] event_handler The event handler
+ * @param[in] user_data The user data to be paased to event handler
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Memory error
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #WIFI_MESH_ERROR_NOT_SUPPORTED Not supported
*
- * @see wifi_mesh_network_new()
- * @see wifi_mesh_network_new_with()
- * @see wifi_mesh_network_clone()
- * @see wifi_mesh_network_destroy()
+ * @see wifi_mesh_initialize()
+ * @see wifi_mesh_deinitialize()
*
*/
-int wifi_mesh_network_destroy(wifi_mesh_network_h network);
+int wifi_mesh_set_event_cb(wifi_mesh_h handle,
+ wifi_mesh_event_cb event_handler, void *user_data);
/**
- * @brief Gets a Wi-Fi mesh network id.
- * @details This function is to return mesh network id
+ * @brief Makes the Wi-Fi mesh service enable.
+ * @details All this function to start Wi-Fi mesh service
*
* @since_tizen 5.0
*
- * @remarks The @meshid should be released using free().
+ * @remarks You must free all resources of the mesh by calling wifi_mesh_deinitialize()
+ * if mesh service is no longer needed.
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[out] meshid The mesh network id.
+ * @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
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_network_set_meshid()
+ * @see wifi_mesh_initialize()
+ * @see wifi_mesh_deinitialize()
+ * @see wifi_mesh_event_cb()
+ * @see wifi_mesh_disable()
*
*/
-int wifi_mesh_network_get_meshid(wifi_mesh_network_h network, char **meshid);
+int wifi_mesh_enable(wifi_mesh_h handle);
/**
- * @brief Sets a Wi-Fi mesh network id.
- * @details This function is to set Wi-Fi mesh network id
+ * @brief Makes the Wi-Fi mesh service disable.
+ * @details all this function to stop Wi-Fi mesh service
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] meshid The mesh network id.
+ * @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
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_network_get_meshid()
+ * @see wifi_mesh_initialize()
+ * @see wifi_mesh_deinitialize()
+ * @see wifi_mesh_enable()
*
*/
-int wifi_mesh_network_set_meshid(wifi_mesh_network_h network, const char *meshid);
+int wifi_mesh_disable(wifi_mesh_h handle);
/**
- * @brief Gets BSSID.
- * @details This function is to get basic service set id
+ * @brief Scans Wi-Fi mesh networks.
+ * @details Scan all Wi-Fi mesh network to get network state.
*
* @since_tizen 5.0
*
- * @remarks The @bssid should be released using free().
- *
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[out] bssid The basic service set id.
+ * @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
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_network_set_bssid()
+ * @see wifi_mesh_specific_scan()
+ * @see wifi_mesh_cancel_scan()
*
*/
-int wifi_mesh_network_get_bssid(wifi_mesh_network_h network, char **bssid);
+int wifi_mesh_scan(wifi_mesh_h handle);
/**
- * @brief Sets BSSID.
- * @details This function is to set basic service set id
+ * @brief Scans for the specific mesh network.
+ * @details Scan specific SSID and channel to get specific Wi-Fi mesh networks.
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] bssid The basic service set id.
+ * @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
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_network_get_bssid()
+ * @see wifi_mesh_scan()
+ * @see wifi_mesh_cancel_scan()
*
*/
-int wifi_mesh_network_set_bssid(wifi_mesh_network_h network, const char *bssid);
+int wifi_mesh_specific_scan(wifi_mesh_h handle, const char* ssid, int channel);
/**
- * @brief Gets channel.
- * @details This function is to get channel
+ * @brief Cancels scanning for the mesh network.
+ * @details Stops scanning process of mesh network.
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[out] channel The operating channel number.
+ * @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
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_network_set_channel()
+ * @see wifi_mesh_scan()
+ * @see wifi_mesh_specific_scan()
+ * @see wifi_mesh_scan()
*
*/
-int wifi_mesh_network_get_channel(wifi_mesh_network_h network, int *channel);
+int wifi_mesh_cancel_scan(wifi_mesh_h handle);
/**
- * @brief Sets channel.
- * @details This function is to get channel
+ * @brief Called after wifi_mesh_foreach_found_network().
+ * @details This function can receive scan results from Wi-Fi mesh networks.
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] channel The operating channel number.
+ * @remarks The @a network should not be released.
+ * @remarks The @a network can be used only in the callback. To use outside, make a copy.
*
- * @return 0 on success, otherwise a negative error value.
- * @retval #WIFI_MESH_ERROR_NONE Successful
- * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[out] network mesh bss information handle
+ * @param[out] user_data user data pointer
*
- * @see wifi_mesh_network_get_channel()
+ * @pre The callback must be registered with wifi_mesh_foreach_found_network()
*
+ * @see wifi_mesh_foreach_found_network()
*/
-int wifi_mesh_network_set_channel(wifi_mesh_network_h network, int channel);
+typedef void (*wifi_mesh_found_network_cb)(wifi_mesh_network_h network, void* user_data);
/**
- * @brief Gets RSSI.
- * @details This function is to get RSSI
+ * @brief Gets found Wi-Fi mesh network bss information.
+ * @details This function returns network information found through wifi_mesh_found_network_cb.
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[out] RSSI The received signal strength indicator.
+ * @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
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_network_set_rssi()
+ * @see wifi_mesh_scan()
+ * @see wifi_mesh_found_network_cb()
*
*/
-int wifi_mesh_network_get_rssi(wifi_mesh_network_h network, int *RSSI);
+int wifi_mesh_foreach_found_network(wifi_mesh_h handle,
+ wifi_mesh_found_network_cb cb, void *user_data);
/**
- * @brief Sets RSSI.
- * @details This function is to set RSSI
+ * @brief Called after wifi_mesh_foreach_connected_peers().
+ * @details This function can receive connected peers on the Wi-Fi mesh network.
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] RSSI The received signal strength indicator.
+ * @remarks The @a peer should not be released.
+ * @remarks The @a peer can be used only in the callback. To use outside, make a copy.
*
- * @return 0 on success, otherwise a negative error value.
- * @retval #WIFI_MESH_ERROR_NONE Successful
- * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[out] peer The mesh peer information handle
+ * @param[out] user_data user data pointer
*
- * @see wifi_mesh_network_get_rssi()
+ * @pre The callback must be registered with wifi_mesh_foreach_connected_peers()
*
+ * @see wifi_mesh_foreach_connected_peers()
*/
-int wifi_mesh_network_set_rssi(wifi_mesh_network_h network, int RSSI);
+typedef void (*wifi_mesh_connected_peer_cb)(wifi_mesh_peer_h peer, void* user_data);
/**
- * @brief Gets the security type.
- * @details This function is to get the security type.
+ * @brief Gets found Wi-Fi mesh network peer information.
+ * @details This function returns network information found through wifi_mesh_connected_peer_cb.
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[out] security The security type for network.
+ * @param[in] handle The Wi-Fi mesh handle
+ * @param[in] cb callback function pointer to inform peer 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
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_network_set_security()
+ * @see mesh_find_peers()
+ * @see wifi_mesh_connected_peer_cb()
*
*/
-int wifi_mesh_network_get_security(wifi_mesh_network_h network, wifi_mesh_security_type_e *security);
+int wifi_mesh_foreach_connected_peers(wifi_mesh_h handle,
+ wifi_mesh_connected_peer_cb cb, void *user_data);
/**
- * @brief Sets the security type.
- * @details This function is to set the security type.
- *
- * @since_tizen 5.0
+ * @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
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] security The security type for network.
+ * @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
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_network_get_security()
+ * @see wifi_mesh_stop()
*
*/
-int wifi_mesh_network_set_security(wifi_mesh_network_h network, wifi_mesh_security_type_e security);
+int wifi_mesh_start(wifi_mesh_h handle);
/**
- * @brief Sets the passphrase for network connection.
- * @details This function is to set the passphrase.
+ * @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 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] passphrase The passphrase for network connection.
+ * @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
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ *
+ * @see wifi_mesh_start()
*
- * @see wifi_mesh_network_get_security()
- * @see wifi_mesh_network_set_security()
*/
-int wifi_mesh_network_set_passphrase(wifi_mesh_network_h network, const char* passphrase);
+int wifi_mesh_stop(wifi_mesh_h handle);
/**
- * @brief Gets the connection state.
- * @details This function is to get the connection state
+ * @brief Gets the Wi-Fi mesh enable state.
+ * @details Check if mesh is enabled in current device.
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[out] state The maximum data rate.
+ * @param[in] handle The Wi-Fi mesh handle
+ * @param[out] is_started The state of mesh.
+ *
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ *
+ * @see wifi_mesh_start()
+ * @see wifi_mesh_stop()
*
*/
-int wifi_mesh_network_get_connection_state(wifi_mesh_network_h network, wifi_mesh_connection_state_e *state);
+int wifi_mesh_is_started(wifi_mesh_h handle, bool *is_started);
/**
- * @brief Gets the IP Config Type.
- * @details This function is to gets the IP Config Type
+ * @brief Gets the Wi-Fi mesh connection state.
+ * @details Check if current device is joined Wi-Fi mesh network.
*
* @since_tizen 5.0
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] address_family Address Family
- * @param[out] ip_type The IP Config Type
+ * @param[in] handle The Wi-Fi mesh handle
+ * @param[out] is_joined The state of mesh network connection.
+ *
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ *
+ * @see wifi_mesh_start()
+ * @see wifi_mesh_found_network_cb()
*
*/
-int wifi_mesh_network_get_ip_config_type(wifi_mesh_network_h network,
- wifi_mesh_address_family_e address_family,
- wifi_mesh_ip_config_type_e *ip_type);
+int wifi_mesh_is_joined(wifi_mesh_h handle, bool* is_joined);
/**
- * @brief Gets the IP Address.
- * @details This function is to gets the IP Address
+ * @brief Gets current joined Wi-Fi mesh network information.
+ * @details Return current joined Wi-Fi mesh network information..
*
* @since_tizen 5.0
*
- * @remarks You must release @ip_address using free().
+ * @param[in] handle The Wi-Fi mesh handle
+ * @param[out] network Wi-Fi Mesh bss information handle
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] address_family Address Family
- * @param[out] ip_address The IP Address
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ *
+ * @see wifi_mesh_start()
*
*/
-int wifi_mesh_network_get_ip_address(wifi_mesh_network_h network,
- wifi_mesh_address_family_e address_family, char **ip_address);
+int wifi_mesh_get_joined_network(wifi_mesh_h handle, wifi_mesh_network_h* network);
/**
- * @brief Gets the Subnet Mask.
- * @details This function is to gets the subnet mask
+ * @brief Sets softap options.
+ * @details This function sets softap options.
*
* @since_tizen 5.0
*
- * @remarks You must release @subnet_mask using free().
+ * @param[in] handle The Wi-Fi mesh handle
+ * @param[in] ssid The SSID
+ * @param[in] key The pre-shared key
+ * @param[in] channel The operating channel number
+ * @param[in] visibility The broadcast option (1:Broadcast SSID, 2:Hidden)
+ * @param[in] max_stations The maximum allowable number of stations (default:10)
+ * @param[in] security Security option (1:WPA1, 2:WPA2)
*
- * @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] address_family Address Family
- * @param[out] subnet_mask The Subnet Mask
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ *
+ * @see wifi_mesh_enable_softap()
+ * @see wifi_mesh_disable_softap()
*
*/
-int wifi_mesh_network_get_subnet_mask(wifi_mesh_network_h network,
- wifi_mesh_address_family_e address_family, char **subnet_mask);
+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 address from the Wi-Fi mesh peer.
- * @details This function is to return mesh network id
+ * @brief Gets softap options.
+ * @details This function gets softap options.
*
* @since_tizen 5.0
*
- * @remarks You must release @address using free().
+ * @remarks The @a ssid should be released using free().
+ * @remarks The @a key should be released using free().
+ *
+ * @param[in] handle The Wi-Fi mesh handle
+ * @param[out] ssid The SSID
+ * @param[out] channel The operating channel number
+ * @param[out] visibility The broadcast option (1:Broadcast SSID, 2:Hidden)
+ * @param[out] max_stations The maximum allowable number of stations (default:10)
+ * @param[out] security Security option (1:WPA1, 2:WPA2)
+ * @param[out] key The pre-shared key
*
- * @param[in] peer The mesh peer information handle.
- * @param[out] address The address of mesh peer.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- */
-int wifi_mesh_peer_get_address(wifi_mesh_peer_h peer, char **address);
-
-/**
- * @brief Initializes a Wi-Fi Mesh network.
- * @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
+ * @see wifi_mesh_set_softap()
+ * @see wifi_mesh_enable_softap()
+ * @see wifi_mesh_disable_softap()
*
- * @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
*/
-int wifi_mesh_initialize(wifi_mesh_h *handle);
+int wifi_mesh_get_softap(wifi_mesh_h handle, char **ssid, int *channel,
+ bool *visibility, int *max_stations,
+ int *security, char **key);
/**
- * @brief Deinitializes the Wi-Fi Mesh network.
+ * @brief Makes softap enable.
+ * @details This function enables softap.
+ *
* @since_tizen 5.0
*
* @param[in] handle The Wi-Fi mesh handle
*
- * @return 0 on success, otherwise negative error value
+ *
+ * @return 0 on success, otherwise a 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
- */
-int wifi_mesh_deinitialize(wifi_mesh_h handle);
-
-/**
- * @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 5.0
- *
- * @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[out] user_data The user data passed from callback registration function
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @pre The callback must be registered using wifi_mesh_enable().
+ * @see wifi_mesh_set_softap()
+ * @see wifi_mesh_disable_softap()
*
- * @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);
+int wifi_mesh_enable_softap(wifi_mesh_h handle);
/**
- * @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.
+ * @brief Makes softap disable.
+ * @details This function disables softap.
*
* @since_tizen 5.0
*
* @param[in] handle The Wi-Fi mesh handle
- * @param[in] event_handler The event handler
- * @param[in] user_data The user data to be paased to event handler
+ *
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
- * @retval #WIFI_MESH_ERROR_NOT_SUPPORTED Not supported
*
- * @see wifi_mesh_initialize()
- * @see wifi_mesh_deinitialize()
+ * @see wifi_mesh_set_softap()
+ * @see wifi_mesh_enable_softap()
+ * @see wifi_mesh_is_softap_started()
*
*/
-int wifi_mesh_set_event_cb(wifi_mesh_h handle,
- wifi_mesh_event_cb event_handler, void *user_data);
+int wifi_mesh_disable_softap(wifi_mesh_h handle);
/**
- * @brief Makes the Wi-Fi mesh service enable.
- * @details All this function to start Wi-Fi mesh service
+ * @brief Checks softap status.
+ * @details This function checks softap status
*
* @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
+ * @param[out] status Status of SoftAP
+ *
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_initialize()
- * @see wifi_mesh_deinitialize()
- * @see wifi_mesh_event_cb()
- * @see wifi_mesh_disable()
+ * @see wifi_mesh_set_softap()
+ * @see wifi_mesh_enable_softap()
*
*/
-int wifi_mesh_enable(wifi_mesh_h handle);
+int wifi_mesh_is_softap_started(wifi_mesh_h handle, bool *status);
/**
- * @brief Makes the Wi-Fi mesh service disable.
- * @details all this function to stop Wi-Fi mesh service
+ * @brief Sets gate options.
+ * @details This function sets mesh gate options.
*
* @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
+ * @param[in] gate_announce Enable / Disable Gate Announce to peers
+ * @param[in] hwmp_root_mode HWMP (Hybrid Wireless Mesh Protocol) Root Mode \n
+ * #MESH_HWMP_ROOT_REACTIVE_MODE \n
+ * #MESH_HWMP_ROOT_SIMPLE_PROACTIVE_MODE \n
+ * #MESH_HWMP_ROOT_FORCED_PROACTIVE_MODE \n
+ * #MESH_HWMP_ROOT_PROACTIVE_WITH_RANN_MODE \n
+ * @param[in] stp Enable / Disable Gate Announce to peers
+ *
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_initialize()
- * @see wifi_mesh_deinitialize()
- * @see wifi_mesh_enable()
+ * @see wifi_mesh_unset_gate()
*
*/
-int wifi_mesh_disable(wifi_mesh_h handle);
+int wifi_mesh_set_gate(wifi_mesh_h handle, int gate_announce,
+ int hwmp_root_mode, bool stp);
/**
- * @brief Scans Wi-Fi mesh networks.
- * @details Scan all Wi-Fi mesh network to get network state.
+ * @brief Unsets gate options.
+ * @details This function unsets mesh gate options.
*
* @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
* @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_specific_scan()
- * @see wifi_mesh_cancel_scan()
+ * @see wifi_mesh_set_gate()
*
*/
-int wifi_mesh_scan(wifi_mesh_h handle);
+int wifi_mesh_unset_gate(wifi_mesh_h handle);
+
/**
- * @brief Scans for the specific mesh network.
- * @details Scan specific SSID and channel to get specific Wi-Fi mesh networks.
+ * @brief Creates new Wi-Fi mesh network configuration.
+ * @details This function creates new mesh network.
*
* @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
+ * @param[in] network Wi-Fi Mesh bss information handle
+ *
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_scan()
- * @see wifi_mesh_cancel_scan()
+ * @see wifi_mesh_connect_network()
+ * @see wifi_mesh_disconnect_network()
+ * @see wifi_mesh_forget_network()
*
*/
-int wifi_mesh_specific_scan(wifi_mesh_h handle, const char* ssid, int channel);
+int wifi_mesh_create_network(wifi_mesh_h handle, wifi_mesh_network_h network);
/**
- * @brief Called after wifi_mesh_foreach_found_network().
- * @details This function can receive scan results from Wi-Fi mesh networks.
+ * @brief Connects existing Wi-Fi mesh network.
+ * @details This function makes a connection to existing Wi-Fi mesh network.
*
* @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[in] handle The Wi-Fi mesh handle
+ * @param[in] network Wi-Fi Mesh bss information handle
*
- * @param[out] network mesh bss information handle
- * @param[out] user_data user data pointer
*
- * @pre The callback must be registered with wifi_mesh_foreach_found_network()
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #WIFI_MESH_ERROR_NONE Successful
+ * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ *
+ * @see wifi_mesh_create_network()
+ * @see wifi_mesh_disconnect_network()
+ * @see wifi_mesh_forget_network()
*
- * @see wifi_mesh_foreach_found_network()
*/
-typedef void (*wifi_mesh_found_network_cb)(wifi_mesh_network_h network, void* user_data);
+int wifi_mesh_connect_network(wifi_mesh_h handle, wifi_mesh_network_h network);
/**
- * @brief Gets found Wi-Fi mesh network bss information.
- * @details This function returns network information found through wifi_mesh_found_network_cb.
+ * @brief Disconnects existing Wi-Fi mesh network.
+ * @details This function disconnects with existing Wi-Fi mesh network.
*
* @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
+ * @param[in] network Wi-Fi Mesh bss information handle
+ *
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_scan()
- * @see wifi_mesh_found_network_cb()
+ * @see wifi_mesh_create_network()
+ * @see wifi_mesh_forget_network()
*
*/
-int wifi_mesh_foreach_found_network(wifi_mesh_h handle,
- wifi_mesh_found_network_cb cb, void *user_data);
+int wifi_mesh_disconnect_network(wifi_mesh_h handle, wifi_mesh_network_h network);
/**
- * @brief Called after wifi_mesh_foreach_connected_peers().
- * @details This function can receive connected peers on the Wi-Fi mesh network.
+ * @brief Forgets existing Wi-Fi mesh network.
+ * @details This function removes the information of connected network.
*
* @since_tizen 5.0
*
- * @remarks The @peer should not be released.
- * @remarks The @peer can be used only in the callback. To use outside, make a copy.
+ * @param[in] handle The Wi-Fi mesh handle
+ * @param[in] network Wi-Fi Mesh bss information handle
*
- * @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()
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #WIFI_MESH_ERROR_NONE Successful
+ * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ *
+ * @see wifi_mesh_create_network()
+ * @see wifi_mesh_connect_network()
+ * @see wifi_mesh_disconnect_network()
*
- * @see wifi_mesh_foreach_connected_peers()
*/
-typedef void (*wifi_mesh_connected_peer_cb)(wifi_mesh_peer_h peer, void* user_data);
+int wifi_mesh_forget_network(wifi_mesh_h handle, wifi_mesh_network_h network);
/**
- * @brief Gets found Wi-Fi mesh network peer information.
- * @details This function returns network information found through wifi_mesh_connected_peer_cb.
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_NETWORK_WIFI_MESH_AP_MODULE
+ * @{
+ */
+
+/**
+ * @brief Creates a network handle.
+ * @details This function is to allocate new mesh network information
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[in] cb callback function pointer to inform peer information
- * @param[in] user_data user data pointer
- *
+ * @param[out] network The mesh network information handle, we will allocate mesh
+ * network information structure internally.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Memory error
*
- * @see mesh_find_peers()
- * @see wifi_mesh_connected_peer_cb()
+ * @see wifi_mesh_network_clone()
+ * @see wifi_mesh_network_new_with()
+ * @see wifi_mesh_network_destroy()
*
*/
-int wifi_mesh_foreach_connected_peers(wifi_mesh_h handle,
- wifi_mesh_connected_peer_cb cb, void *user_data);
+int wifi_mesh_network_new(wifi_mesh_network_h* 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
+ * @brief Clones a network handle.
+ * @details This function is to clone mesh network information
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
+ * @param[out] dst The target Wi-Fi mesh network information handle, we will allocate mesh
+ * network information structure internally.
+ * @param[in] src The source mesh network information handle.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Memory error
*
- * @see wifi_mesh_stop()
+ * @see wifi_mesh_network_new()
+ * @see wifi_mesh_network_new_with()
+ * @see wifi_mesh_network_destroy()
*
*/
-int wifi_mesh_start(wifi_mesh_h handle);
+int wifi_mesh_network_clone(wifi_mesh_network_h* dst, wifi_mesh_network_h src);
/**
- * @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
+ * @brief Creates network handle with parameters.
+ * @details This function is to allocate new mesh network information
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
+ * @param[out] network The mesh network information handle, we will allocate mesh
+ * network information structure internally.
+ * @param[in] meshid The Mesh Network ID
+ * @param[in] bssid The Basic Service Set ID
+ * @param[in] channel The operating channel number
+ * @param[in] rssi The Received Signal Strength Indicator
+ * @param[in] security The security type for network
+ * @param[in] passphrase The passphrase for network connection
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Memory error
*
- * @see wifi_mesh_start()
+ * @see wifi_mesh_network_clone()
+ * @see wifi_mesh_network_new_with()
+ * @see wifi_mesh_network_destroy()
*
*/
-int wifi_mesh_stop(wifi_mesh_h handle);
+int wifi_mesh_network_new_with(wifi_mesh_network_h* network, const char *meshid,
+ const char *bssid, int channel, int rssi, wifi_mesh_security_type_e security,
+ const char *passphrase);
/**
- * @brief Gets the Wi-Fi mesh enable state.
- * @details Check if mesh is enabled in current device.
+ * @brief Destroys network handle.
+ * @details This function is to destroy mesh network information
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[out] is_started The state of mesh.
- *
+ * @param[in] network The target Wi-Fi mesh network information handle.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
+ * @retval #WIFI_MESH_ERROR_OUT_OF_MEMORY Memory error
*
- * @see wifi_mesh_start()
- * @see wifi_mesh_stop()
+ * @see wifi_mesh_network_new()
+ * @see wifi_mesh_network_new_with()
+ * @see wifi_mesh_network_clone()
+ * @see wifi_mesh_network_destroy()
*
*/
-int wifi_mesh_is_started(wifi_mesh_h handle, bool *is_started);
+int wifi_mesh_network_destroy(wifi_mesh_network_h network);
/**
- * @brief Gets the Wi-Fi mesh connection state.
- * @details Check if current device is joined Wi-Fi mesh network.
+ * @brief Gets a Wi-Fi mesh network id.
+ * @details This function is to return mesh network id
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[out] is_joined The state of mesh network connection.
+ * @remarks The @a meshid should be released using free().
*
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[out] meshid The mesh network id.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_start()
- * @see wifi_mesh_found_network_cb()
+ * @see wifi_mesh_network_set_meshid()
*
*/
-int wifi_mesh_is_joined(wifi_mesh_h handle, bool* is_joined);
+int wifi_mesh_network_get_meshid(wifi_mesh_network_h network, char **meshid);
/**
- * @brief Gets current joined Wi-Fi mesh network information.
- * @details Return current joined Wi-Fi mesh network information..
+ * @brief Sets a Wi-Fi mesh network id.
+ * @details This function is to set Wi-Fi mesh network id
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[out] network Wi-Fi Mesh bss information handle
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[in] meshid The mesh network id.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_start()
+ * @see wifi_mesh_network_get_meshid()
*
*/
-int wifi_mesh_get_joined_network(wifi_mesh_h handle, wifi_mesh_network_h* network);
+int wifi_mesh_network_set_meshid(wifi_mesh_network_h network, const char *meshid);
/**
- * @brief Sets softap options.
- * @details This function sets softap options.
+ * @brief Gets BSSID.
+ * @details This function is to get basic service set id
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[in] ssid The SSID
- * @param[in] key The pre-shared key
- * @param[in] channel The operating channel number
- * @param[in] visibility The broadcast option (1:Broadcast SSID, 2:Hidden)
- * @param[in] max_stations The maximum allowable number of stations (default:10)
- * @param[in] security Security option (1:WPA1, 2:WPA2)
+ * @remarks The @a bssid should be released using free().
*
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[out] bssid The basic service set id.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_enable_softap()
- * @see wifi_mesh_disable_softap()
+ * @see wifi_mesh_network_set_bssid()
*
*/
-int wifi_mesh_set_softap(wifi_mesh_h handle, const char* ssid, const char* key,
- int channel, bool visibility, int max_stations, int security);
+int wifi_mesh_network_get_bssid(wifi_mesh_network_h network, char **bssid);
/**
- * @brief Gets softap options.
- * @details This function gets softap options.
+ * @brief Sets BSSID.
+ * @details This function is to set basic service set id
*
* @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
- * @param[out] channel The operating channel number
- * @param[out] visibility The broadcast option (1:Broadcast SSID, 2:Hidden)
- * @param[out] max_stations The maximum allowable number of stations (default:10)
- * @param[out] security Security option (1:WPA1, 2:WPA2)
- * @param[out] key The pre-shared key
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[in] bssid The basic service set id.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_set_softap()
- * @see wifi_mesh_enable_softap()
- * @see wifi_mesh_disable_softap()
+ * @see wifi_mesh_network_get_bssid()
*
*/
-int wifi_mesh_get_softap(wifi_mesh_h handle, char **ssid, int *channel,
- bool *visibility, int *max_stations,
- int *security, char **key);
+int wifi_mesh_network_set_bssid(wifi_mesh_network_h network, const char *bssid);
/**
- * @brief Makes softap enable.
- * @details This function enables softap.
+ * @brief Gets channel.
+ * @details This function is to get channel
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[out] channel The operating channel number.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_set_softap()
- * @see wifi_mesh_disable_softap()
+ * @see wifi_mesh_network_set_channel()
*
*/
-int wifi_mesh_enable_softap(wifi_mesh_h handle);
+int wifi_mesh_network_get_channel(wifi_mesh_network_h network, int *channel);
/**
- * @brief Makes softap disable.
- * @details This function disables softap.
+ * @brief Sets channel.
+ * @details This function is to get channel
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[in] channel The operating channel number.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_set_softap()
- * @see wifi_mesh_enable_softap()
- * @see wifi_mesh_is_softap_started()
+ * @see wifi_mesh_network_get_channel()
*
*/
-int wifi_mesh_disable_softap(wifi_mesh_h handle);
+int wifi_mesh_network_set_channel(wifi_mesh_network_h network, int channel);
/**
- * @brief Checks softap status.
- * @details This function checks softap status
+ * @brief Gets RSSI.
+ * @details This function is to get RSSI
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[out] status Status of SoftAP
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[out] RSSI The received signal strength indicator.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_set_softap()
- * @see wifi_mesh_enable_softap()
+ * @see wifi_mesh_network_set_rssi()
*
*/
-int wifi_mesh_is_softap_started(wifi_mesh_h handle, bool *status);
+int wifi_mesh_network_get_rssi(wifi_mesh_network_h network, int *RSSI);
/**
- * @brief Creates new Wi-Fi mesh network configuration.
- * @details This function creates new mesh network.
+ * @brief Sets RSSI.
+ * @details This function is to set RSSI
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[in] network Wi-Fi Mesh bss information handle
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[in] RSSI The received signal strength indicator.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_connect_network()
- * @see wifi_mesh_disconnect_network()
- * @see wifi_mesh_forget_network()
+ * @see wifi_mesh_network_get_rssi()
*
*/
-int wifi_mesh_create_network(wifi_mesh_h handle, wifi_mesh_network_h network);
+int wifi_mesh_network_set_rssi(wifi_mesh_network_h network, int RSSI);
/**
- * @brief Connects existing Wi-Fi mesh network.
- * @details This function makes a connection to existing Wi-Fi mesh network.
+ * @brief Gets the security type.
+ * @details This function is to get the security type.
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[in] network Wi-Fi Mesh bss information handle
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[out] security The security type for network.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_create_network()
- * @see wifi_mesh_disconnect_network()
- * @see wifi_mesh_forget_network()
+ * @see wifi_mesh_network_set_security()
*
*/
-int wifi_mesh_connect_network(wifi_mesh_h handle, wifi_mesh_network_h network);
+int wifi_mesh_network_get_security(wifi_mesh_network_h network,
+ wifi_mesh_security_type_e *security);
/**
- * @brief Disconnects existing Wi-Fi mesh network.
- * @details This function disconnects with existing Wi-Fi mesh network.
+ * @brief Sets the security type.
+ * @details This function is to set the security type.
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[in] network Wi-Fi Mesh bss information handle
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[in] security The security type for network.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_create_network()
- * @see wifi_mesh_forget_network()
+ * @see wifi_mesh_network_get_security()
*
*/
-int wifi_mesh_disconnect_network(wifi_mesh_h handle, wifi_mesh_network_h network);
+int wifi_mesh_network_set_security(wifi_mesh_network_h network,
+ wifi_mesh_security_type_e security);
/**
- * @brief Forgets existing Wi-Fi mesh network.
- * @details This function removes the information of connected network.
+ * @brief Sets the passphrase for network connection.
+ * @details This function is to set the passphrase.
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[in] network Wi-Fi Mesh bss information handle
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[in] passphrase The passphrase for network connection.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
- *
- * @see wifi_mesh_create_network()
- * @see wifi_mesh_connect_network()
- * @see wifi_mesh_disconnect_network()
*
+ * @see wifi_mesh_network_get_security()
+ * @see wifi_mesh_network_set_security()
*/
-int wifi_mesh_forget_network(wifi_mesh_h handle, wifi_mesh_network_h network);
+int wifi_mesh_network_set_passphrase(wifi_mesh_network_h network,
+ const char* passphrase);
/**
- * @brief The HWMP (Hybrid Wireless Mesh Protocol) type for mesh_hwmp_root_mode_e.
+ * @brief Gets the connection state.
+ * @details This function is to get the connection state
*
* @since_tizen 5.0
+ *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[out] state The maximum data rate.
+ *
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #WIFI_MESH_ERROR_NONE Successful
+ * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ *
*/
-typedef enum {
- MESH_HWMP_ROOT_REACTIVE_MODE = 0, /**< Disable Proative Mode */
- MESH_HWMP_ROOT_SIMPLE_PROACTIVE_MODE = 2, /**< Enable the Proactive PREQ with no PREP */
- MESH_HWMP_ROOT_FORCED_PROACTIVE_MODE = 3, /**< Enable the Proactive PREQ with PREP.
- Once you do this, all the nodes in your mesh will proactively create paths to your gate.
- Mesh nodes will send to gate(s) all traffic to those destinations that could not be resolved in the mesh. */
- MESH_HWMP_ROOT_PROACTIVE_WITH_RANN_MODE = 4, /**< If we use HWMP_ROOTMODE as 4, every 5 sec,
- our DUT sends action_frame with root announce. */
-} mesh_hwmp_root_mode_e;
-
-/**
- * @brief The mesh station information handle.
- * @since_tizen 5.0
- */
-typedef void* wifi_mesh_station_info_h;
-
-/**
- * @brief The mesh path information handle.
- * @since_tizen 5.0
- */
-typedef void* wifi_mesh_mpath_info_h;
+int wifi_mesh_network_get_connection_state(wifi_mesh_network_h network,
+ wifi_mesh_connection_state_e *state);
/**
- * @brief The mesh conf information handle.
+ * @brief Gets the IP Config Type.
+ * @details This function is to gets the IP Config Type
+ *
* @since_tizen 5.0
+ *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[in] address_family Address Family
+ * @param[out] ip_type The IP Config Type
+ *
+ * @return 0 on success, otherwise a negative error value.
+ * @retval #WIFI_MESH_ERROR_NONE Successful
+ * @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
+ *
*/
-typedef void* wifi_mesh_meshconf_info_h;
+int wifi_mesh_network_get_ip_config_type(wifi_mesh_network_h network,
+ wifi_mesh_address_family_e address_family,
+ wifi_mesh_ip_config_type_e *ip_type);
/**
- * @brief Gets the maximum data rate.
- * @details This function is to get the maximum data rate
+ * @brief Gets the IP Address.
+ * @details This function is to gets the IP Address
*
* @since_tizen 5.0
*
+ * @remarks You must release @a ip_address using free().
+ *
* @param[in] network The Wi-Fi mesh network information handle.
- * @param[out] data_rate The maximum data rate.
+ * @param[in] address_family Address Family
+ * @param[out] ip_address The IP Address
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see wifi_mesh_network_set_data_rate()
- *
*/
-int wifi_mesh_network_get_data_rate(wifi_mesh_network_h network, int *data_rate);
+int wifi_mesh_network_get_ip_address(wifi_mesh_network_h network,
+ wifi_mesh_address_family_e address_family, char **ip_address);
/**
- * @brief Sets the maximum data rate.
- * @details This function is to set the maximum data rate
+ * @brief Gets the Subnet Mask.
+ * @details This function is to gets the subnet mask
*
* @since_tizen 5.0
*
+ * @remarks You must release @a subnet_mask using free().
+ *
* @param[in] network The Wi-Fi mesh network information handle.
- * @param[in] data_rate The maximum data rate.
+ * @param[in] address_family Address Family
+ * @param[out] subnet_mask The Subnet Mask
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see wifi_mesh_network_get_data_rate()
- *
*/
-int wifi_mesh_network_set_data_rate(wifi_mesh_network_h network, int data_rate);
+int wifi_mesh_network_get_subnet_mask(wifi_mesh_network_h network,
+ wifi_mesh_address_family_e address_family, char **subnet_mask);
/**
- * @brief Cancels scanning for the mesh network.
- * @details Stops scanning process of mesh network.
+ * @brief Gets address from the Wi-Fi mesh peer.
+ * @details This function is to return mesh network id
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
+ * @remarks You must release @a address using free().
*
+ * @param[in] peer The mesh peer information handle.
+ * @param[out] address The address of mesh peer.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
- *
- * @see wifi_mesh_scan()
- * @see wifi_mesh_specific_scan()
- * @see wifi_mesh_scan()
*
*/
-int wifi_mesh_cancel_scan(wifi_mesh_h handle);
+int wifi_mesh_peer_get_address(wifi_mesh_peer_h peer, char **address);
/**
- * @brief Sets gate options.
- * @details This function sets mesh gate options.
+ * @brief Gets the maximum data rate.
+ * @details This function is to get the maximum data rate
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- * @param[in] gate_announce Enable / Disable Gate Announce to peers
- * @param[in] hwmp_root_mode HWMP (Hybrid Wireless Mesh Protocol) Root Mode \n
- * #MESH_HWMP_ROOT_REACTIVE_MODE \n
- * #MESH_HWMP_ROOT_SIMPLE_PROACTIVE_MODE \n
- * #MESH_HWMP_ROOT_FORCED_PROACTIVE_MODE \n
- * #MESH_HWMP_ROOT_PROACTIVE_WITH_RANN_MODE \n
- * @param[in] stp Enable / Disable Gate Announce to peers
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[out] data_rate The maximum data rate.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_unset_gate()
+ * @see wifi_mesh_network_set_data_rate()
*
*/
-int wifi_mesh_set_gate(wifi_mesh_h handle, int gate_announce, int hwmp_root_mode, bool stp);
+int wifi_mesh_network_get_data_rate(wifi_mesh_network_h network,
+ int *data_rate);
/**
- * @brief Unsets gate options.
- * @details This function unsets mesh gate options.
+ * @brief Sets the maximum data rate.
+ * @details This function is to set the maximum data rate
*
* @since_tizen 5.0
*
- * @param[in] handle The Wi-Fi mesh handle
- *
+ * @param[in] network The Wi-Fi mesh network information handle.
+ * @param[in] data_rate The maximum data rate.
*
* @return 0 on success, otherwise a negative error value.
* @retval #WIFI_MESH_ERROR_NONE Successful
* @retval #WIFI_MESH_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #WIFI_MESH_ERROR_IO_ERROR Unexpected d-bus error
*
- * @see wifi_mesh_set_gate()
+ * @see wifi_mesh_network_get_data_rate()
*
*/
-int wifi_mesh_unset_gate(wifi_mesh_h handle);
+int wifi_mesh_network_set_data_rate(wifi_mesh_network_h network,
+ int data_rate);
+
+/**
+ * @}
+ */
+
+
+/**
+ * @addtogroup CAPI_NETWORK_WIFI_MESH_MONITOR_MODULE
+ * @{
+ */
+
+/**
+ * @brief The HWMP (Hybrid Wireless Mesh Protocol) type for mesh_hwmp_root_mode_e.
+ *
+ * @since_tizen 5.0
+ */
+typedef enum {
+ MESH_HWMP_ROOT_REACTIVE_MODE = 0, /**< Disable Proative Mode */
+ MESH_HWMP_ROOT_SIMPLE_PROACTIVE_MODE = 2, /**< Enable the Proactive PREQ with no PREP */
+ MESH_HWMP_ROOT_FORCED_PROACTIVE_MODE = 3, /**< Enable the Proactive PREQ with PREP.
+ Once you do this, all the nodes in your mesh will proactively create paths to your gate.
+ Mesh nodes will send to gate(s) all traffic to those destinations that could not be resolved in the mesh. */
+ MESH_HWMP_ROOT_PROACTIVE_WITH_RANN_MODE = 4, /**< If we use HWMP_ROOTMODE as 4, every 5 sec,
+ our DUT sends action_frame with root announce. */
+} mesh_hwmp_root_mode_e;
+
+/**
+ * @brief The mesh station information handle.
+ * @since_tizen 5.0
+ */
+typedef void* wifi_mesh_station_info_h;
+
+/**
+ * @brief The mesh path information handle.
+ * @since_tizen 5.0
+ */
+typedef void* wifi_mesh_mpath_info_h;
+
+/**
+ * @brief The mesh conf information handle.
+ * @since_tizen 5.0
+ */
+typedef void* wifi_mesh_meshconf_info_h;
+
/**
* @brief This callback function is called after wifi_mesh_get_stations_info().
*
* @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.
+ * @remarks The @a station should not be released.
+ * @remarks The @a 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
*
* @see wifi_mesh_foreach_found_network()
*/
-typedef void(*wifi_mesh_found_station_cb)(wifi_mesh_station_info_h station, void* user_data);
+typedef void(*wifi_mesh_found_station_cb)(wifi_mesh_station_info_h station,
+ void* user_data);
/**
* @brief Gets information of all connected stations.
- * @details Gets information about all stations present in the currently connected mesh network.
+ * @details Gets information about all stations present in the currently connected mesh
+ * network.
*
* @since_tizen 5.0
*
*
* @since_tizen 5.0
*
- * @remarks The @bssid should be released using free().
+ * @remarks The @a bssid should be released using free().
*
* @param[in] station The Wi-Fi mesh station handle
* @param[out] bssid A pointer to get BSSID information
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_bssid(wifi_mesh_station_info_h station, char** bssid);
+int wifi_mesh_get_sta_bssid(wifi_mesh_station_info_h station,
+ char** bssid);
/**
* @brief Gets inactive time of a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_inactive_time(wifi_mesh_station_info_h station, unsigned int* inactive_time);
+int wifi_mesh_get_sta_inactive_time(wifi_mesh_station_info_h station,
+ unsigned int* inactive_time);
/**
* @brief Gets rx bytes of a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_rx_bytes(wifi_mesh_station_info_h station, unsigned long* rx_bytes);
+int wifi_mesh_get_sta_rx_bytes(wifi_mesh_station_info_h station,
+ unsigned long* rx_bytes);
/**
* @brief Gets rx packets of a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_rx_packets(wifi_mesh_station_info_h station, unsigned int* rx_packets);
+int wifi_mesh_get_sta_rx_packets(wifi_mesh_station_info_h station,
+ unsigned int* rx_packets);
/**
* @brief Gets tx packets counts of a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_tx_bytes(wifi_mesh_station_info_h station, unsigned long* tx_bytes);
+int wifi_mesh_get_sta_tx_bytes(wifi_mesh_station_info_h station,
+ unsigned long* tx_bytes);
/**
* @brief Gets tx packets of a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_tx_packets(wifi_mesh_station_info_h station, unsigned int* tx_packets);
+int wifi_mesh_get_sta_tx_packets(wifi_mesh_station_info_h station,
+ unsigned int* tx_packets);
/**
* @brief Gets a re-trial number of transmits at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_tx_retries(wifi_mesh_station_info_h station, unsigned int* tx_retries);
+int wifi_mesh_get_sta_tx_retries(wifi_mesh_station_info_h station,
+ unsigned int* tx_retries);
/**
* @brief Gets tx-fail counts of a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_tx_failed(wifi_mesh_station_info_h station, unsigned int* tx_failed);
+int wifi_mesh_get_sta_tx_failed(wifi_mesh_station_info_h station,
+ unsigned int* tx_failed);
/**
* @brief Gets a number of beacon loss at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_beacon_loss(wifi_mesh_station_info_h station, unsigned int* beacon_loss);
+int wifi_mesh_get_sta_beacon_loss(wifi_mesh_station_info_h station,
+ unsigned int* beacon_loss);
/**
* @brief Gets a number of received beacons at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_beacon_rx(wifi_mesh_station_info_h station, unsigned long* beacon_rx);
+int wifi_mesh_get_sta_beacon_rx(wifi_mesh_station_info_h station,
+ unsigned long* beacon_rx);
/**
- * @brief Gets a number of dropped packets number with ambiguous reason at a connected station.
+ * @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 5.0
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_rx_drop_misc(wifi_mesh_station_info_h station, unsigned long* rx_drop_misc);
+int wifi_mesh_get_sta_rx_drop_misc(wifi_mesh_station_info_h station,
+ unsigned long* rx_drop_misc);
/**
* @brief Gets instant received signal strength at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_signal(wifi_mesh_station_info_h station, int* signal);
+int wifi_mesh_get_sta_signal(wifi_mesh_station_info_h station,
+ int* signal);
/**
* @brief Gets average received signal strength at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_signal_avg(wifi_mesh_station_info_h station, int* signal_avg);
+int wifi_mesh_get_sta_signal_avg(wifi_mesh_station_info_h station,
+ int* signal_avg);
/**
* @brief Gets transmit bit-rate at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_tx_bitrate(wifi_mesh_station_info_h station, unsigned int* tx_bitrate);
+int wifi_mesh_get_sta_tx_bitrate(wifi_mesh_station_info_h station,
+ unsigned int* tx_bitrate);
/**
* @brief Gets received bit-rate at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_rx_bitrate(wifi_mesh_station_info_h station, unsigned int* rx_bitrate);
+int wifi_mesh_get_sta_rx_bitrate(wifi_mesh_station_info_h station,
+ unsigned int* rx_bitrate);
/**
* @brief Gets local-link identifier at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_mesh_llid(wifi_mesh_station_info_h station, unsigned short* mesh_llid);
+int wifi_mesh_get_sta_mesh_llid(wifi_mesh_station_info_h station,
+ unsigned short* mesh_llid);
/**
* @brief Gets peer-link identifier at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_mesh_plid(wifi_mesh_station_info_h station, unsigned short* mesh_plid);
+int wifi_mesh_get_sta_mesh_plid(wifi_mesh_station_info_h station,
+ unsigned short* mesh_plid);
/**
* @brief Gets peer-link status at a connected station.
*
* @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.
+ * @remarks The @a mesh_plink should not be released.
+ * @remarks The @a mesh_plink is available until wifi_mesh_station_info_h is released.
*
* @param[in] station The Wi-Fi mesh station handle
* @param[out] mesh_plink Peer-link status such as "ESTAB"
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_mesh_plink(wifi_mesh_station_info_h station, unsigned char* mesh_plink);
+int wifi_mesh_get_sta_mesh_plink(wifi_mesh_station_info_h station,
+ unsigned char* mesh_plink);
/**
* @brief Gets local-link power save mode at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_local_ps_mode(wifi_mesh_station_info_h station, unsigned int* local_ps_mode);
+int wifi_mesh_get_sta_local_ps_mode(
+ wifi_mesh_station_info_h station, unsigned int* local_ps_mode);
/**
* @brief Gets peer-link power save mode at a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_non_peer_ps_mode(wifi_mesh_station_info_h station, unsigned int* non_peer_ps_mode);
+int wifi_mesh_get_sta_non_peer_ps_mode(
+ wifi_mesh_station_info_h station, unsigned int* non_peer_ps_mode);
/**
* @brief Gets to know whether a connected station authorized or not.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_authorized(wifi_mesh_station_info_h station, bool* authorized);
+int wifi_mesh_get_sta_authorized(wifi_mesh_station_info_h station,
+ bool* authorized);
/**
* @brief Gets to know whether a connected station athenticated or not.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_authenticated(wifi_mesh_station_info_h station, bool* authenticated);
+int wifi_mesh_get_sta_authenticated(wifi_mesh_station_info_h station,
+ bool* authenticated);
/**
* @brief Gets to know whether a connected station associated or not.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_associated(wifi_mesh_station_info_h station, bool* associated);
+int wifi_mesh_get_sta_associated(wifi_mesh_station_info_h station,
+ bool* associated);
/**
* @brief Gets preamble type long or short.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_preamble(wifi_mesh_station_info_h station, bool* preamble);
+int wifi_mesh_get_sta_preamble(wifi_mesh_station_info_h station,
+ bool* preamble);
/**
* @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).
+ * @details Get to know a station can support Wireless Multimedia Extension
+ * (in other word, Wi-Fi Multimedia).
*
* @since_tizen 5.0
*
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_wmm_wme(wifi_mesh_station_info_h station, bool* wmm_wme);
+int wifi_mesh_get_sta_wmm_wme(wifi_mesh_station_info_h station,
+ bool* wmm_wme);
/**
* @brief Gets to know a station can support management frame protection.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_tdls_peer(wifi_mesh_station_info_h station, bool* tdls_peer);
+int wifi_mesh_get_sta_tdls_peer(wifi_mesh_station_info_h station,
+ bool* tdls_peer);
/**
* @brief Gets DTIM period of a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_dtim_period(wifi_mesh_station_info_h station, unsigned char* dtim_period);
+int wifi_mesh_get_sta_dtim_period(wifi_mesh_station_info_h station,
+ unsigned char* dtim_period);
/**
* @brief Gets beacon interval of a connected station.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_beacon_interval(wifi_mesh_station_info_h station, unsigned short* beacon_interval);
+int wifi_mesh_get_sta_beacon_interval(
+ wifi_mesh_station_info_h station, unsigned short* beacon_interval);
/**
* @brief Gets to know a station can support RTS (Request-to-Send) / CTS (Clear-to-Send).
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_cts_protection(wifi_mesh_station_info_h station, bool* cts_protection);
+int wifi_mesh_get_sta_cts_protection(
+ wifi_mesh_station_info_h station, bool* cts_protection);
/**
* @brief Gets to know a station can support short preamble.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_short_preamble(wifi_mesh_station_info_h station, bool* short_preamble);
+int wifi_mesh_get_sta_short_preamble(
+ wifi_mesh_station_info_h station, bool* short_preamble);
/**
* @brief Gets to know a station can support short slot.
* @see wifi_mesh_get_sta_connected_time()
*
*/
-int wifi_mesh_get_sta_short_slot_time(wifi_mesh_station_info_h station, bool* short_slot_time);
+int wifi_mesh_get_sta_short_slot_time(
+ wifi_mesh_station_info_h station, bool* short_slot_time);
/**
* @brief Gets to know how many time elapsed since a station joined.
* @see wifi_mesh_get_sta_short_slot_time()
*
*/
-int wifi_mesh_get_sta_connected_time(wifi_mesh_station_info_h station, unsigned int* connected_time);
+int wifi_mesh_get_sta_connected_time(
+ wifi_mesh_station_info_h station, unsigned int* connected_time);
/**
* @brief Called after wifi_mesh_get_stations_info().
*
* @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.
+ * @remarks The @a path should not be released.
+ * @remarks The @a 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
/**
* @brief Gets information of all mesh paths.
- * @details Get information about all mesh paths present in the currently connected mesh network.
+ * @details Get information about all mesh paths present in the currently connected
+ * mesh network.
*
* @since_tizen 5.0
*
* @see wifi_mesh_get_stations_info()
*
*/
-int wifi_mesh_get_mpath_info(wifi_mesh_h handle, mesh_found_mpath_cb cb, void *user_data);
+int wifi_mesh_get_mpath_info(wifi_mesh_h handle, mesh_found_mpath_cb cb,
+ void *user_data);
/**
* @brief Gets a destination address.
*
* @since_tizen 5.0
*
- * @remarks The @dest_addr should not be released.
- * @remarks The @dest_addr is available until wifi_mesh_mpath_info_h is released.
+ * @remarks The @a dest_addr should not be released.
+ * @remarks The @a 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
* @see wifi_mesh_get_mpath_flags()
*
*/
-int wifi_mesh_get_mpath_dest_addr(wifi_mesh_mpath_info_h mpath, char** dest_addr);
+int wifi_mesh_get_mpath_dest_addr(wifi_mesh_mpath_info_h mpath,
+ char** dest_addr);
/**
* @brief Gets a next hop address.
*
* @since_tizen 5.0
*
- * @remarks The @next_hop should not be released.
- * @remarks The @next_hop is available until wifi_mesh_mpath_info_h is released.
+ * @remarks The @a next_hop should not be released.
+ * @remarks The @a 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
* @see wifi_mesh_get_mpath_flags()
*
*/
-int wifi_mesh_get_mpath_next_hop(wifi_mesh_mpath_info_h mpath, char** next_hop);
+int wifi_mesh_get_mpath_next_hop(wifi_mesh_mpath_info_h mpath,
+ char** next_hop);
/**
* @brief Gets a control interface.
*
* @since_tizen 5.0
*
- * @remarks The @iface should not be released.
- * @remarks The @iface is available until wifi_mesh_mpath_info_h is released.
+ * @remarks The @a iface should not be released.
+ * @remarks The @a iface is available until wifi_mesh_mpath_info_h is released.
*
*
* @param[in] mpath The adjacent mesh path information
* @see wifi_mesh_get_mpath_flags()
*
*/
-int wifi_mesh_get_mpath_iface(wifi_mesh_mpath_info_h mpath, char** iface);
+int wifi_mesh_get_mpath_iface(wifi_mesh_mpath_info_h mpath,
+ char** iface);
/**
* @brief Gets a serial number of the current control packet.
* @see wifi_mesh_get_mpath_flags()
*
*/
-int wifi_mesh_get_mpath_sn(wifi_mesh_mpath_info_h mpath, unsigned int* sn);
+int wifi_mesh_get_mpath_sn(wifi_mesh_mpath_info_h mpath,
+ unsigned int* sn);
/**
* @brief Gets a metric number.
* @see wifi_mesh_get_mpath_flags()
*
*/
-int wifi_mesh_get_mpath_metric(wifi_mesh_mpath_info_h mpath, unsigned int* metric);
+int wifi_mesh_get_mpath_metric(wifi_mesh_mpath_info_h mpath,
+ unsigned int* metric);
/**
* @brief Gets a queue length in the Wi-Fi driver.
* @see wifi_mesh_get_mpath_disc_retries()
* @see wifi_mesh_get_mpath_flags()
*/
-int wifi_mesh_get_mpath_qlen(wifi_mesh_mpath_info_h mpath, unsigned int* qlen);
+int wifi_mesh_get_mpath_qlen(wifi_mesh_mpath_info_h mpath,
+ unsigned int* qlen);
/**
* @brief Gets a time of next destination available.
* @see wifi_mesh_get_mpath_disc_retries()
* @see wifi_mesh_get_mpath_flags()
*/
-int wifi_mesh_get_mpath_exptime(wifi_mesh_mpath_info_h mpath, unsigned int* exptime);
+int wifi_mesh_get_mpath_exptime(wifi_mesh_mpath_info_h mpath,
+ unsigned int* exptime);
/**
* @brief Gets a time of discovery timeout.
* @see wifi_mesh_get_mpath_disc_timeout()
* @see wifi_mesh_get_mpath_disc_retries()
*/
-int wifi_mesh_get_mpath_flags(wifi_mesh_mpath_info_h mpath, unsigned char* flags);
+int wifi_mesh_get_mpath_flags(wifi_mesh_mpath_info_h mpath,
+ unsigned char* flags);
/**
* @brief Sets network device interface name.
- * @details This function provides the ability to manually select interfaces for advanced users.
+ * @details This function provides the ability to manually select interfaces for
+ * advanced users.
*
* @since_tizen 5.0
*
*
* @since_tizen 5.0
*
- * @remarks The @meshconf should be released using wifi_mesh_destroy_meshconf_info().
+ * @remarks The @a 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
* @see wifi_mesh_get_meshconf_info()
*
*/
-int wifi_mesh_destroy_meshconf_info(wifi_mesh_meshconf_info_h meshconf);
+int wifi_mesh_destroy_meshconf_info(
+ wifi_mesh_meshconf_info_h meshconf);
/**
* @brief Gets the retry timeout value of Mesh Configuration.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_retry_timeout(wifi_mesh_meshconf_info_h meshconf,
- unsigned short *retry_timeout);
+int wifi_mesh_get_meshconf_retry_timeout(
+ wifi_mesh_meshconf_info_h meshconf, unsigned short *retry_timeout);
/**
* @brief Gets the HWMP (Hybrid Wireless Mesh Protocol) Max PREQ Retries.
*
*/
-int wifi_mesh_get_meshconf_hwmp_max_preq_retries(wifi_mesh_meshconf_info_h meshconf,
- unsigned char *hwmp_max_preq_retries);
+int wifi_mesh_get_meshconf_hwmp_max_preq_retries(
+ wifi_mesh_meshconf_info_h meshconf, unsigned char *hwmp_max_preq_retries);
/**
* @brief Gets the Confirm Timeout.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_confirm_timeout(wifi_mesh_meshconf_info_h meshconf,
- unsigned short *confirm_timeout);
+int wifi_mesh_get_meshconf_confirm_timeout(
+ wifi_mesh_meshconf_info_h meshconf, unsigned short *confirm_timeout);
/**
* @brief Gets the Path Refresh Time.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_path_refresh_time(wifi_mesh_meshconf_info_h meshconf,
- unsigned int *path_refresh_time);
+int wifi_mesh_get_meshconf_path_refresh_time(
+ wifi_mesh_meshconf_info_h meshconf, unsigned int *path_refresh_time);
/**
* @brief Gets the Holding Timeout.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_holding_timeout(wifi_mesh_meshconf_info_h meshconf,
- unsigned short *holding_timeout);
+int wifi_mesh_get_meshconf_holding_timeout(
+ wifi_mesh_meshconf_info_h meshconf, unsigned short *holding_timeout);
/**
* @brief Gets the Minimum Discovery Timeout.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_min_disc_timeout(wifi_mesh_meshconf_info_h meshconf,
- unsigned short *min_disc_timeout);
+int wifi_mesh_get_meshconf_min_disc_timeout(
+ wifi_mesh_meshconf_info_h meshconf, unsigned short *min_disc_timeout);
/**
* @brief Gets the Max Peer Links.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_max_peer_links(wifi_mesh_meshconf_info_h meshconf,
- unsigned short *max_peer_links);
+int wifi_mesh_get_meshconf_max_peer_links(
+ wifi_mesh_meshconf_info_h meshconf, unsigned short *max_peer_links);
/**
* @brief Gets the HWMP (Hybrid Wireless Mesh Protocol) PREQ Minimum Interval.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_hwmp_preq_min_interval(wifi_mesh_meshconf_info_h meshconf,
- unsigned short *hwmp_preq_min_interval);
+int wifi_mesh_get_meshconf_hwmp_preq_min_interval(
+ wifi_mesh_meshconf_info_h meshconf, unsigned short *hwmp_preq_min_interval);
/**
* @brief Gets the TTL (Time To Live).
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_ttl(wifi_mesh_meshconf_info_h meshconf, unsigned char *ttl);
+int wifi_mesh_get_meshconf_ttl(wifi_mesh_meshconf_info_h meshconf,
+ unsigned char *ttl);
/**
* @brief Gets the HWMP (Hybrid Wireless Mesh Protocol) Active Path Timeout.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_hwmp_active_path_timeout(wifi_mesh_meshconf_info_h meshconf,
- unsigned int *hwmp_active_path_timeout);
+int wifi_mesh_get_meshconf_hwmp_active_path_timeout(
+ wifi_mesh_meshconf_info_h meshconf, unsigned int *hwmp_active_path_timeout);
/**
* @brief Gets the Element TTL (Time To Live).
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_element_ttl(wifi_mesh_meshconf_info_h meshconf,
- unsigned char *element_ttl);
+int wifi_mesh_get_meshconf_element_ttl(
+ wifi_mesh_meshconf_info_h meshconf, unsigned char *element_ttl);
/**
* @brief Gets the HWMP RANN (Root Announcement) Interval.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_hwmp_rann_interval(wifi_mesh_meshconf_info_h meshconf,
- unsigned short *hwmp_rann_interval);
+int wifi_mesh_get_meshconf_hwmp_rann_interval(
+ wifi_mesh_meshconf_info_h meshconf, unsigned short *hwmp_rann_interval);
/**
* @brief Gets the Gate Announcement value.
* @see wifi_mesh_destroy_meshconf_info()
*
*/
-int wifi_mesh_get_meshconf_gate_announcements(wifi_mesh_meshconf_info_h meshconf,
- unsigned char *gate_announcements);
+int wifi_mesh_get_meshconf_gate_announcements(
+ wifi_mesh_meshconf_info_h meshconf, unsigned char *gate_announcements);
/**
* @}
projects / platform / core / api / wifi-mesh.git / commitdiff