Doxygen for ba67ef0

Author: jasonpcarroll

main/core__http__client_8c.html

@@ -101,7 +101,7 @@
 </div><!--header-->
 <div class="contents">
 <a href="core__http__client__private_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
-<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * coreHTTP v3.1.1</span></div>
+<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * coreHTTP</span></div>
 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * Copyright (C) 2024 Amazon.com, Inc. or its affiliates.  All Rights Reserved.</span></div>
 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * SPDX-License-Identifier: MIT</span></div>
@@ -273,7 +273,7 @@
 <div class="ttc" id="astruct_h_t_t_p_parsing_context__t_html_ad51bd758cbd948379501c4dc9c8ac883"><div class="ttname"><a href="struct_h_t_t_p_parsing_context__t.html#ad51bd758cbd948379501c4dc9c8ac883">HTTPParsingContext_t::pBufferCur</a></div><div class="ttdeci">const char * pBufferCur</div><div class="ttdef"><b>Definition:</b> core_http_client_private.h:303</div></div>
 <div class="ttc" id="astruct_h_t_t_p_parsing_context__t_html_ad76fd5c0284963414074fad62eb0cd02"><div class="ttname"><a href="struct_h_t_t_p_parsing_context__t.html#ad76fd5c0284963414074fad62eb0cd02">HTTPParsingContext_t::isHeadResponse</a></div><div class="ttdeci">uint8_t isHeadResponse</div><div class="ttdef"><b>Definition:</b> core_http_client_private.h:301</div></div>
 <div class="ttc" id="astruct_h_t_t_p_parsing_context__t_html_ae5bdb96134074a3afd9816263445d591"><div class="ttname"><a href="struct_h_t_t_p_parsing_context__t.html#ae5bdb96134074a3afd9816263445d591">HTTPParsingContext_t::llhttpSettings</a></div><div class="ttdeci">llhttp_settings_t llhttpSettings</div><div class="ttdef"><b>Definition:</b> core_http_client_private.h:298</div></div>
-<div class="ttc" id="astruct_h_t_t_p_response__t_html"><div class="ttname"><a href="struct_h_t_t_p_response__t.html">HTTPResponse_t</a></div><div class="ttdoc">Represents an HTTP response.</div><div class="ttdef"><b>Definition:</b> core_http_client.h:470</div></div>
+<div class="ttc" id="astruct_h_t_t_p_response__t_html"><div class="ttname"><a href="struct_h_t_t_p_response__t.html">HTTPResponse_t</a></div><div class="ttdoc">Represents an HTTP response.</div><div class="ttdef"><b>Definition:</b> core_http_client.h:480</div></div>
 <div class="ttc" id="astructfind_header_context__t_html"><div class="ttname"><a href="structfind_header_context__t.html">findHeaderContext_t</a></div><div class="ttdoc">An aggregator that represents the user-provided parameters to the HTTPClient_ReadHeader API function....</div><div class="ttdef"><b>Definition:</b> core_http_client_private.h:223</div></div>
 <div class="ttc" id="astructfind_header_context__t_html_a1426be39bf89d99c7b1ae54589968e20"><div class="ttname"><a href="structfind_header_context__t.html#a1426be39bf89d99c7b1ae54589968e20">findHeaderContext_t::pValueLoc</a></div><div class="ttdeci">const char ** pValueLoc</div><div class="ttdef"><b>Definition:</b> core_http_client_private.h:226</div></div>
 <div class="ttc" id="astructfind_header_context__t_html_a6f9016d3a374fe15bcff964ecffe10dd"><div class="ttname"><a href="structfind_header_context__t.html#a6f9016d3a374fe15bcff964ecffe10dd">findHeaderContext_t::fieldLen</a></div><div class="ttdeci">size_t fieldLen</div><div class="ttdef"><b>Definition:</b> core_http_client_private.h:225</div></div>

main/core__http__client_8h.html

@@ -114,7 +114,7 @@
 <tr class="memdesc:ad588638704f5bfbc30bc56f971dba343"><td class="mdescLeft">&#160;</td><td class="mdescRight">The HTTP header "User-Agent" value.  <br /></td></tr>
 <tr class="separator:ad588638704f5bfbc30bc56f971dba343"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a909c2c6f89016b92bd848527f671e8f2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="core__http__config__defaults_8h.html#a909c2c6f89016b92bd848527f671e8f2">HTTP_RECV_RETRY_TIMEOUT_MS</a>&#160;&#160;&#160;( 10U )</td></tr>
