Skip to content

Commit

Permalink
Fix comment in config defaults header file (#189)
Browse files Browse the repository at this point in the history
  • Loading branch information
samryanuofl authored Jan 16, 2025
1 parent 06c115a commit 822b750
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions source/include/core_http_config_defaults.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,18 +59,18 @@

/**
* @brief The maximum duration between non-empty network reads while receiving
* an HTTP response via the #HTTPClient_Send API function.
* an HTTP response via the #HTTPClient_ReceiveAndParseHttpResponse API function.
*
* The transport receive function may be called multiple times until the end of
* the response is detected by the parser. This timeout represents the maximum
* duration that is allowed without any data reception from the network for the
* incoming response.
*
* If the timeout expires, the #HTTPClient_Send function will return
* If the timeout expires, the #HTTPClient_ReceiveAndParseHttpResponse function will return
* #HTTPNetworkError.
*
* If #HTTPResponse_t.getTime is set to NULL, then this HTTP_RECV_RETRY_TIMEOUT_MS
* is unused. When this timeout is unused, #HTTPClient_Send will not retry the
* is unused. When this timeout is unused, #HTTPClient_ReceiveAndParseHttpResponse will not retry the
* transport receive calls that return zero bytes read.
*
* <b>Possible values:</b> Any positive 32 bit integer. A small timeout value
Expand Down

0 comments on commit 822b750

Please sign in to comment.