/**
* @brief Initializes Wi-Fi Aware
* @since_tizen 6.0
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
- * @retval #WIFI_AWARE_ERROR_ALREADY_INITIALIZED
- * @see wifi_aware_deinitialize()
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
+ * @retval #WIFI_AWARE_ERROR_ALREADY_INITIALIZED
+ * @see wifi_aware_deinitialize()
*/
int wifi_aware_initialize();
/**
* @brief Deinitializes Wi-Fi Aware
* @since_tizen 6.0
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
- * @see wifi_aware_initialize()
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
+ * @see wifi_aware_initialize()
*/
int wifi_aware_deinitialize();
* @brief Creates a Publish request.
* @since_tizen 6.0
* @param[out] publish The Wi-Fi Aware Publish handle.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
- * @see wifi_aware_publish_destroy()
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
+ * @see wifi_aware_publish_destroy()
*/
int wifi_aware_publish_create(wifi_aware_publish_h *publish);
/**
* @brief Destroys a Publish request.
* @since_tizen 6.0
- * @param[in] publish The Wi-Fi Aware Publish handle.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
- * @see wifi_aware_publish_create()
+ * @param[in] publish The Wi-Fi Aware Publish handle.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
+ * @see wifi_aware_publish_create()
*/
int wifi_aware_publish_destroy(wifi_aware_publish_h publish);
/**
* @brief Creates a Subscribe request.
* @since_tizen 6.0
- * @param[out] subscribe The Wi-Fi Aware Subscribe handle.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
- * @see wifi_aware_subscribe_destroy()
+ * @param[out] subscribe The Wi-Fi Aware Subscribe handle.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
+ * @see wifi_aware_subscribe_destroy()
*/
int wifi_aware_subscribe_create(wifi_aware_subscribe_h *subscribe);
* @brief Destroys a Subscribe request.
* @since_tizen 6.0
* @param[in] subscribe The Wi-Fi Aware Subscribe handle.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
- * @see wifi_aware_subscribe_create()
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
+ * @see wifi_aware_subscribe_create()
*/
int wifi_aware_subscribe_destroy(wifi_aware_subscribe_h subscribe);
/**
* @brief Sets TTL(Time To Live) for Publish session.
* @since_tizen 6.0
- * @param[in] publish The Wi-Fi Aware Publish handle.
- * @param[in] ttl The lifetime(seconds) of publish session. 0 means forever until canceled.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] publish The Wi-Fi Aware Publish handle.
+ * @param[in] ttl The lifetime(seconds) of publish session. 0 means forever until canceled.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_publish_create()
*/
int wifi_aware_publish_set_ttl(wifi_aware_publish_h publish, unsigned short ttl);
/**
* @brief Sets the type of the service as solicited or unsolicited.
* @since_tizen 6.0
- * @param[in] publish The Wi-Fi Aware Publish handle
- * @param[in] publish_type The Publish type
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] publish The Wi-Fi Aware Publish handle
+ * @param[in] publish_type The Publish type
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_publish_create()
*/
int wifi_aware_publish_set_type(wifi_aware_publish_h publish, wifi_aware_publish_type_e publish_type);
* @brief Sets the name of the service.
* @since_tizen 6.0
* @remark The length should be less than or equal to 255.
- * @param[in] publish The Wi-Fi Aware Publish handle
- * @param[in] service_name UTF-8 name which identifies the service
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] publish The Wi-Fi Aware Publish handle
+ * @param[in] service_name UTF-8 name which identifies the service
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_publish_create()
*/
int wifi_aware_publish_set_service_name(wifi_aware_publish_h publish, const char *service_name);
/**
* @brief Sets the specific information for the service.
* @since_tizen 6.0
- * @param[in] publish The Wi-Fi Aware Publish handle
- * @param[in] service_specific_info The Sequence of values that are conveyed in the Publish message
- * @param[in] len The length of service specific information
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] publish The Wi-Fi Aware Publish handle
+ * @param[in] service_specific_info The Sequence of values that are conveyed in the Publish message
+ * @param[in] len The length of service specific information
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_publish_create()
*/
int wifi_aware_publish_set_service_specific_info(wifi_aware_publish_h publish, const unsigned char *service_specific_info, size_t len);
/**
* @brief Sets the match filter of the service.
* @since_tizen 6.0
- * @param[in] publish The Wi-Fi Aware Publish handle
- * @param[in] match_filter An ordered sequence of <length, value> pairs
- * @param[in] len The whole length of match_filter
+ * @param[in] publish The Wi-Fi Aware Publish handle
+ * @param[in] match_filter An ordered sequence of <length, value> pairs
+ * @param[in] len The whole length of match_filter
* @remark The match filter is used to decide whether accepting a subscribe request or not.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_publish_create()
*/
int wifi_aware_publish_set_match_filter(wifi_aware_publish_h publish, const unsigned char *match_filter, size_t len);
/**
* @brief Sets whether the ranging function is supported or not.
* @since_tizen 6.0
- * @param[in] publish The Wi-Fi Aware Publish handle
- * @param[in] enable @c ture if ranging is enabled,
- * otherwise @c false if ranging is disabled.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] publish The Wi-Fi Aware Publish handle
+ * @param[in] enable @c ture if ranging is enabled,
+ * otherwise @c false if ranging is disabled.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_publish_create()
*/
int wifi_aware_publish_enable_ranging(wifi_aware_publish_h publish, bool enable);
/**
* @brief Sets TTL(Time To Live) for Subscribe session.
* @since_tizen 6.0
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] ttl The lifetime(seconds) of subscribe session.\n
- * 0 means forever until wifi_aware_service_discovered_cb.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] ttl The lifetime(seconds) of subscribe session.\n
+ * 0 means forever until wifi_aware_service_discovered_cb.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_subscrbie_create()
*/
int wifi_aware_subscribe_set_ttl(wifi_aware_subscribe_h subscribe, unsigned short ttl);
/**
* @brief Sets the type of the service as passive or active.
* @since_tizen 6.0
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] subscribe_type The Subscribe type
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] subscribe_type The Subscribe type
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_subscrbie_create()
*/
int wifi_aware_subscribe_set_type(wifi_aware_subscribe_h subscribe, wifi_aware_subscribe_type_e subscribe_type);
/**
* @brief Sets the name of the service.
* @since_tizen 6.0
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] service_name UTF-8 name which identifies the service
- * @remark The length should be less than or equal to 255
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] service_name UTF-8 name which identifies the service
+ * @remark The length should be less than or equal to 255
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_subscrbie_create()
*/
int wifi_aware_subscribe_set_service_name(wifi_aware_subscribe_h subscribe, const char *service_name);
/**
* @brief Sets the specific information for the service.
* @since_tizen 6.0
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] service_specific_info The Sequence of values that are conveyed in the Subscribe message
- * @param[in] len The length of service specific information
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] service_specific_info The Sequence of values that are conveyed in the Subscribe message
+ * @param[in] len The length of service specific information
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_subscrbie_create()
*/
int wifi_aware_subscribe_set_service_specific_info(wifi_aware_subscribe_h subscribe, const unsigned char *service_specific_info, size_t len);
/**
* @brief Sets the match filter of the service.
* @since_tizen 6.0
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] match_filter An ordered sequence of <length, value> pairs
- * @param[in] len The whole length of match_filter
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] match_filter An ordered sequence of <length, value> pairs
+ * @param[in] len The whole length of match_filter
* @remark The match filter is used to decide whether accepting a subscribe request or not.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_subscrbie_create()
*/
int wifi_aware_subscribe_set_match_filter(wifi_aware_subscribe_h subscribe, const unsigned char *match_filter, size_t len);
/**
* @brief Sets the maximum distance between the found services
* @since_tizen 6.0
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] distance The max distance between found services
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] distance The max distance between found services
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_subscrbie_create()
*/
int wifi_aware_subscribe_set_max_distance(wifi_aware_subscribe_h subscribe, int distance);
/**
* @brief Sets the minimum distance between the found services
* @since_tizen 6.0
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] distance The min distance between found services
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] distance The min distance between found services
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_subscrbie_create()
*/
int wifi_aware_subscribe_set_min_distance(wifi_aware_subscribe_h subscribe, int distance);
/**
* @brief Called when Wi-Fi Aware is enabled.
* @since_tizen 6.0
- * @param[in] error The error code
- * @param[in] user_data The user data passed from the request function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] error The error code
+ * @param[in] user_data The user data passed from the request function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_enable()
*/
typedef void(*wifi_aware_enabled_cb)(wifi_aware_error_e error, void *user_data);
* @brief Enables Wi-Fi Aware functions.
* @remarks If the enable request is sucessfully done, the application can get the MAC address.
* @since_tizen 6.0
- * @param[in] callback The result of enable request is asynchrously delivered
- * @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] callback The result of enable request is asynchrously delivered
+ * @param[in] user_data The user data passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_disable()
*/
int wifi_aware_enable(wifi_aware_enabled_cb callback, void *user_data);
/**
* @brief Creates the Wi-Fi Aware Session.
* @since_tizen 6.0
- * @param[in] session_type The type of session
- * @param[out] session The Wi-Fi Aware Session handle that is newly created on success
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session_type The type of session
+ * @param[out] session The Wi-Fi Aware Session handle that is newly created on success
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_destroy()
*/
int wifi_aware_session_create(wifi_aware_session_type_e session_type, wifi_aware_session_h *session);
/**
* @brief Destroies the Wi-Fi Aware Session.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_create()
*/
int wifi_aware_session_destroy(wifi_aware_session_h session);
/**
* @brief Called when the Wi-Fi Aware Session has been lost.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] reason The reason of termination
- * @param[in] user_data The user data passed from request function
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] reason The reason of termination
+ * @param[in] user_data The user data passed from request function
* @see wifi_aware_session_set_terminated_cb()
* @see wifi_aware_session_unset_terminated_cb()
*/
typedef void(*wifi_aware_session_terminated_cb)(wifi_aware_session_h session,
- wifi_aware_termination_reason_e reason, void *user_data);
+ wifi_aware_termination_reason_e reason, void *user_data);
/**
* @brief Registers a callback function to notify session is terminated.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session
- * @param[in] callback The callback function to register
- * @param[in] user_data The user data to be passed to the callback function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session
+ * @param[in] callback The callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_unset_terminated_cb()
*/
int wifi_aware_session_set_terminated_cb(wifi_aware_session_h session,
- wifi_aware_session_terminated_cb callback, void *user_data);
+ wifi_aware_session_terminated_cb callback, void *user_data);
/**
* @brief Unregisters the session terminated callback function.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_set_terminated_cb()
*/
int wifi_aware_session_unset_terminated_cb(wifi_aware_session_h session);
/**
* @brief Stops a Wi-Fi Aware session.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] session The Wi-Fi Aware Session handle
* @remark The function of the session, Publish or Subscribe, will be cancelled.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_publish()
* @see wifi_aware_session_subscribe()
*/
/**
* @brief Called when publish request is finished.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] error The error code
- * @param[in] user_data The user data passed from request function
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] error The error code
+ * @param[in] user_data The user data passed from request function
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_publish()
* @see wifi_aware_session_update_publish()
*/
/**
* @brief Publishes a Wi-Fi Aware service so that neighboring devices can find it.
* @since_tizen 6.0
- * @param[in] sesssion The Wi-Fi Aware Session handle
- * @param[in] publish The Wi-Fi Aware Publish handle
- * @param[in] callback The callback which gets called when a service is published
- * @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] sesssion The Wi-Fi Aware Session handle
+ * @param[in] publish The Wi-Fi Aware Publish handle
+ * @param[in] callback The callback which gets called when a service is published
+ * @param[in] user_data The user data passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_stop()
*/
int wifi_aware_session_publish(wifi_aware_session_h session,
/**
* @brief Updates the configuration for a Wi-Fi Aware service that has already been published.
* @since_tizen 6.0
- * @param[in] sesssion The Wi-Fi Aware Session handle
- * @param[in] publish The Wi-Fi Aware Publish handle
- * @param[in] callback The callback which gets called when a service is updated
- * @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] sesssion The Wi-Fi Aware Session handle
+ * @param[in] publish The Wi-Fi Aware Publish handle
+ * @param[in] callback The callback which gets called when a service is updated
+ * @param[in] user_data The user data passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_publish()
*/
int wifi_aware_session_update_publish(wifi_aware_session_h session,
/**
* @brief Called when Subscribe request is finished.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] error The error code
- * @param[in] user_data The user data passed from request function
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] error The error code
+ * @param[in] user_data The user data passed from request function
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_subscribe()
*/
typedef void(*wifi_aware_subscribed_cb)(wifi_aware_session_h session,
/**
* @brief Starts to find Wi-Fi Aware services.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] callback The callback which get called when request is finished
- * @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] callback The callback which get called when request is finished
+ * @param[in] user_data The user data passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_stop()
*/
int wifi_aware_session_subscribe(wifi_aware_session_h,
/**
* @brief Updates the configuration for a Wi-Fi Aware service that has already been subscribed.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] subscribe The Wi-Fi Aware Subscribe handle
- * @param[in] callback The callback which gets called when service is updated
- * @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] subscribe The Wi-Fi Aware Subscribe handle
+ * @param[in] callback The callback which gets called when service is updated
+ * @param[in] user_data The user data passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_subscribe()
*/
int wifi_aware_session_update_subscribe(wifi_aware_session_h session,
* @brief Called whenever a matched service for the subscribe configurations is found.
* @since_tizen 6.0
* @remkar If ranging is not supported or not enabled, @a distance would be 0.
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] peer The found Peer information
- * @param[in] service_specific_info Sequence of octets which were received from published service
- * @param[in] service_specific_info_len The length of @a service_specific_info
- * @param[in] distance The distance to the peer
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] peer The found Peer information
+ * @param[in] service_specific_info Sequence of octets which were received from published service
+ * @param[in] service_specific_info_len The length of @a service_specific_info
+ * @param[in] distance The distance to the peer
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_set_service_discovered_cb()
* @see wifi_aware_session_unset_service_discovered_cb()
*/
/**
* @brief Registers a callback function to notify a service is discovered.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] callback The callback function to register
- * @param[in] user_data The user data to be passed to the callback function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] callback The callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_unset_service_discovered_cb()
*/
int wifi_aware_session_set_service_discovered_cb(wifi_aware_session_h session,
/**
* @brief Unregisters the service discovered callback function.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_set_service_discovered_cb()
*/
int wifi_aware_session_unset_service_discovered_cb(wifi_aware_session_h session);
/**
* @brief Called when a message is sent to a peer.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] error The error code
- * @param[in] user_data The user data passed from request function
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] error The error code
+ * @param[in] user_data The user data passed from request function
*/
typedef void(*wifi_aware_send_message_result_cb)(wifi_aware_session_h session,
wifi_aware_error_e error, void *user_data);
/**
* @brief Sends the message to a peer
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] peer The peer who gets the message
- * @param[in] message The message sent to a peer
- * @param[in] len The length of the message
- * @param[in] callback The callback function
- * @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] peer The peer who gets the message
+ * @param[in] message The message sent to a peer
+ * @param[in] len The length of the message
+ * @param[in] callback The callback function
+ * @param[in] user_data The user data passed to the callback function
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
*/
int wifi_aware_session_send_message(
wifi_aware_session_h session,
/**
* @brief Called whenever receiving a message from a peer.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] peer The peer who sent the message
- * @param[in] message The message which is sent
- * @param[in] len The length of the message
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] peer The peer who sent the message
+ * @param[in] message The message which is sent
+ * @param[in] len The length of the message
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_set_message_received_cb()
* @see wifi_aware_session_unset_message_received_cb()
*/
/**
* @brief Registers a callback function to deliver received message from a peer.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] callback The callback function which gets called
- * @param[in] user_data The user data paseed to @a callback
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] callback The callback function which gets called
+ * @param[in] user_data The user data paseed to @a callback
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_unset_message_received_cb()
*/
int wifi_aware_session_set_message_received_cb(wifi_aware_session_h session,
/**
* @brief Unregisters a callback function for received message.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_session_set_message_received_cb()
*/
int wifi_aware_session_unset_message_received_cb(wifi_aware_session_h session);
/**
* @brief Copies a Peer handle.
* @since_tizen 6.0
- * @param[out] cloned The Peer handle copied from @a origin
- * @param[in] origin The origin Peer handle
+ * @param[out] cloned The Peer handle copied from @a origin
+ * @param[in] origin The origin Peer handle
* @remark The cloned Peer handle has to be freed by wifi_aware_peer_destroy()
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_peer_destroy()
*/
int wifi_aware_peer_clone(wifi_aware_peer_h *cloned, wifi_aware_peer_h origin);
/**
* @brief Destroys a Peer handle
* @since_tizen 6.0
- * @param[in] peer The Peer handle
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] peer The Peer handle
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_peer_clone()
*/
int wifi_aware_peer_destroy(wifi_aware_peer_h peer);
* @brief Gets the MAC address (NAN Management Interface) of Wi-Fi Aware peer.
* @remarks @a mac should be freed using free().
* @since_tizen 6.0
- * @param[in] peer The Peer handle
- * @param[out] mac The MAC address of the peer
- * @return 0 on success, otherwise a negative error value
+ * @param[in] peer The Peer handle
+ * @param[out] mac The MAC address of the peer
+ * @return 0 on success, otherwise a negative error value
*/
int wifi_aware_peer_get_mac(wifi_aware_peer_h peer, unsigned char **mac);
/**
* @brief Creates a handle to be used for Wi-Fi Aware Data Path.
* @since_tizen 6.0
- * @param[in] session The Wi-Fi Aware Session handle
- * @param[in] peer The Peer handle
- * @param[out] data_path The Data Path handle
- * @return 0 on success, otherwise a negative error value
+ * @param[in] session The Wi-Fi Aware Session handle
+ * @param[in] peer The Peer handle
+ * @param[out] data_path The Data Path handle
+ * @return 0 on success, otherwise a negative error value
* @see wifi_aware_data_path_destroy()
*/
int wifi_aware_data_path_create(wifi_aware_session_h session, wifi_aware_peer_h peer,
/**
* @brief Sets a security type for Wi-Fi Aware Data Path.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @param[in] security_type The security type
- * @return 0 on success, otherwise a negative error value
+ * @param[in] data_path The Data Path handle
+ * @param[in] security_type The security type
+ * @return 0 on success, otherwise a negative error value
* @see wifi_aware_data_path_create()
*/
int wifi_aware_data_path_set_security(wifi_aware_data_path_h data_path, wifi_aware_security_type_e security_type);
* @brief Sets a passphrase for Wi-Fi Aware Data Path.
* @since_tizen 6.0
* @param[in] data_path The Data Path handle
- * @param[in] key The passphrase
+ * @param[in] key The passphrase
* @remark @a key can be used only when secury type is WIFI_AWARE_SECURITY_TYPE_PSK.
- * @return 0 on success, otherwise a negative error value
+ * @return 0 on success, otherwise a negative error value
* @see wifi_aware_data_path_create()
*/
int wifi_aware_data_path_set_psk(wifi_aware_data_path_h data_path, const char *key);
* @brief Sets a PMK for Wi-Fi Aware Data Path.
* @since_tizen 6.0
* @remkar @key can be used only when security type is WIFI_AWARE_SECURITY_TYPE_PMK.
- * @param[in] data_path
- * @param[in] key Pairwise Master Key. Its length shall be of length 32.
- * @return 0 on success, otherwise a negative error value
+ * @param[in] data_path The Data Path handle
+ * @param[in] key Pairwise Master Key. Its length shall be of length 32.
+ * @return 0 on success, otherwise a negative error value
* @see wifi_aware_data_path_create()
*/
int wifi_aware_data_path_set_pmk(wifi_aware_data_path_h data_path, const unsigned char *key);
/**
* @brief Sets a port for Wi-Fi Aware Data Path.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @param[in] port The port
+ * @param[in] data_path The Data Path handle
+ * @param[in] port The port
* @remarks This is only for Data Path Responder.\n
- * @a port cannot be exceed 65535.
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @a port cannot be exceed 65535.
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
* @see wifi_aware_data_path_create()
*/
int wifi_aware_data_path_set_port(wifi_aware_data_path_h data_path, int port);
-// We are considering to add wifi_aware_data_path_set_ip_address().
-
/**
* @brief Destroys a handle for Wi-Fi Aware Data Path.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @return 0 on success, otherwise a negative error value
+ * @param[in] data_path The Data Path handle
+ * @return 0 on success, otherwise a negative error value
* @see wifi_aware_data_path_create()
*/
int wifi_aware_data_path_destroy(wifi_aware_data_path_h data_path);
-
/**
* @brief Called when Data Path open request is done.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @param[in] error The result of the open request
- * @param[in] mac The peer's NDI (NAN Data Interface)
- * @param[in] user_data The user data passed from request function
+ * @param[in] data_path The Data Path handle
+ * @param[in] error The result of the open request
+ * @param[in] mac The peer's NDI (NAN Data Interface)
+ * @param[in] user_data The user data passed from request function
* @see wifi_aware_data_path_open()
*/
typedef void(*wifi_aware_data_path_open_cb)(wifi_aware_data_path_h data_path, wifi_aware_error_e error,
* @brief Starts to open a Wi-Fi Aware Data Path.
* @remarks The @a callback will be always invoked whether the open request succeeds or fails.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @param[in] callback The callback function
- * @param[in] user_data The user data passed to the callback function
- * @return 0 on success, otherwise a negative error value
+ * @param[in] data_path The Data Path handle
+ * @param[in] callback The callback function
+ * @param[in] user_data The user data passed to the callback function
+ * @return 0 on success, otherwise a negative error value
* @see wifi_aware_data_path_close()
*/
int wifi_aware_data_path_open(wifi_aware_data_path_h data_path,
/**
* @brief Closes a Wi-Fi Aware Data Path.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
+ * @param[in] data_path The Data Path handle
* @see wifi_aware_data_path_open()
*/
int wifi_aware_data_path_close(wifi_aware_data_path_h data_path);
* @brief Gets a port of a peer.
* @remarks This is only for Data Path Initiator.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @param[out] port The port
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] data_path The Data Path handle
+ * @param[out] port The port
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
*/
int wifi_aware_data_path_get_peer_port(wifi_aware_data_path_h data_path, int* port);
/**
* @brief Gets an IPv6 address of a peer
- * @remarks This is only for Data Path Initiator.
- * @remarks @a ipv6_address should be freed by using free().
+ * @remarks This is only for Data Path Initiator.\n
+ * @a ipv6_address should be freed by using free().
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @param[out] ipv6_address The IPv6 address of a peer
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] data_path The Data Path handle
+ * @param[out] ipv6_address The IPv6 address of a peer
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
*/
int wifi_aware_data_path_get_peer_ipv6_address(wifi_aware_data_path_h data_path, char **ipv6_address);
* @brief Gets Interface name for Wi-Fi Aware Data Path
* @remarks @a interface should be freed by using free().
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @param[out] interface The interface name
- * @return 0 on success, otherwise a negative error value
- * @retval #WIFI_AWARE_ERROR_NONE
+ * @param[in] data_path The Data Path handle
+ * @param[out] interface The interface name
+ * @return 0 on success, otherwise a negative error value
+ * @retval #WIFI_AWARE_ERROR_NONE
*/
int wifi_aware_data_path_get_interface(wifi_aware_data_path_h data_path, char **interface);
/**
* @brief Called when the Wi-Fi Aware Data Path has been lost.
* @since_tizen 6.0
- * @param[in] data_path The terminated Data Path handle
- * @param[in] reason The reason of termination
- * @param[in] user_data The user data passed from request function
+ * @param[in] data_path The terminated Data Path handle
+ * @param[in] reason The reason of termination
+ * @param[in] user_data The user data passed from request function
* @see wifi_aware_data_path_set_terminated_cb()
* @see wifi_aware_data_path_unset_terminated_cb()
*/
/**
* @brief Registers a callback function to notify a Data Path termination.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @param[in] callback The callback function
- * @param[in] user_data The user data paseed to the callback function
- * @return 0 on success, otherwise a negative error value
+ * @param[in] data_path The Data Path handle
+ * @param[in] callback The callback function
+ * @param[in] user_data The user data paseed to the callback function
+ * @return 0 on success, otherwise a negative error value
* @see wifi_aware_data_path_unset_terminated_cb()
*/
int wifi_aware_data_path_set_terminated_cb(wifi_aware_data_path_h data_path, wifi_aware_data_path_terminated_cb callback, void *user_data);
/**
* @brief Unregisters the Data Path terminated callback function.
* @since_tizen 6.0
- * @param[in] data_path The Data Path handle
- * @return 0 on success, otherwise a negative error value
+ * @param[in] data_path The Data Path handle
+ * @return 0 on success, otherwise a negative error value
* @see wifi_aware_data_path_set_terminated_cb()
*/
int wifi_aware_data_path_unset_terminated_cb(wifi_aware_data_path_h data_path);
projects / platform / core / api / wifi-aware.git / commitdiff