|
31 | 31 | <tbody> |
32 | 32 | <tr id="projectrow"> |
33 | 33 | <td id="projectalign"> |
34 | | - <div id="projectname">coreHTTP<span id="projectnumber"> v3.1.1</span> |
| 34 | + <div id="projectname">coreHTTP<span id="projectnumber"> v3.1.2</span> |
35 | 35 | </div> |
36 | 36 | <div id="projectbrief">HTTP/1.1 Client Library</div> |
37 | 37 | </td> |
|
114 | 114 | <tr class="memdesc:ad588638704f5bfbc30bc56f971dba343"><td class="mdescLeft"> </td><td class="mdescRight">The HTTP header "User-Agent" value. <br /></td></tr> |
115 | 115 | <tr class="separator:ad588638704f5bfbc30bc56f971dba343"><td class="memSeparator" colspan="2"> </td></tr> |
116 | 116 | <tr class="memitem:a909c2c6f89016b92bd848527f671e8f2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="core__http__config__defaults_8h.html#a909c2c6f89016b92bd848527f671e8f2">HTTP_RECV_RETRY_TIMEOUT_MS</a>   ( 10U )</td></tr> |
117 | | -<tr class="memdesc:a909c2c6f89016b92bd848527f671e8f2"><td class="mdescLeft"> </td><td class="mdescRight">The maximum duration between non-empty network reads while receiving an HTTP response via the <a class="el" href="core__http__client_8c.html#aa33b3334128496487d820f0da7ae5601" title="Send the request headers in HTTPRequestHeaders_t.pBuffer and request body in pRequestBodyBuf over the...">HTTPClient_Send</a> API function. <br /></td></tr> |
| 117 | +<tr class="memdesc:a909c2c6f89016b92bd848527f671e8f2"><td class="mdescLeft"> </td><td class="mdescRight">The maximum duration between non-empty network reads while receiving an HTTP response via the <a class="el" href="core__http__client_8c.html#abe7bfa9af16125ebf1af6f45c099dfc7" title="Receive the HTTP response from the network and parse it.">HTTPClient_ReceiveAndParseHttpResponse</a> API function. <br /></td></tr> |
118 | 118 | <tr class="separator:a909c2c6f89016b92bd848527f671e8f2"><td class="memSeparator" colspan="2"> </td></tr> |
119 | 119 | <tr class="memitem:ae498a6815f6925b8283ce0babc101946"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="core__http__config__defaults_8h.html#ae498a6815f6925b8283ce0babc101946">HTTP_SEND_RETRY_TIMEOUT_MS</a>   ( 10U )</td></tr> |
120 | 120 | <tr class="memdesc:ae498a6815f6925b8283ce0babc101946"><td class="mdescLeft"> </td><td class="mdescRight">The maximum duration between non-empty network transmissions while sending an HTTP request via the <a class="el" href="core__http__client_8c.html#aa33b3334128496487d820f0da7ae5601" title="Send the request headers in HTTPRequestHeaders_t.pBuffer and request body in pRequestBodyBuf over the...">HTTPClient_Send</a> API function. <br /></td></tr> |
@@ -167,10 +167,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#a909c2c6f89016b92bd848527 |
167 | 167 | </table> |
168 | 168 | </div><div class="memdoc"> |
169 | 169 |
|
170 | | -<p>The maximum duration between non-empty network reads while receiving an HTTP response via the <a class="el" href="core__http__client_8c.html#aa33b3334128496487d820f0da7ae5601" title="Send the request headers in HTTPRequestHeaders_t.pBuffer and request body in pRequestBodyBuf over the...">HTTPClient_Send</a> API function. </p> |
| 170 | +<p>The maximum duration between non-empty network reads while receiving an HTTP response via the <a class="el" href="core__http__client_8c.html#abe7bfa9af16125ebf1af6f45c099dfc7" title="Receive the HTTP response from the network and parse it.">HTTPClient_ReceiveAndParseHttpResponse</a> API function. </p> |
171 | 171 | <p>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.</p> |
172 | | -<p>If the timeout expires, the <a class="el" href="core__http__client_8c.html#aa33b3334128496487d820f0da7ae5601" title="Send the request headers in HTTPRequestHeaders_t.pBuffer and request body in pRequestBodyBuf over the...">HTTPClient_Send</a> function will return <a class="el" href="group__http__enum__types.html#gga39fad9050063a355ffd95e95381e743fa59fa581a112b1994db1c45d8a7f84160" title="A network error was returned from the transport interface.">HTTPNetworkError</a>.</p> |
173 | | -<p>If <a class="el" href="struct_h_t_t_p_response__t.html#ac6001c06fdaae311c3ddf859b9b3a3ce" title="Optional callback for getting the system time.">HTTPResponse_t.getTime</a> is set to NULL, then this HTTP_RECV_RETRY_TIMEOUT_MS is unused. When this timeout is unused, <a class="el" href="core__http__client_8c.html#aa33b3334128496487d820f0da7ae5601" title="Send the request headers in HTTPRequestHeaders_t.pBuffer and request body in pRequestBodyBuf over the...">HTTPClient_Send</a> will not retry the transport receive calls that return zero bytes read.</p> |
| 172 | +<p>If the timeout expires, the <a class="el" href="core__http__client_8c.html#abe7bfa9af16125ebf1af6f45c099dfc7" title="Receive the HTTP response from the network and parse it.">HTTPClient_ReceiveAndParseHttpResponse</a> function will return <a class="el" href="group__http__enum__types.html#gga39fad9050063a355ffd95e95381e743fa59fa581a112b1994db1c45d8a7f84160" title="A network error was returned from the transport interface.">HTTPNetworkError</a>.</p> |
| 173 | +<p>If <a class="el" href="struct_h_t_t_p_response__t.html#ac6001c06fdaae311c3ddf859b9b3a3ce" title="Optional callback for getting the system time.">HTTPResponse_t.getTime</a> is set to NULL, then this HTTP_RECV_RETRY_TIMEOUT_MS is unused. When this timeout is unused, <a class="el" href="core__http__client_8c.html#abe7bfa9af16125ebf1af6f45c099dfc7" title="Receive the HTTP response from the network and parse it.">HTTPClient_ReceiveAndParseHttpResponse</a> will not retry the transport receive calls that return zero bytes read.</p> |
174 | 174 | <p><b>Possible values:</b> Any positive 32 bit integer. A small timeout value is recommended. <br /> |
175 | 175 | <b>Default value:</b> <code>10</code> </p> |
176 | 176 |
|
|
0 commit comments