Function esp_idf_sys::wifi_prov_mgr_stop_provisioning
source ยท pub unsafe extern "C" fn wifi_prov_mgr_stop_provisioning()
Expand description
@brief Stop provisioning service
If provisioning service is active, this API will initiate a process to stop the service and return. Once the service actually stops, the event WIFI_PROV_END will be emitted.
If wifi_prov_mgr_deinit() is called without calling this API first, it will automatically stop the provisioning service and emit the WIFI_PROV_END, followed by WIFI_PROV_DEINIT, before returning.
This API will generally be used along with wifi_prov_mgr_disable_auto_stop() in the scenario when the main application has registered its own endpoints, and wishes that the provisioning service is stopped only when some protocomm command from the client side application is received.
Calling this API inside an endpoint handler, with sufficient cleanup_delay, will allow the response / acknowledgment to be sent successfully before the underlying protocomm service is stopped.
Cleaup_delay is set when calling wifi_prov_mgr_disable_auto_stop(). If not specified, it defaults to 1000ms.
For straightforward cases, using this API is usually not necessary as
provisioning is stopped automatically once WIFI_PROV_CRED_SUCCESS is emitted.
Stopping is delayed (maximum 30 seconds) thus allowing the client side
application to query for Wi-Fi state, i.e. after receiving the first query
and sending Wi-Fi state connected
response the service is stopped immediately.