-<tr class="memdesc:a909c2c6f89016b92bd848527f671e8f2"><td class="mdescLeft">&#160;</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>
+<tr class="memdesc:a909c2c6f89016b92bd848527f671e8f2"><td class="mdescLeft">&#160;</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>
 <tr class="separator:a909c2c6f89016b92bd848527f671e8f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae498a6815f6925b8283ce0babc101946"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="core__http__config__defaults_8h.html#ae498a6815f6925b8283ce0babc101946">HTTP_SEND_RETRY_TIMEOUT_MS</a>&#160;&#160;&#160;( 10U )</td></tr>
 <tr class="memdesc:ae498a6815f6925b8283ce0babc101946"><td class="mdescLeft">&#160;</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
       </table>
 </div><div class="memdoc">
 
-<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>
+<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>
 <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>
-<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>
-<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>
+<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>
+<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>
 <p><b>Possible values:</b> Any positive 32 bit integer. A small timeout value is recommended. <br  />
  <b>Default value:</b> <code>10</code> </p>
 

main/core__http__client_8h_source.html

@@ -101,7 +101,7 @@
 </div><!--header-->
 <div class="contents">
 <a href="core__http__config__defaults_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
-<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * coreHTTP v3.1.1</span></div>
+<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * coreHTTP</span></div>
 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * Copyright (C) 2024 Amazon.com, Inc. or its affiliates.  All Rights Reserved.</span></div>
 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * SPDX-License-Identifier: MIT</span></div>

main/core__http__client__private_8h_source.html

@@ -129,7 +129,7 @@ <h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
 
 
 <h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
-<li>getFinalResponseStatus()&#160;:&#160;<a class="el" href="core__http__client_8c.html#a7cc749a54dc2f77951341f2aa3ba8988">core_http_client.c</a></li>
+<li>getFinalResponseStatus()&#160;:&#160;<a class="el" href="core__http__client_8c.html#a56c86bc115c7a47380deaaf51b16c918">core_http_client.c</a></li>
 <li>getZeroTimestampMs()&#160;:&#160;<a class="el" href="core__http__client_8c.html#a11d42680d4c46335520d4cf2c7b4ab2d">core_http_client.c</a></li>
 </ul>
 

main/core__http__config__defaults_8h.html

@@ -121,7 +121,7 @@ <h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
 
 
 <h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
-<li>getFinalResponseStatus()&#160;:&#160;<a class="el" href="core__http__client_8c.html#a7cc749a54dc2f77951341f2aa3ba8988">core_http_client.c</a></li>
+<li>getFinalResponseStatus()&#160;:&#160;<a class="el" href="core__http__client_8c.html#a56c86bc115c7a47380deaaf51b16c918">core_http_client.c</a></li>
 <li>getZeroTimestampMs()&#160;:&#160;<a class="el" href="core__http__client_8c.html#a11d42680d4c46335520d4cf2c7b4ab2d">core_http_client.c</a></li>
 </ul>
 

main/core__http__config__defaults_8h_source.html

@@ -154,7 +154,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga227df31d6daf07e5d833537
 </div><div class="memdoc">
 
 <p>Transport interface for receiving data on the network. </p>
-<dl class="section note"><dt>Note</dt><dd>It is HIGHLY RECOMMENDED that the transport receive implementation does NOT block. coreMQTT will continue to call the transport interface if it receives a partial packet until it accumulates enough data to get the complete MQTT packet.</dd></dl>
+<dl class="section note"><dt>Note</dt><dd>It is HIGHLY RECOMMENDED that the transport receive implementation does NOT block. coreMQTT will continue to call the transport interface if it receives a partial packet until it accumulates enough data to get the complete MQTT packet. A non‐blocking implementation is also essential so that the library's inbuilt keep‐alive mechanism can work properly, given the user chooses to use that over their own keep alive mechanism.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">pNetworkContext</td><td>Implementation-defined network context. </td></tr>

main/globals.html

@@ -124,10 +124,10 @@ <h1><a class="anchor" id="HTTP_SEND_RETRY_TIMEOUT_MS"></a>
  <b>Default value:</b> <code>10</code>  </p>
 <h1><a class="anchor" id="HTTP_RECV_RETRY_TIMEOUT_MS"></a>
 HTTP_RECV_RETRY_TIMEOUT_MS</h1>
-<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>
+<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>
 <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>
-<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>
-<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>
+<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>
+<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>
 <p><b>Possible values:</b> Any positive 32 bit integer. A small timeout value is recommended. <br  />
  <b>Default value:</b> <code>10</code>  </p>
 <h1><a class="anchor" id="http_logerror"></a>