Doxygen for 68f2141

Author: felicityzhao9

_data/doc_config.json

@@ -1,6 +1,7 @@
 {
   "name": "coreHTTP Library",
   "releases": [
+    "v3.1.3",
     "v3.1.2",
     "v3.1.1",
     "v3.1.0",

latest/annotated.html

@@ -31,7 +31,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">coreHTTP<span id="projectnumber">&#160;v3.1.2</span>
+   <div id="projectname">coreHTTP<span id="projectnumber">&#160;v3.1.3</span>
    </div>
    <div id="projectbrief">HTTP/1.1 Client Library</div>
   </td>

latest/classes.html

@@ -31,7 +31,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">coreHTTP<span id="projectnumber">&#160;v3.1.2</span>
+   <div id="projectname">coreHTTP<span id="projectnumber">&#160;v3.1.3</span>
    </div>
    <div id="projectbrief">HTTP/1.1 Client Library</div>
   </td>

latest/core__http__client_8c.html

@@ -31,7 +31,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">coreHTTP<span id="projectnumber">&#160;v3.1.2</span>
+   <div id="projectname">coreHTTP<span id="projectnumber">&#160;v3.1.3</span>
    </div>
    <div id="projectbrief">HTTP/1.1 Client Library</div>
   </td>
@@ -1690,7 +1690,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab523c4d4e3b756928d463bd8
 <div class="line"> </div>
 <div class="line">httpLibraryStatus = <a class="code hl_function" href="core__http__client_8c.html#ab523c4d4e3b756928d463bd864361a9c">HTTPClient_InitializeRequestHeaders</a>( &amp;requestHeaders,</div>
 <div class="line">                                                         &amp;requestInfo );</div>
-<div class="ttc" id="acore__http__client_8c_html_ab523c4d4e3b756928d463bd864361a9c"><div class="ttname"><a href="core__http__client_8c.html#ab523c4d4e3b756928d463bd864361a9c">HTTPClient_InitializeRequestHeaders</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_InitializeRequestHeaders(HTTPRequestHeaders_t *pRequestHeaders, const HTTPRequestInfo_t *pRequestInfo)</div><div class="ttdoc">Initialize the request headers, stored in HTTPRequestHeaders_t.pBuffer, with initial configurations f...</div><div class="ttdef"><b>Definition:</b> core_http_client.c:1589</div></div>
+<div class="ttc" id="acore__http__client_8c_html_ab523c4d4e3b756928d463bd864361a9c"><div class="ttname"><a href="core__http__client_8c.html#ab523c4d4e3b756928d463bd864361a9c">HTTPClient_InitializeRequestHeaders</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_InitializeRequestHeaders(HTTPRequestHeaders_t *pRequestHeaders, const HTTPRequestInfo_t *pRequestInfo)</div><div class="ttdoc">Initialize the request headers, stored in HTTPRequestHeaders_t.pBuffer, with initial configurations f...</div><div class="ttdef"><b>Definition:</b> core_http_client.c:1595</div></div>
 <div class="ttc" id="agroup__http__constants_html_ga91faefe43f8d3577719ba174c8a5ebcd"><div class="ttname"><a href="group__http__constants.html#ga91faefe43f8d3577719ba174c8a5ebcd">HTTP_METHOD_GET</a></div><div class="ttdeci">#define HTTP_METHOD_GET</div><div class="ttdef"><b>Definition:</b> core_http_client.h:72</div></div>
 <div class="ttc" id="agroup__http__enum__types_html_ga39fad9050063a355ffd95e95381e743f"><div class="ttname"><a href="group__http__enum__types.html#ga39fad9050063a355ffd95e95381e743f">HTTPStatus_t</a></div><div class="ttdeci">HTTPStatus_t</div><div class="ttdoc">The HTTP Client library return status.</div><div class="ttdef"><b>Definition:</b> core_http_client.h:206</div></div>
 <div class="ttc" id="agroup__http__enum__types_html_gga39fad9050063a355ffd95e95381e743fa68f5addd5bf4367e177957a4c43dd4bd"><div class="ttname"><a href="group__http__enum__types.html#gga39fad9050063a355ffd95e95381e743fa68f5addd5bf4367e177957a4c43dd4bd">HTTPSuccess</a></div><div class="ttdeci">@ HTTPSuccess</div><div class="ttdoc">The HTTP Client library function completed successfully.</div><div class="ttdef"><b>Definition:</b> core_http_client.h:217</div></div>
@@ -1786,7 +1786,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a451c30912fcdf48c71f91447
 <div class="line">                                          <span class="keyword">sizeof</span>( <span class="stringliteral">&quot;Request-Header-Field&quot;</span> ) - 1U,</div>
 <div class="line">                                          <span class="stringliteral">&quot;Request-Header-Value&quot;</span>,</div>
 <div class="line">                                          <span class="keyword">sizeof</span>(<span class="stringliteral">&quot;Request-Header-Value&quot;</span>) - 1U );</div>
-<div class="ttc" id="acore__http__client_8c_html_a451c30912fcdf48c71f9144788250916"><div class="ttname"><a href="core__http__client_8c.html#a451c30912fcdf48c71f9144788250916">HTTPClient_AddHeader</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_AddHeader(HTTPRequestHeaders_t *pRequestHeaders, const char *pField, size_t fieldLen, const char *pValue, size_t valueLen)</div><div class="ttdoc">Add a header to the request headers stored in HTTPRequestHeaders_t.pBuffer.</div><div class="ttdef"><b>Definition:</b> core_http_client.c:1689</div></div>
+<div class="ttc" id="acore__http__client_8c_html_a451c30912fcdf48c71f9144788250916"><div class="ttname"><a href="core__http__client_8c.html#a451c30912fcdf48c71f9144788250916">HTTPClient_AddHeader</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_AddHeader(HTTPRequestHeaders_t *pRequestHeaders, const char *pField, size_t fieldLen, const char *pValue, size_t valueLen)</div><div class="ttdoc">Add a header to the request headers stored in HTTPRequestHeaders_t.pBuffer.</div><div class="ttdef"><b>Definition:</b> core_http_client.c:1695</div></div>
 </div><!-- fragment --> 
 </div>
 </div>
@@ -1835,7 +1835,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af91c4a57452556db2be92674
 <div class="line"> </div>
 <div class="line"><span class="comment">// Request for bytes 0 to 1023.</span></div>
 <div class="line">httpLibraryStatus = <a class="code hl_function" href="core__http__client_8c.html#af91c4a57452556db2be926743aa02b81">HTTPClient_AddRangeHeader</a>( &amp;requestHeaders, 0, 1023 );</div>
-<div class="ttc" id="acore__http__client_8c_html_af91c4a57452556db2be926743aa02b81"><div class="ttname"><a href="core__http__client_8c.html#af91c4a57452556db2be926743aa02b81">HTTPClient_AddRangeHeader</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_AddRangeHeader(HTTPRequestHeaders_t *pRequestHeaders, int32_t rangeStartOrlastNbytes, int32_t rangeEnd)</div><div class="ttdoc">Add the byte range request header to the request headers store in HTTPRequestHeaders_t....</div><div class="ttdef"><b>Definition:</b> core_http_client.c:1749</div></div>
+<div class="ttc" id="acore__http__client_8c_html_af91c4a57452556db2be926743aa02b81"><div class="ttname"><a href="core__http__client_8c.html#af91c4a57452556db2be926743aa02b81">HTTPClient_AddRangeHeader</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_AddRangeHeader(HTTPRequestHeaders_t *pRequestHeaders, int32_t rangeStartOrlastNbytes, int32_t rangeEnd)</div><div class="ttdoc">Add the byte range request header to the request headers store in HTTPRequestHeaders_t....</div><div class="ttdef"><b>Definition:</b> core_http_client.c:1755</div></div>
 </div><!-- fragment --></li>
 <li>Request for the last N bytes, represented by <code>rangeStartOrlastNbytes</code>. <code>rangeStartOrlastNbytes</code> should be negative and <code>rangeEnd</code> should be <a class="el" href="group__http__constants.html#ga4719dc6fd6e1b92739e1c3a88efa7046" title="Flag that represents End of File byte in the range specification of a Range Request....">HTTP_RANGE_REQUEST_END_OF_FILE</a>. Example request header line: <code>Range: bytes=-512\r\n</code> for requesting the last 512 bytes (or bytes in the range [512, 1023] for a 1KB sized file).<br  />
  <b>Example</b> <div class="fragment"><div class="line"><a class="code hl_enumeration" href="group__http__enum__types.html#ga39fad9050063a355ffd95e95381e743f">HTTPStatus_t</a> httpLibraryStatus = <a class="code hl_enumvalue" href="group__http__enum__types.html#gga39fad9050063a355ffd95e95381e743fa68f5addd5bf4367e177957a4c43dd4bd">HTTPSuccess</a>;</div>
@@ -2161,7 +2161,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa33b3334128496487d820f0d
 <div class="line">        <span class="comment">// Handle a response Status-Code of 200 OK.</span></div>
 <div class="line">    }</div>
 <div class="line">}</div>
-<div class="ttc" id="acore__http__client_8c_html_aa33b3334128496487d820f0da7ae5601"><div class="ttname"><a href="core__http__client_8c.html#aa33b3334128496487d820f0da7ae5601">HTTPClient_Send</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_Send(const TransportInterface_t *pTransport, HTTPRequestHeaders_t *pRequestHeaders, const uint8_t *pRequestBodyBuf, size_t reqBodyBufLen, HTTPResponse_t *pResponse, uint32_t sendFlags)</div><div class="ttdoc">Send the request headers in HTTPRequestHeaders_t.pBuffer and request body in pRequestBodyBuf over the...</div><div class="ttdef"><b>Definition:</b> core_http_client.c:2214</div></div>
+<div class="ttc" id="acore__http__client_8c_html_aa33b3334128496487d820f0da7ae5601"><div class="ttname"><a href="core__http__client_8c.html#aa33b3334128496487d820f0da7ae5601">HTTPClient_Send</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_Send(const TransportInterface_t *pTransport, HTTPRequestHeaders_t *pRequestHeaders, const uint8_t *pRequestBodyBuf, size_t reqBodyBufLen, HTTPResponse_t *pResponse, uint32_t sendFlags)</div><div class="ttdoc">Send the request headers in HTTPRequestHeaders_t.pBuffer and request body in pRequestBodyBuf over the...</div><div class="ttdef"><b>Definition:</b> core_http_client.c:2220</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="astruct_transport_interface__t_html"><div class="ttname"><a href="struct_transport_interface__t.html">TransportInterface_t</a></div><div class="ttdoc">The transport layer interface.</div><div class="ttdef"><b>Definition:</b> transport_interface.h:303</div></div>
 <div class="ttc" id="astruct_transport_interface__t_html_a01cd9935e9a5266ca196243a0054d489"><div class="ttname"><a href="struct_transport_interface__t.html#a01cd9935e9a5266ca196243a0054d489">TransportInterface_t::send</a></div><div class="ttdeci">TransportSend_t send</div><div class="ttdef"><b>Definition:</b> transport_interface.h:305</div></div>
@@ -2249,7 +2249,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac621a0756f290f1437e2c72a
 <div class="line">                                           <span class="keyword">sizeof</span>(<span class="stringliteral">&quot;Date&quot;</span>) - 1,</div>
 <div class="line">                                           &amp;pDateLoc,</div>
 <div class="line">                                           &amp;dateLen );</div>
-<div class="ttc" id="acore__http__client_8c_html_ac621a0756f290f1437e2c72a24e5b0f9"><div class="ttname"><a href="core__http__client_8c.html#ac621a0756f290f1437e2c72a24e5b0f9">HTTPClient_ReadHeader</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_ReadHeader(const HTTPResponse_t *pResponse, const char *pField, size_t fieldLen, const char **pValueLoc, size_t *pValueLen)</div><div class="ttdoc">Read a header from a buffer containing a complete HTTP response. This will return the location of the...</div><div class="ttdef"><b>Definition:</b> core_http_client.c:2558</div></div>
+<div class="ttc" id="acore__http__client_8c_html_ac621a0756f290f1437e2c72a24e5b0f9"><div class="ttname"><a href="core__http__client_8c.html#ac621a0756f290f1437e2c72a24e5b0f9">HTTPClient_ReadHeader</a></div><div class="ttdeci">HTTPStatus_t HTTPClient_ReadHeader(const HTTPResponse_t *pResponse, const char *pField, size_t fieldLen, const char **pValueLoc, size_t *pValueLen)</div><div class="ttdoc">Read a header from a buffer containing a complete HTTP response. This will return the location of the...</div><div class="ttdef"><b>Definition:</b> core_http_client.c:2569</div></div>
 </div><!-- fragment --> 
 </div>
 </div>