1637 lines
93 KiB
HTML
1637 lines
93 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/services/httpc.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libctru
|
|
 <span id="projectnumber">v2.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">httpc.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>HTTP service.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="httpc_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhttpcContext.html">httpcContext</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HTTP context. <a href="structhttpcContext.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a8dcddd501cd54b29b9289394ba04945c"><td class="memItemLeft" align="right" valign="top"><a id="a8dcddd501cd54b29b9289394ba04945c"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a8dcddd501cd54b29b9289394ba04945c">HTTPC_RESULTCODE_DOWNLOADPENDING</a>   0xd840a02b</td></tr>
|
|
<tr class="memdesc:a8dcddd501cd54b29b9289394ba04945c"><td class="mdescLeft"> </td><td class="mdescRight">Result code returned when a download is pending. <br /></td></tr>
|
|
<tr class="separator:a8dcddd501cd54b29b9289394ba04945c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb5611425036dc0a71a78003ff77a3e6"><td class="memItemLeft" align="right" valign="top"><a id="adb5611425036dc0a71a78003ff77a3e6"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>HTTPC_RESULTCODE_NOTFOUND</b>   0xd840a028</td></tr>
|
|
<tr class="separator:adb5611425036dc0a71a78003ff77a3e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e20dceb4e013462e6d75ce2e0e545cd"><td class="memItemLeft" align="right" valign="top"><a id="a5e20dceb4e013462e6d75ce2e0e545cd"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>HTTPC_RESULTCODE_TIMEDOUT</b>   0xd820a069</td></tr>
|
|
<tr class="separator:a5e20dceb4e013462e6d75ce2e0e545cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:a8d04e9f19b82970a3260b6f361c079dd"><td class="memItemLeft" align="right" valign="top"><a id="a8d04e9f19b82970a3260b6f361c079dd"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a8d04e9f19b82970a3260b6f361c079dd">HTTPC_RequestMethod</a> { <br />
|
|
  <b>HTTPC_METHOD_GET</b> = 0x1
|
|
, <br />
|
|
  <b>HTTPC_METHOD_POST</b> = 0x2
|
|
, <br />
|
|
  <b>HTTPC_METHOD_HEAD</b> = 0x3
|
|
, <br />
|
|
  <b>HTTPC_METHOD_PUT</b> = 0x4
