esp_wifi_sta_itwt_suspend() function

Send a TWT Information frame to AP for suspending/resuming established iTWT agreements.

Syntax

Show:

Summary

Declaration

from esp_wifi_he.h:73

esp_err_t esp_wifi_sta_itwt_suspend(int flow_id, int suspend_time_ms);

Arguments

Argument

Description

flow_id

The value range is [0, 7]. FLOW_ID_ALL indicates suspend all individual TWT agreements

suspend_time_ms

If the value is 0, indicates the specified flow_id or all established agreements will be suspended until resume by users. If the value is greater than 0, indicates the specified flow_id or all established agreements will be suspended until suspend_time_ms timeout, unit: ms.

Return value

- ESP_OK: succeed - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init - ESP_ERR_WIFI_NOT_STARTED: WiFi is not started by esp_wifi_start - ESP_ERR_WIFI_CONN: WiFi internal error, station or soft-AP control block wrong - ESP_ERR_WIFI_NOT_ASSOC: WiFi is not associated - ESP_ERR_INVALID_ARG: invalid argument

Examples

References

from examples

esp_wifi_sta_itwt_suspend() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle