Skip to content

Commit 69404c8

Browse files
docs(esp_http_client): document default timeout behaviour
1 parent 4e03698 commit 69404c8

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

components/esp_http_client/include/esp_http_client.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ typedef struct {
182182
#endif
183183
const char *user_agent; /*!< The User Agent string to send with HTTP requests */
184184
esp_http_client_method_t method; /*!< HTTP Method */
185-
int timeout_ms; /*!< Network timeout in milliseconds */
185+
int timeout_ms; /*!< Network timeout in milliseconds. 0 defaults to 5 seconds */
186186
bool disable_auto_redirect; /*!< Disable HTTP automatic redirects */
187187
int max_redirection_count; /*!< Max number of redirections on receiving HTTP redirect status code, using default value if zero*/
188188
int max_authorization_retries; /*!< Max connection retries on receiving HTTP unauthorized status code, using default value if zero. Disables authorization retry if -1*/

0 commit comments

Comments
 (0)