|
|
, <br />
|
|
  <b>HTTPC_METHOD_DELETE</b> = 0x5
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a8d04e9f19b82970a3260b6f361c079dd"><td class="mdescLeft"> </td><td class="mdescRight">HTTP request method. <br /></td></tr>
|
|
<tr class="separator:a8d04e9f19b82970a3260b6f361c079dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf1d4f75e50ea1f3d391d4260f91d64d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d">HTTPC_RequestStatus</a> { <br />
|
|
  <a class="el" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64dad210be04b032dbcebec1d139ec446885">HTTPC_STATUS_REQUEST_IN_PROGRESS</a> = 0x5
|
|
, <br />
|
|
  <a class="el" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64da2e62946f93c0092d62c20577c6be1c19">HTTPC_STATUS_DOWNLOAD_READY</a> = 0x7
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:acf1d4f75e50ea1f3d391d4260f91d64d"><td class="mdescLeft"> </td><td class="mdescRight">HTTP request status. <a href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d">More...</a><br /></td></tr>
|
|
<tr class="separator:acf1d4f75e50ea1f3d391d4260f91d64d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a745527cd864f2240d767d85b8479a6bd"><td class="memItemLeft" align="right" valign="top"><a id="a745527cd864f2240d767d85b8479a6bd"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a745527cd864f2240d767d85b8479a6bd">HTTPC_KeepAlive</a> { <br />
|
|
  <b>HTTPC_KEEPALIVE_DISABLED</b> = 0x0
|
|
, <br />
|
|
  <b>HTTPC_KEEPALIVE_ENABLED</b> = 0x1
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a745527cd864f2240d767d85b8479a6bd"><td class="mdescLeft"> </td><td class="mdescRight">HTTP KeepAlive option. <br /></td></tr>
|
|
<tr class="separator:a745527cd864f2240d767d85b8479a6bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a5f28efe4eea836febc6ae618200ba7a1"><td class="memItemLeft" align="right" valign="top"><a id="a5f28efe4eea836febc6ae618200ba7a1"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a5f28efe4eea836febc6ae618200ba7a1">httpcInit</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> sharedmem_size)</td></tr>
|
|
<tr class="memdesc:a5f28efe4eea836febc6ae618200ba7a1"><td class="mdescLeft"> </td><td class="mdescRight">Initializes HTTPC. For HTTP GET the sharedmem_size can be zero. The sharedmem contains data which will be later uploaded for HTTP POST. sharedmem_size should be aligned to 0x1000-bytes. <br /></td></tr>
|
|
<tr class="separator:a5f28efe4eea836febc6ae618200ba7a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b4d4079c3afac6ce38dc1244a6d0be1"><td class="memItemLeft" align="right" valign="top"><a id="a7b4d4079c3afac6ce38dc1244a6d0be1"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a7b4d4079c3afac6ce38dc1244a6d0be1">httpcExit</a> (void)</td></tr>
|
|
<tr class="memdesc:a7b4d4079c3afac6ce38dc1244a6d0be1"><td class="mdescLeft"> </td><td class="mdescRight">Exits HTTPC. <br /></td></tr>
|
|
<tr class="separator:a7b4d4079c3afac6ce38dc1244a6d0be1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ed4daffa542d35e3a9cd33f61738545"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a6ed4daffa542d35e3a9cd33f61738545">httpcOpenContext</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="httpc_8h.html#a8d04e9f19b82970a3260b6f361c079dd">HTTPC_RequestMethod</a> method, const char *url, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> use_defaultproxy)</td></tr>
|
|
<tr class="memdesc:a6ed4daffa542d35e3a9cd33f61738545"><td class="mdescLeft"> </td><td class="mdescRight">Opens a HTTP context. <a href="httpc_8h.html#a6ed4daffa542d35e3a9cd33f61738545">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ed4daffa542d35e3a9cd33f61738545"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade878d05b08d6c761e165cae4e63ea49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#ade878d05b08d6c761e165cae4e63ea49">httpcCloseContext</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context)</td></tr>
|
|
<tr class="memdesc:ade878d05b08d6c761e165cae4e63ea49"><td class="mdescLeft"> </td><td class="mdescRight">Closes a HTTP context. <a href="httpc_8h.html#ade878d05b08d6c761e165cae4e63ea49">More...</a><br /></td></tr>
|
|
<tr class="separator:ade878d05b08d6c761e165cae4e63ea49"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f8158cc91ea695edf2d4fe506f8a8b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a8f8158cc91ea695edf2d4fe506f8a8b6">httpcCancelConnection</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context)</td></tr>
|
|
<tr class="memdesc:a8f8158cc91ea695edf2d4fe506f8a8b6"><td class="mdescLeft"> </td><td class="mdescRight">Cancels a HTTP connection. <a href="httpc_8h.html#a8f8158cc91ea695edf2d4fe506f8a8b6">More...</a><br /></td></tr>
|
|
<tr class="separator:a8f8158cc91ea695edf2d4fe506f8a8b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a518ad8e0992bd341c489d5ae0b2fe7aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a518ad8e0992bd341c489d5ae0b2fe7aa">httpcAddRequestHeaderField</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, const char *name, const char *value)</td></tr>
|
|
<tr class="memdesc:a518ad8e0992bd341c489d5ae0b2fe7aa"><td class="mdescLeft"> </td><td class="mdescRight">Adds a request header field to a HTTP context. <a href="httpc_8h.html#a518ad8e0992bd341c489d5ae0b2fe7aa">More...</a><br /></td></tr>
|
|
<tr class="separator:a518ad8e0992bd341c489d5ae0b2fe7aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24454dec91560ebb36daa0d53f147428"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a24454dec91560ebb36daa0d53f147428">httpcAddPostDataAscii</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, const char *name, const char *value)</td></tr>
|
|
<tr class="memdesc:a24454dec91560ebb36daa0d53f147428"><td class="mdescLeft"> </td><td class="mdescRight">Adds a POST form field to a HTTP context. <a href="httpc_8h.html#a24454dec91560ebb36daa0d53f147428">More...</a><br /></td></tr>
|
|
<tr class="separator:a24454dec91560ebb36daa0d53f147428"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0eaca70f8e0ea6568106993d108bce11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a0eaca70f8e0ea6568106993d108bce11">httpcAddPostDataBinary</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, const char *name, const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *value, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> len)</td></tr>
|
|
<tr class="memdesc:a0eaca70f8e0ea6568106993d108bce11"><td class="mdescLeft"> </td><td class="mdescRight">Adds a POST form field with binary data to a HTTP context. <a href="httpc_8h.html#a0eaca70f8e0ea6568106993d108bce11">More...</a><br /></td></tr>
|
|
<tr class="separator:a0eaca70f8e0ea6568106993d108bce11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c5b528743e6462893d7bd9ecd11bca1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a7c5b528743e6462893d7bd9ecd11bca1">httpcAddPostDataRaw</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, const <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *data, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> len)</td></tr>
|
|
<tr class="memdesc:a7c5b528743e6462893d7bd9ecd11bca1"><td class="mdescLeft"> </td><td class="mdescRight">Adds a POST body to a HTTP context. <a href="httpc_8h.html#a7c5b528743e6462893d7bd9ecd11bca1">More...</a><br /></td></tr>
|
|
<tr class="separator:a7c5b528743e6462893d7bd9ecd11bca1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a004e59467a69491deb1f4fa44b160c81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a004e59467a69491deb1f4fa44b160c81">httpcBeginRequest</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context)</td></tr>
|
|
<tr class="memdesc:a004e59467a69491deb1f4fa44b160c81"><td class="mdescLeft"> </td><td class="mdescRight">Begins a HTTP request. <a href="httpc_8h.html#a004e59467a69491deb1f4fa44b160c81">More...</a><br /></td></tr>
|
|
<tr class="separator:a004e59467a69491deb1f4fa44b160c81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6af4c5a10432a68c705adac29c50e1e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a6af4c5a10432a68c705adac29c50e1e4">httpcReceiveData</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size)</td></tr>
|
|
<tr class="memdesc:a6af4c5a10432a68c705adac29c50e1e4"><td class="mdescLeft"> </td><td class="mdescRight">Receives data from a HTTP context. <a href="httpc_8h.html#a6af4c5a10432a68c705adac29c50e1e4">More...</a><br /></td></tr>
|
|
<tr class="separator:a6af4c5a10432a68c705adac29c50e1e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5159d5a5198e932ac8f2f13d40ef89cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a5159d5a5198e932ac8f2f13d40ef89cf">httpcReceiveDataTimeout</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout)</td></tr>
|
|
<tr class="memdesc:a5159d5a5198e932ac8f2f13d40ef89cf"><td class="mdescLeft"> </td><td class="mdescRight">Receives data from a HTTP context with a timeout value. <a href="httpc_8h.html#a5159d5a5198e932ac8f2f13d40ef89cf">More...</a><br /></td></tr>
|
|
<tr class="separator:a5159d5a5198e932ac8f2f13d40ef89cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70a9e219190bacbb11eb95094ee8c3f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a70a9e219190bacbb11eb95094ee8c3f1">httpcGetRequestState</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d">HTTPC_RequestStatus</a> *out)</td></tr>
|
|
<tr class="memdesc:a70a9e219190bacbb11eb95094ee8c3f1"><td class="mdescLeft"> </td><td class="mdescRight">Gets the request state of a HTTP context. <a href="httpc_8h.html#a70a9e219190bacbb11eb95094ee8c3f1">More...</a><br /></td></tr>
|
|
<tr class="separator:a70a9e219190bacbb11eb95094ee8c3f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b8077d1e1f871f340f6d93d4731c666"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a1b8077d1e1f871f340f6d93d4731c666">httpcGetDownloadSizeState</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *downloadedsize, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *contentsize)</td></tr>
|
|
<tr class="memdesc:a1b8077d1e1f871f340f6d93d4731c666"><td class="mdescLeft"> </td><td class="mdescRight">Gets the download size state of a HTTP context. <a href="httpc_8h.html#a1b8077d1e1f871f340f6d93d4731c666">More...</a><br /></td></tr>
|
|
<tr class="separator:a1b8077d1e1f871f340f6d93d4731c666"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a004025b7a5c5ae003e42bebbbdc73952"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a004025b7a5c5ae003e42bebbbdc73952">httpcGetResponseStatusCode</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *out)</td></tr>
|
|
<tr class="memdesc:a004025b7a5c5ae003e42bebbbdc73952"><td class="mdescLeft"> </td><td class="mdescRight">Gets the response code of the HTTP context. <a href="httpc_8h.html#a004025b7a5c5ae003e42bebbbdc73952">More...</a><br /></td></tr>
|
|
<tr class="separator:a004025b7a5c5ae003e42bebbbdc73952"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acdecef13551522531ce287d019326057"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#acdecef13551522531ce287d019326057">httpcGetResponseStatusCodeTimeout</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *out, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout)</td></tr>
|
|
<tr class="memdesc:acdecef13551522531ce287d019326057"><td class="mdescLeft"> </td><td class="mdescRight">Gets the response code of the HTTP context with a timeout value. <a href="httpc_8h.html#acdecef13551522531ce287d019326057">More...</a><br /></td></tr>
|
|
<tr class="separator:acdecef13551522531ce287d019326057"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08124d231e4fd936c516d90e481c1352"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a08124d231e4fd936c516d90e481c1352">httpcGetResponseHeader</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, const char *name, char *value, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> valuebuf_maxsize)</td></tr>
|
|
<tr class="memdesc:a08124d231e4fd936c516d90e481c1352"><td class="mdescLeft"> </td><td class="mdescRight">Gets a response header field from a HTTP context. <a href="httpc_8h.html#a08124d231e4fd936c516d90e481c1352">More...</a><br /></td></tr>
|
|
<tr class="separator:a08124d231e4fd936c516d90e481c1352"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e1a5c6166a3b7bfaa5f452acd764c04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a1e1a5c6166a3b7bfaa5f452acd764c04">httpcAddTrustedRootCA</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *cert, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> certsize)</td></tr>
|
|
<tr class="memdesc:a1e1a5c6166a3b7bfaa5f452acd764c04"><td class="mdescLeft"> </td><td class="mdescRight">Adds a trusted RootCA cert to a HTTP context. <a href="httpc_8h.html#a1e1a5c6166a3b7bfaa5f452acd764c04">More...</a><br /></td></tr>
|
|
<tr class="separator:a1e1a5c6166a3b7bfaa5f452acd764c04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cab0161a0658a3710697ee9c0423d05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a2cab0161a0658a3710697ee9c0423d05">httpcAddDefaultCert</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, SSLC_DefaultRootCert certID)</td></tr>
|
|
<tr class="memdesc:a2cab0161a0658a3710697ee9c0423d05"><td class="mdescLeft"> </td><td class="mdescRight">Adds a default RootCA cert to a HTTP context. <a href="httpc_8h.html#a2cab0161a0658a3710697ee9c0423d05">More...</a><br /></td></tr>
|
|
<tr class="separator:a2cab0161a0658a3710697ee9c0423d05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b60b715a3729fa085517b4c973d174b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a4b60b715a3729fa085517b4c973d174b">httpcSelectRootCertChain</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle)</td></tr>
|
|
<tr class="memdesc:a4b60b715a3729fa085517b4c973d174b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the RootCertChain for a HTTP context. <a href="httpc_8h.html#a4b60b715a3729fa085517b4c973d174b">More...</a><br /></td></tr>
|
|
<tr class="separator:a4b60b715a3729fa085517b4c973d174b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a971cee3c9136cd37ced5422ba6ef76dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a971cee3c9136cd37ced5422ba6ef76dc">httpcSetClientCert</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *cert, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> certsize, const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *privk, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> privk_size)</td></tr>
|
|
<tr class="memdesc:a971cee3c9136cd37ced5422ba6ef76dc"><td class="mdescLeft"> </td><td class="mdescRight">Sets the ClientCert for a HTTP context. <a href="httpc_8h.html#a971cee3c9136cd37ced5422ba6ef76dc">More...</a><br /></td></tr>
|
|
<tr class="separator:a971cee3c9136cd37ced5422ba6ef76dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65b01b4c2c3c8d3805698d682417cb64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a65b01b4c2c3c8d3805698d682417cb64">httpcSetClientCertDefault</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, SSLC_DefaultClientCert certID)</td></tr>
|
|
<tr class="memdesc:a65b01b4c2c3c8d3805698d682417cb64"><td class="mdescLeft"> </td><td class="mdescRight">Sets the default clientcert for a HTTP context. <a href="httpc_8h.html#a65b01b4c2c3c8d3805698d682417cb64">More...</a><br /></td></tr>
|
|
<tr class="separator:a65b01b4c2c3c8d3805698d682417cb64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab60cd535a6b0b6eb9d785b3e17caab02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#ab60cd535a6b0b6eb9d785b3e17caab02">httpcSetClientCertContext</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> ClientCert_contexthandle)</td></tr>
|
|
<tr class="memdesc:ab60cd535a6b0b6eb9d785b3e17caab02"><td class="mdescLeft"> </td><td class="mdescRight">Sets the ClientCert contexthandle for a HTTP context. <a href="httpc_8h.html#ab60cd535a6b0b6eb9d785b3e17caab02">More...</a><br /></td></tr>
|
|
<tr class="separator:ab60cd535a6b0b6eb9d785b3e17caab02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2942f552241a762fad2894da6657d42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#ab2942f552241a762fad2894da6657d42">httpcSetSSLOpt</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> options)</td></tr>
|
|
<tr class="memdesc:ab2942f552241a762fad2894da6657d42"><td class="mdescLeft"> </td><td class="mdescRight">Sets SSL options for the context. <a href="httpc_8h.html#ab2942f552241a762fad2894da6657d42">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2942f552241a762fad2894da6657d42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac93d03fa9a93a73c18edd53208d28939"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#ac93d03fa9a93a73c18edd53208d28939">httpcSetSSLClearOpt</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> options)</td></tr>
|
|
<tr class="memdesc:ac93d03fa9a93a73c18edd53208d28939"><td class="mdescLeft"> </td><td class="mdescRight">Sets the SSL options which will be cleared for the context. <a href="httpc_8h.html#ac93d03fa9a93a73c18edd53208d28939">More...</a><br /></td></tr>
|
|
<tr class="separator:ac93d03fa9a93a73c18edd53208d28939"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af22f3288fe1b978fb1c1e7088b024f2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#af22f3288fe1b978fb1c1e7088b024f2d">httpcCreateRootCertChain</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *RootCertChain_contexthandle)</td></tr>
|
|
<tr class="memdesc:af22f3288fe1b978fb1c1e7088b024f2d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a RootCertChain. <a href="httpc_8h.html#af22f3288fe1b978fb1c1e7088b024f2d">More...</a><br /></td></tr>
|
|
<tr class="separator:af22f3288fe1b978fb1c1e7088b024f2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a413541946669b0f85f07002a5dfa0fe7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a413541946669b0f85f07002a5dfa0fe7">httpcDestroyRootCertChain</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle)</td></tr>
|
|
<tr class="memdesc:a413541946669b0f85f07002a5dfa0fe7"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a RootCertChain. <a href="httpc_8h.html#a413541946669b0f85f07002a5dfa0fe7">More...</a><br /></td></tr>
|
|
<tr class="separator:a413541946669b0f85f07002a5dfa0fe7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb5aa819772f7aa0540a304425f8c566"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#afb5aa819772f7aa0540a304425f8c566">httpcRootCertChainAddCert</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle, const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *cert, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> certsize, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *cert_contexthandle)</td></tr>
|
|
<tr class="memdesc:afb5aa819772f7aa0540a304425f8c566"><td class="mdescLeft"> </td><td class="mdescRight">Adds a RootCA cert to a RootCertChain. <a href="httpc_8h.html#afb5aa819772f7aa0540a304425f8c566">More...</a><br /></td></tr>
|
|
<tr class="separator:afb5aa819772f7aa0540a304425f8c566"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9336148bc6194431bbe9b46e52ac291d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a9336148bc6194431bbe9b46e52ac291d">httpcRootCertChainAddDefaultCert</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle, SSLC_DefaultRootCert certID, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *cert_contexthandle)</td></tr>
|
|
<tr class="memdesc:a9336148bc6194431bbe9b46e52ac291d"><td class="mdescLeft"> </td><td class="mdescRight">Adds a default RootCA cert to a RootCertChain. <a href="httpc_8h.html#a9336148bc6194431bbe9b46e52ac291d">More...</a><br /></td></tr>
|
|
<tr class="separator:a9336148bc6194431bbe9b46e52ac291d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af29138760e47d6d90bd47577d17d07cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#af29138760e47d6d90bd47577d17d07cf">httpcRootCertChainRemoveCert</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> cert_contexthandle)</td></tr>
|
|
<tr class="memdesc:af29138760e47d6d90bd47577d17d07cf"><td class="mdescLeft"> </td><td class="mdescRight">Removes a cert from a RootCertChain. <a href="httpc_8h.html#af29138760e47d6d90bd47577d17d07cf">More...</a><br /></td></tr>
|
|
<tr class="separator:af29138760e47d6d90bd47577d17d07cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07190e9fc2a2f50a097e0cb92e0c87c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a07190e9fc2a2f50a097e0cb92e0c87c0">httpcOpenClientCertContext</a> (const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *cert, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> certsize, const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *privk, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> privk_size, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *ClientCert_contexthandle)</td></tr>
|
|
<tr class="memdesc:a07190e9fc2a2f50a097e0cb92e0c87c0"><td class="mdescLeft"> </td><td class="mdescRight">Opens a ClientCert-context. <a href="httpc_8h.html#a07190e9fc2a2f50a097e0cb92e0c87c0">More...</a><br /></td></tr>
|
|
<tr class="separator:a07190e9fc2a2f50a097e0cb92e0c87c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b37506a0414ea48b9b098ae598bec7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a0b37506a0414ea48b9b098ae598bec7f">httpcOpenDefaultClientCertContext</a> (SSLC_DefaultClientCert certID, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *ClientCert_contexthandle)</td></tr>
|
|
<tr class="memdesc:a0b37506a0414ea48b9b098ae598bec7f"><td class="mdescLeft"> </td><td class="mdescRight">Opens a ClientCert-context with a default clientclient. <a href="httpc_8h.html#a0b37506a0414ea48b9b098ae598bec7f">More...</a><br /></td></tr>
|
|
<tr class="separator:a0b37506a0414ea48b9b098ae598bec7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a33b1dbb404c4f78b9ec0b7a5b02ee1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a4a33b1dbb404c4f78b9ec0b7a5b02ee1">httpcCloseClientCertContext</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> ClientCert_contexthandle)</td></tr>
|
|
<tr class="memdesc:a4a33b1dbb404c4f78b9ec0b7a5b02ee1"><td class="mdescLeft"> </td><td class="mdescRight">Closes a ClientCert context. <a href="httpc_8h.html#a4a33b1dbb404c4f78b9ec0b7a5b02ee1">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a33b1dbb404c4f78b9ec0b7a5b02ee1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62e3e9bfa4c07393a3c149a825451da5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a62e3e9bfa4c07393a3c149a825451da5">httpcDownloadData</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *downloadedsize)</td></tr>
|
|
<tr class="memdesc:a62e3e9bfa4c07393a3c149a825451da5"><td class="mdescLeft"> </td><td class="mdescRight">Downloads data from the HTTP context into a buffer. <a href="httpc_8h.html#a62e3e9bfa4c07393a3c149a825451da5">More...</a><br /></td></tr>
|
|
<tr class="separator:a62e3e9bfa4c07393a3c149a825451da5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1be3e33a15f9edd323a56d52b1124fdd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="httpc_8h.html#a1be3e33a15f9edd323a56d52b1124fdd">httpcSetKeepAlive</a> (<a class="el" href="structhttpcContext.html">httpcContext</a> *context, <a class="el" href="httpc_8h.html#a745527cd864f2240d767d85b8479a6bd">HTTPC_KeepAlive</a> option)</td></tr>
|
|
<tr class="memdesc:a1be3e33a15f9edd323a56d52b1124fdd"><td class="mdescLeft"> </td><td class="mdescRight">Sets Keep-Alive for the context. <a href="httpc_8h.html#a1be3e33a15f9edd323a56d52b1124fdd">More...</a><br /></td></tr>
|
|
<tr class="separator:a1be3e33a15f9edd323a56d52b1124fdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>HTTP service. </p>
|
|
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="acf1d4f75e50ea1f3d391d4260f91d64d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf1d4f75e50ea1f3d391d4260f91d64d">◆ </a></span>HTTPC_RequestStatus</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d">HTTPC_RequestStatus</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>HTTP request status. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acf1d4f75e50ea1f3d391d4260f91d64dad210be04b032dbcebec1d139ec446885"></a>HTTPC_STATUS_REQUEST_IN_PROGRESS </td><td class="fielddoc"><p>Request in progress. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="acf1d4f75e50ea1f3d391d4260f91d64da2e62946f93c0092d62c20577c6be1c19"></a>HTTPC_STATUS_DOWNLOAD_READY </td><td class="fielddoc"><p>Download ready. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a2cab0161a0658a3710697ee9c0423d05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2cab0161a0658a3710697ee9c0423d05">◆ </a></span>httpcAddDefaultCert()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcAddDefaultCert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">SSLC_DefaultRootCert </td>
|
|
<td class="paramname"><em>certID</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a default RootCA cert to a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">certID</td><td>ID of the cert to add, see <a class="el" href="sslc_8h.html" title="SSLC(TLS) service.">sslc.h</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a24454dec91560ebb36daa0d53f147428"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24454dec91560ebb36daa0d53f147428">◆ </a></span>httpcAddPostDataAscii()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcAddPostDataAscii </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a POST form field to a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the field. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Value of the field. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0eaca70f8e0ea6568106993d108bce11"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0eaca70f8e0ea6568106993d108bce11">◆ </a></span>httpcAddPostDataBinary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcAddPostDataBinary </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a POST form field with binary data to a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the field. </td></tr>
|
|
<tr><td class="paramname">value</td><td>The binary data to pass as a value. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of the binary data which has been passed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c5b528743e6462893d7bd9ecd11bca1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c5b528743e6462893d7bd9ecd11bca1">◆ </a></span>httpcAddPostDataRaw()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcAddPostDataRaw </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a POST body to a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">data</td><td>The data to be passed as raw into the body of the post request. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of data passed by data param. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_post_2source_2main_8c-example.html#a5">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a518ad8e0992bd341c489d5ae0b2fe7aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a518ad8e0992bd341c489d5ae0b2fe7aa">◆ </a></span>httpcAddRequestHeaderField()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcAddRequestHeaderField </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a request header field to a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the field. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Value of the field. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a4">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a4">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1e1a5c6166a3b7bfaa5f452acd764c04"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1e1a5c6166a3b7bfaa5f452acd764c04">◆ </a></span>httpcAddTrustedRootCA()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcAddTrustedRootCA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>cert</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>certsize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a trusted RootCA cert to a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">cert</td><td>Pointer to DER cert. </td></tr>
|
|
<tr><td class="paramname">certsize</td><td>Size of the DER cert. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a004e59467a69491deb1f4fa44b160c81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a004e59467a69491deb1f4fa44b160c81">◆ </a></span>httpcBeginRequest()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcBeginRequest </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Begins a HTTP request. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a5">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a6">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f8158cc91ea695edf2d4fe506f8a8b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f8158cc91ea695edf2d4fe506f8a8b6">◆ </a></span>httpcCancelConnection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcCancelConnection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Cancels a HTTP connection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to close. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a33b1dbb404c4f78b9ec0b7a5b02ee1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a33b1dbb404c4f78b9ec0b7a5b02ee1">◆ </a></span>httpcCloseClientCertContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcCloseClientCertContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>ClientCert_contexthandle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Closes a ClientCert context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ClientCert_contexthandle</td><td>ClientCert context to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade878d05b08d6c761e165cae4e63ea49"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade878d05b08d6c761e165cae4e63ea49">◆ </a></span>httpcCloseContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcCloseContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Closes a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to close. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a6">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a7">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af22f3288fe1b978fb1c1e7088b024f2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af22f3288fe1b978fb1c1e7088b024f2d">◆ </a></span>httpcCreateRootCertChain()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcCreateRootCertChain </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>RootCertChain_contexthandle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a RootCertChain. </p>
|
|
<p>Up to 2 RootCertChains can be created under this user-process. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RootCertChain_contexthandle</td><td>Output RootCertChain contexthandle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a413541946669b0f85f07002a5dfa0fe7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a413541946669b0f85f07002a5dfa0fe7">◆ </a></span>httpcDestroyRootCertChain()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcDestroyRootCertChain </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>RootCertChain_contexthandle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroy a RootCertChain. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RootCertChain_contexthandle</td><td>RootCertChain to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a62e3e9bfa4c07393a3c149a825451da5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62e3e9bfa4c07393a3c149a825451da5">◆ </a></span>httpcDownloadData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcDownloadData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>downloadedsize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Downloads data from the HTTP context into a buffer. </p>
|
|
<p>The <em>entire</em> content must be downloaded before using <a class="el" href="httpc_8h.html#ade878d05b08d6c761e165cae4e63ea49" title="Closes a HTTP context.">httpcCloseContext()</a>, otherwise <a class="el" href="httpc_8h.html#ade878d05b08d6c761e165cae4e63ea49" title="Closes a HTTP context.">httpcCloseContext()</a> will hang. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to download data from. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>Buffer to write data to. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the buffer. </td></tr>
|
|
<tr><td class="paramname">downloadedsize</td><td>Pointer to write the size of the downloaded data to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a10">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a11">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b8077d1e1f871f340f6d93d4731c666"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b8077d1e1f871f340f6d93d4731c666">◆ </a></span>httpcGetDownloadSizeState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcGetDownloadSizeState </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>downloadedsize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>contentsize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the download size state of a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">downloadedsize</td><td>Pointer to output the downloaded size to. </td></tr>
|
|
<tr><td class="paramname">contentsize</td><td>Pointer to output the total content size to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a9">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a10">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a70a9e219190bacbb11eb95094ee8c3f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a70a9e219190bacbb11eb95094ee8c3f1">◆ </a></span>httpcGetRequestState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcGetRequestState </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d">HTTPC_RequestStatus</a> * </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the request state of a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">out</td><td>Pointer to output the HTTP request state to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a08124d231e4fd936c516d90e481c1352"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a08124d231e4fd936c516d90e481c1352">◆ </a></span>httpcGetResponseHeader()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcGetResponseHeader </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>valuebuf_maxsize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets a response header field from a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">name</td><td>Name of the field. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Pointer to output the value of the field to. </td></tr>
|
|
<tr><td class="paramname">valuebuf_maxsize</td><td>Maximum size of the value buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a8">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a9">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a004025b7a5c5ae003e42bebbbdc73952"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a004025b7a5c5ae003e42bebbbdc73952">◆ </a></span>httpcGetResponseStatusCode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcGetResponseStatusCode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the response code of the HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to get the response code of. </td></tr>
|
|
<tr><td class="paramname">out</td><td>Pointer to write the response code to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a7">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a8">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acdecef13551522531ce287d019326057"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acdecef13551522531ce287d019326057">◆ </a></span>httpcGetResponseStatusCodeTimeout()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcGetResponseStatusCodeTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>out</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>timeout</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the response code of the HTTP context with a timeout value. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to get the response code of. </td></tr>
|
|
<tr><td class="paramname">out</td><td>Pointer to write the response code to. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Maximum time in nanoseconds to wait for a reply. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07190e9fc2a2f50a097e0cb92e0c87c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07190e9fc2a2f50a097e0cb92e0c87c0">◆ </a></span>httpcOpenClientCertContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcOpenClientCertContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>cert</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>certsize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>privk</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>privk_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>ClientCert_contexthandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens a ClientCert-context. </p>
|
|
<p>Up to 2 ClientCert-contexts can be open under this user-process. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cert</td><td>Pointer to DER cert. </td></tr>
|
|
<tr><td class="paramname">certsize</td><td>Size of the DER cert. </td></tr>
|
|
<tr><td class="paramname">privk</td><td>Pointer to the DER private key. </td></tr>
|
|
<tr><td class="paramname">privk_size</td><td>Size of the privk. </td></tr>
|
|
<tr><td class="paramname">ClientCert_contexthandle</td><td>Output ClientCert context handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ed4daffa542d35e3a9cd33f61738545"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ed4daffa542d35e3a9cd33f61738545">◆ </a></span>httpcOpenContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcOpenContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="httpc_8h.html#a8d04e9f19b82970a3260b6f361c079dd">HTTPC_RequestMethod</a> </td>
|
|
<td class="paramname"><em>method</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>url</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>use_defaultproxy</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to open. </td></tr>
|
|
<tr><td class="paramname">url</td><td>URL to connect to. </td></tr>
|
|
<tr><td class="paramname">use_defaultproxy</td><td>Whether the default proxy should be used (0 for default) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a1">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a1">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b37506a0414ea48b9b098ae598bec7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b37506a0414ea48b9b098ae598bec7f">◆ </a></span>httpcOpenDefaultClientCertContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcOpenDefaultClientCertContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SSLC_DefaultClientCert </td>
|
|
<td class="paramname"><em>certID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>ClientCert_contexthandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens a ClientCert-context with a default clientclient. </p>
|
|
<p>Up to 2 ClientCert-contexts can be open under this user-process. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">certID</td><td>ID of the cert to add, see <a class="el" href="sslc_8h.html" title="SSLC(TLS) service.">sslc.h</a>. </td></tr>
|
|
<tr><td class="paramname">ClientCert_contexthandle</td><td>Output ClientCert context handle. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6af4c5a10432a68c705adac29c50e1e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6af4c5a10432a68c705adac29c50e1e4">◆ </a></span>httpcReceiveData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcReceiveData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receives data from a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>Buffer to receive data to. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5159d5a5198e932ac8f2f13d40ef89cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5159d5a5198e932ac8f2f13d40ef89cf">◆ </a></span>httpcReceiveDataTimeout()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcReceiveDataTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>timeout</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Receives data from a HTTP context with a timeout value. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>Buffer to receive data to. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the buffer. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Maximum time in nanoseconds to wait for a reply. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb5aa819772f7aa0540a304425f8c566"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb5aa819772f7aa0540a304425f8c566">◆ </a></span>httpcRootCertChainAddCert()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcRootCertChainAddCert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>RootCertChain_contexthandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>cert</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>certsize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>cert_contexthandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a RootCA cert to a RootCertChain. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RootCertChain_contexthandle</td><td>RootCertChain to use. </td></tr>
|
|
<tr><td class="paramname">cert</td><td>Pointer to DER cert. </td></tr>
|
|
<tr><td class="paramname">certsize</td><td>Size of the DER cert. </td></tr>
|
|
<tr><td class="paramname">cert_contexthandle</td><td>Optional output ptr for the cert contexthandle(this can be NULL). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9336148bc6194431bbe9b46e52ac291d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9336148bc6194431bbe9b46e52ac291d">◆ </a></span>httpcRootCertChainAddDefaultCert()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcRootCertChainAddDefaultCert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>RootCertChain_contexthandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">SSLC_DefaultRootCert </td>
|
|
<td class="paramname"><em>certID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>cert_contexthandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a default RootCA cert to a RootCertChain. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RootCertChain_contexthandle</td><td>RootCertChain to use. </td></tr>
|
|
<tr><td class="paramname">certID</td><td>ID of the cert to add, see <a class="el" href="sslc_8h.html" title="SSLC(TLS) service.">sslc.h</a>. </td></tr>
|
|
<tr><td class="paramname">cert_contexthandle</td><td>Optional output ptr for the cert contexthandle(this can be NULL). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af29138760e47d6d90bd47577d17d07cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af29138760e47d6d90bd47577d17d07cf">◆ </a></span>httpcRootCertChainRemoveCert()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcRootCertChainRemoveCert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>RootCertChain_contexthandle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>cert_contexthandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Removes a cert from a RootCertChain. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">RootCertChain_contexthandle</td><td>RootCertChain to use. </td></tr>
|
|
<tr><td class="paramname">cert_contexthandle</td><td>Contexthandle of the cert to remove. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b60b715a3729fa085517b4c973d174b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b60b715a3729fa085517b4c973d174b">◆ </a></span>httpcSelectRootCertChain()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcSelectRootCertChain </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>RootCertChain_contexthandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the RootCertChain for a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">RootCertChain_contexthandle</td><td>Contexthandle for the RootCertChain. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a971cee3c9136cd37ced5422ba6ef76dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a971cee3c9136cd37ced5422ba6ef76dc">◆ </a></span>httpcSetClientCert()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcSetClientCert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>cert</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>certsize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>privk</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>privk_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the ClientCert for a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">cert</td><td>Pointer to DER cert. </td></tr>
|
|
<tr><td class="paramname">certsize</td><td>Size of the DER cert. </td></tr>
|
|
<tr><td class="paramname">privk</td><td>Pointer to the DER private key. </td></tr>
|
|
<tr><td class="paramname">privk_size</td><td>Size of the privk. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab60cd535a6b0b6eb9d785b3e17caab02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab60cd535a6b0b6eb9d785b3e17caab02">◆ </a></span>httpcSetClientCertContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcSetClientCertContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>ClientCert_contexthandle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the ClientCert contexthandle for a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">ClientCert_contexthandle</td><td>Contexthandle for the ClientCert. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a65b01b4c2c3c8d3805698d682417cb64"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a65b01b4c2c3c8d3805698d682417cb64">◆ </a></span>httpcSetClientCertDefault()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcSetClientCertDefault </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">SSLC_DefaultClientCert </td>
|
|
<td class="paramname"><em>certID</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the default clientcert for a HTTP context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to use. </td></tr>
|
|
<tr><td class="paramname">certID</td><td>ID of the cert to add, see <a class="el" href="sslc_8h.html" title="SSLC(TLS) service.">sslc.h</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1be3e33a15f9edd323a56d52b1124fdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1be3e33a15f9edd323a56d52b1124fdd">◆ </a></span>httpcSetKeepAlive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcSetKeepAlive </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="httpc_8h.html#a745527cd864f2240d767d85b8479a6bd">HTTPC_KeepAlive</a> </td>
|
|
<td class="paramname"><em>option</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets Keep-Alive for the context. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to set the KeepAlive flag on. </td></tr>
|
|
<tr><td class="paramname">option</td><td>HTTPC_KeepAlive option. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a3">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a3">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac93d03fa9a93a73c18edd53208d28939"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac93d03fa9a93a73c18edd53208d28939">◆ </a></span>httpcSetSSLClearOpt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcSetSSLClearOpt </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>options</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the SSL options which will be cleared for the context. </p>
|
|
<p>The HTTPC SSL option bits are the same as those defined in <a class="el" href="sslc_8h.html" title="SSLC(TLS) service.">sslc.h</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to clear flags on. </td></tr>
|
|
<tr><td class="paramname">options</td><td>SSL option flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2942f552241a762fad2894da6657d42"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2942f552241a762fad2894da6657d42">◆ </a></span>httpcSetSSLOpt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> httpcSetSSLOpt </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structhttpcContext.html">httpcContext</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>options</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets SSL options for the context. </p>
|
|
<p>The HTTPC SSL option bits are the same as those defined in <a class="el" href="sslc_8h.html" title="SSLC(TLS) service.">sslc.h</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>Context to set flags on. </td></tr>
|
|
<tr><td class="paramname">options</td><td>SSL option flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2http_2source_2main_8c-example.html#a2">network/http/source/main.c</a>, and <a class="el" href="network_2http_post_2source_2main_8c-example.html#a2">network/http_post/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|