429 lines
77 KiB
HTML
429 lines
77 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 Source File</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="headertitle">
|
|
<div class="title">httpc.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="httpc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file httpc.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief HTTP service.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/// HTTP context.</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="structhttpcContext.html"> 8</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="structhttpcContext.html#a026a48ba3da27fee529b344e256d612f"> 9</a></span>  <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> <a class="code" href="structhttpcContext.html#a026a48ba3da27fee529b344e256d612f">servhandle</a>; <span class="comment">///< Service handle.</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="structhttpcContext.html#af77b3063ba2ea67ee4971a8a5407cb88"> 10</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structhttpcContext.html#af77b3063ba2ea67ee4971a8a5407cb88">httphandle</a>; <span class="comment">///< HTTP handle.</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> } <a class="code" href="structhttpcContext.html">httpcContext</a>;</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/// HTTP request method.</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="httpc_8h.html#a8d04e9f19b82970a3260b6f361c079dd"> 14</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  HTTPC_METHOD_GET = 0x1,</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  HTTPC_METHOD_POST = 0x2,</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  HTTPC_METHOD_HEAD = 0x3,</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  HTTPC_METHOD_PUT = 0x4,</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  HTTPC_METHOD_DELETE = 0x5</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> } <a class="code" href="httpc_8h.html#a8d04e9f19b82970a3260b6f361c079dd">HTTPC_RequestMethod</a>;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/// HTTP request status.</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d"> 23</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64dad210be04b032dbcebec1d139ec446885"> 24</a></span>  <a class="code" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64dad210be04b032dbcebec1d139ec446885">HTTPC_STATUS_REQUEST_IN_PROGRESS</a> = 0x5, <span class="comment">///< Request in progress.</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64da2e62946f93c0092d62c20577c6be1c19">HTTPC_STATUS_DOWNLOAD_READY</a> = 0x7 <span class="comment">///< Download ready.</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64da2e62946f93c0092d62c20577c6be1c19"> 26</a></span> } <a class="code" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d">HTTPC_RequestStatus</a>;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/// HTTP KeepAlive option.</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="httpc_8h.html#a745527cd864f2240d767d85b8479a6bd"> 29</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  HTTPC_KEEPALIVE_DISABLED = 0x0,</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  HTTPC_KEEPALIVE_ENABLED = 0x1</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> } <a class="code" href="httpc_8h.html#a745527cd864f2240d767d85b8479a6bd">HTTPC_KeepAlive</a>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/// Result code returned when a download is pending.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="httpc_8h.html#a8dcddd501cd54b29b9289394ba04945c"> 35</a></span> <span class="comment"></span><span class="preprocessor">#define HTTPC_RESULTCODE_DOWNLOADPENDING 0xd840a02b</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// Result code returned when asked about a non-existing header.</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define HTTPC_RESULTCODE_NOTFOUND 0xd840a028</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// Result code returned when any timeout function times out.</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define HTTPC_RESULTCODE_TIMEDOUT 0xd820a069</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/// 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.</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="httpc_8h.html#a5f28efe4eea836febc6ae618200ba7a1"> 44</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a5f28efe4eea836febc6ae618200ba7a1">httpcInit</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> sharedmem_size);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/// Exits HTTPC.</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="httpc_8h.html#a7b4d4079c3afac6ce38dc1244a6d0be1"> 47</a></span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="httpc_8h.html#a7b4d4079c3afac6ce38dc1244a6d0be1">httpcExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @brief Opens a HTTP context.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @param context Context to open.</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * @param url URL to connect to.</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @param use_defaultproxy Whether the default proxy should be used (0 for default)</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="httpc_8h.html#a6ed4daffa542d35e3a9cd33f61738545"> 55</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a6ed4daffa542d35e3a9cd33f61738545">httpcOpenContext</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="httpc_8h.html#a8d04e9f19b82970a3260b6f361c079dd">HTTPC_RequestMethod</a> method, <span class="keyword">const</span> <span class="keywordtype">char</span>* url, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> use_defaultproxy);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @brief Closes a HTTP context.</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * @param context Context to close.</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="httpc_8h.html#ade878d05b08d6c761e165cae4e63ea49"> 61</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#ade878d05b08d6c761e165cae4e63ea49">httpcCloseContext</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context);</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @brief Cancels a HTTP connection.</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @param context Context to close.</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="httpc_8h.html#a8f8158cc91ea695edf2d4fe506f8a8b6"> 67</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a8f8158cc91ea695edf2d4fe506f8a8b6">httpcCancelConnection</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @brief Adds a request header field to a HTTP context.</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @param name Name of the field.</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * @param value Value of the field.</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="httpc_8h.html#a518ad8e0992bd341c489d5ae0b2fe7aa"> 75</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a518ad8e0992bd341c489d5ae0b2fe7aa">httpcAddRequestHeaderField</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <span class="keywordtype">char</span>* value);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @brief Adds a POST form field to a HTTP context.</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @param name Name of the field.</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @param value Value of the field.</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="httpc_8h.html#a24454dec91560ebb36daa0d53f147428"> 83</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a24454dec91560ebb36daa0d53f147428">httpcAddPostDataAscii</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <span class="keywordtype">char</span>* value);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @brief Adds a POST form field with binary data to a HTTP context.</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @param name Name of the field.</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @param value The binary data to pass as a value.</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @param len Length of the binary data which has been passed.</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="httpc_8h.html#a0eaca70f8e0ea6568106993d108bce11"> 92</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a0eaca70f8e0ea6568106993d108bce11">httpcAddPostDataBinary</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keyword">const</span> <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>* value, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> len);</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment"></span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @brief Adds a POST body to a HTTP context.</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @param data The data to be passed as raw into the body of the post request.</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @param len Length of data passed by data param.</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="httpc_8h.html#a7c5b528743e6462893d7bd9ecd11bca1"> 100</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a7c5b528743e6462893d7bd9ecd11bca1">httpcAddPostDataRaw</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <span class="keyword">const</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* data, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> len);</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @brief Begins a HTTP request.</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="httpc_8h.html#a004e59467a69491deb1f4fa44b160c81"> 106</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a004e59467a69491deb1f4fa44b160c81">httpcBeginRequest</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context);</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @brief Receives data from a HTTP context.</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @param buffer Buffer to receive data to.</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @param size Size of the buffer.</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="httpc_8h.html#a6af4c5a10432a68c705adac29c50e1e4"> 114</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a6af4c5a10432a68c705adac29c50e1e4">httpcReceiveData</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>* buffer, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size);</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @brief Receives data from a HTTP context with a timeout value.</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @param buffer Buffer to receive data to.</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @param size Size of the buffer.</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @param timeout Maximum time in nanoseconds to wait for a reply.</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="httpc_8h.html#a5159d5a5198e932ac8f2f13d40ef89cf"> 123</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a5159d5a5198e932ac8f2f13d40ef89cf">httpcReceiveDataTimeout</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>* buffer, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @brief Gets the request state of a HTTP context.</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * @param out Pointer to output the HTTP request state to.</span></div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="httpc_8h.html#a70a9e219190bacbb11eb95094ee8c3f1"> 130</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a70a9e219190bacbb11eb95094ee8c3f1">httpcGetRequestState</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d">HTTPC_RequestStatus</a>* out);</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @brief Gets the download size state of a HTTP context.</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * @param downloadedsize Pointer to output the downloaded size to.</span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @param contentsize Pointer to output the total content size to.</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="httpc_8h.html#a1b8077d1e1f871f340f6d93d4731c666"> 138</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a1b8077d1e1f871f340f6d93d4731c666">httpcGetDownloadSizeState</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* downloadedsize, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* contentsize);</div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * @brief Gets the response code of the HTTP context.</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @param context Context to get the response code of.</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * @param out Pointer to write the response code to.</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="httpc_8h.html#a004025b7a5c5ae003e42bebbbdc73952"> 145</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a004025b7a5c5ae003e42bebbbdc73952">httpcGetResponseStatusCode</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* out);</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @brief Gets the response code of the HTTP context with a timeout value.</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @param context Context to get the response code of.</span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @param out Pointer to write the response code to.</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * @param timeout Maximum time in nanoseconds to wait for a reply.</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="httpc_8h.html#acdecef13551522531ce287d019326057"> 153</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#acdecef13551522531ce287d019326057">httpcGetResponseStatusCodeTimeout</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* out, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout);</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @brief Gets a response header field from a HTTP context.</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @param name Name of the field.</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @param value Pointer to output the value of the field to.</span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @param valuebuf_maxsize Maximum size of the value buffer.</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="httpc_8h.html#a08124d231e4fd936c516d90e481c1352"> 162</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a08124d231e4fd936c516d90e481c1352">httpcGetResponseHeader</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">char</span>* value, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> valuebuf_maxsize);</div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @brief Adds a trusted RootCA cert to a HTTP context.</span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * @param cert Pointer to DER cert.</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * @param certsize Size of the DER cert.</span></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"><a class="line" href="httpc_8h.html#a1e1a5c6166a3b7bfaa5f452acd764c04"> 170</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a1e1a5c6166a3b7bfaa5f452acd764c04">httpcAddTrustedRootCA</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <span class="keyword">const</span> <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *cert, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> certsize);</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @brief Adds a default RootCA cert to a HTTP context.</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @param certID ID of the cert to add, see sslc.h.</span></div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="httpc_8h.html#a2cab0161a0658a3710697ee9c0423d05"> 177</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a2cab0161a0658a3710697ee9c0423d05">httpcAddDefaultCert</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, SSLC_DefaultRootCert certID);</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @brief Sets the RootCertChain for a HTTP context.</span></div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * @param RootCertChain_contexthandle Contexthandle for the RootCertChain.</span></div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="httpc_8h.html#a4b60b715a3729fa085517b4c973d174b"> 184</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a4b60b715a3729fa085517b4c973d174b">httpcSelectRootCertChain</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle);</div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * @brief Sets the ClientCert for a HTTP context.</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param cert Pointer to DER cert.</span></div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @param certsize Size of the DER cert.</span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @param privk Pointer to the DER private key.</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * @param privk_size Size of the privk.</span></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="httpc_8h.html#a971cee3c9136cd37ced5422ba6ef76dc"> 194</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a971cee3c9136cd37ced5422ba6ef76dc">httpcSetClientCert</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <span class="keyword">const</span> <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *cert, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> certsize, <span class="keyword">const</span> <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *privk, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> privk_size);</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * @brief Sets the default clientcert for a HTTP context.</span></div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * @param certID ID of the cert to add, see sslc.h.</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"><a class="line" href="httpc_8h.html#a65b01b4c2c3c8d3805698d682417cb64"> 201</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a65b01b4c2c3c8d3805698d682417cb64">httpcSetClientCertDefault</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, SSLC_DefaultClientCert certID);</div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * @brief Sets the ClientCert contexthandle for a HTTP context.</span></div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * @param context Context to use.</span></div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * @param ClientCert_contexthandle Contexthandle for the ClientCert.</span></div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"><a class="line" href="httpc_8h.html#ab60cd535a6b0b6eb9d785b3e17caab02"> 208</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#ab60cd535a6b0b6eb9d785b3e17caab02">httpcSetClientCertContext</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> ClientCert_contexthandle);</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * @brief Sets SSL options for the context.</span></div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * The HTTPC SSL option bits are the same as those defined in sslc.h</span></div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * @param context Context to set flags on.</span></div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * @param options SSL option flags.</span></div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"><a class="line" href="httpc_8h.html#ab2942f552241a762fad2894da6657d42"> 216</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#ab2942f552241a762fad2894da6657d42">httpcSetSSLOpt</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> options);</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * @brief Sets the SSL options which will be cleared for the context.</span></div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * The HTTPC SSL option bits are the same as those defined in sslc.h</span></div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * @param context Context to clear flags on.</span></div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * @param options SSL option flags.</span></div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"><a class="line" href="httpc_8h.html#ac93d03fa9a93a73c18edd53208d28939"> 224</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#ac93d03fa9a93a73c18edd53208d28939">httpcSetSSLClearOpt</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> options);</div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> * @brief Creates a RootCertChain. Up to 2 RootCertChains can be created under this user-process.</span></div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * @param RootCertChain_contexthandle Output RootCertChain contexthandle.</span></div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"><a class="line" href="httpc_8h.html#af22f3288fe1b978fb1c1e7088b024f2d"> 230</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#af22f3288fe1b978fb1c1e7088b024f2d">httpcCreateRootCertChain</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *RootCertChain_contexthandle);</div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> * @brief Destroy a RootCertChain.</span></div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @param RootCertChain_contexthandle RootCertChain to use.</span></div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"><a class="line" href="httpc_8h.html#a413541946669b0f85f07002a5dfa0fe7"> 236</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a413541946669b0f85f07002a5dfa0fe7">httpcDestroyRootCertChain</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle);</div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * @brief Adds a RootCA cert to a RootCertChain.</span></div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * @param RootCertChain_contexthandle RootCertChain to use.</span></div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * @param cert Pointer to DER cert.</span></div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * @param certsize Size of the DER cert.</span></div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * @param cert_contexthandle Optional output ptr for the cert contexthandle(this can be NULL).</span></div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"><a class="line" href="httpc_8h.html#afb5aa819772f7aa0540a304425f8c566"> 245</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#afb5aa819772f7aa0540a304425f8c566">httpcRootCertChainAddCert</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle, <span class="keyword">const</span> <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *cert, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> certsize, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *cert_contexthandle);</div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * @brief Adds a default RootCA cert to a RootCertChain.</span></div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> * @param RootCertChain_contexthandle RootCertChain to use.</span></div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * @param certID ID of the cert to add, see sslc.h.</span></div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> * @param cert_contexthandle Optional output ptr for the cert contexthandle(this can be NULL).</span></div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"><a class="line" href="httpc_8h.html#a9336148bc6194431bbe9b46e52ac291d"> 253</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a9336148bc6194431bbe9b46e52ac291d">httpcRootCertChainAddDefaultCert</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle, SSLC_DefaultRootCert certID, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *cert_contexthandle);</div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * @brief Removes a cert from a RootCertChain.</span></div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * @param RootCertChain_contexthandle RootCertChain to use.</span></div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * @param cert_contexthandle Contexthandle of the cert to remove.</span></div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"><a class="line" href="httpc_8h.html#af29138760e47d6d90bd47577d17d07cf"> 260</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#af29138760e47d6d90bd47577d17d07cf">httpcRootCertChainRemoveCert</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> RootCertChain_contexthandle, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> cert_contexthandle);</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * @brief Opens a ClientCert-context. Up to 2 ClientCert-contexts can be open under this user-process.</span></div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * @param cert Pointer to DER cert.</span></div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * @param certsize Size of the DER cert.</span></div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * @param privk Pointer to the DER private key.</span></div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * @param privk_size Size of the privk.</span></div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * @param ClientCert_contexthandle Output ClientCert context handle.</span></div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"><a class="line" href="httpc_8h.html#a07190e9fc2a2f50a097e0cb92e0c87c0"> 270</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a07190e9fc2a2f50a097e0cb92e0c87c0">httpcOpenClientCertContext</a>(<span class="keyword">const</span> <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *cert, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> certsize, <span class="keyword">const</span> <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *privk, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> privk_size, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *ClientCert_contexthandle);</div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * @brief Opens a ClientCert-context with a default clientclient. Up to 2 ClientCert-contexts can be open under this user-process.</span></div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * @param certID ID of the cert to add, see sslc.h.</span></div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * @param ClientCert_contexthandle Output ClientCert context handle.</span></div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"><a class="line" href="httpc_8h.html#a0b37506a0414ea48b9b098ae598bec7f"> 277</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a0b37506a0414ea48b9b098ae598bec7f">httpcOpenDefaultClientCertContext</a>(SSLC_DefaultClientCert certID, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *ClientCert_contexthandle);</div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> * @brief Closes a ClientCert context.</span></div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * @param ClientCert_contexthandle ClientCert context to use.</span></div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"><a class="line" href="httpc_8h.html#a4a33b1dbb404c4f78b9ec0b7a5b02ee1"> 283</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a4a33b1dbb404c4f78b9ec0b7a5b02ee1">httpcCloseClientCertContext</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> ClientCert_contexthandle);</div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * @brief Downloads data from the HTTP context into a buffer.</span></div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * The *entire* content must be downloaded before using httpcCloseContext(), otherwise httpcCloseContext() will hang.</span></div>
|
|
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * @param context Context to download data from.</span></div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * @param buffer Buffer to write data to.</span></div>
|
|
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * @param size Size of the buffer.</span></div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * @param downloadedsize Pointer to write the size of the downloaded data to.</span></div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"><a class="line" href="httpc_8h.html#a62e3e9bfa4c07393a3c149a825451da5"> 293</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a62e3e9bfa4c07393a3c149a825451da5">httpcDownloadData</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>* buffer, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *downloadedsize);</div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> * @brief Sets Keep-Alive for the context.</span></div>
|
|
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> * @param context Context to set the KeepAlive flag on.</span></div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * @param option HTTPC_KeepAlive option.</span></div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"><a class="line" href="httpc_8h.html#a1be3e33a15f9edd323a56d52b1124fdd"> 300</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="httpc_8h.html#a1be3e33a15f9edd323a56d52b1124fdd">httpcSetKeepAlive</a>(<a class="code" href="structhttpcContext.html">httpcContext</a> *context, <a class="code" href="httpc_8h.html#a745527cd864f2240d767d85b8479a6bd">HTTPC_KeepAlive</a> option);</div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  </div>
|
|
<div class="ttc" id="ahttpc_8h_html_a004025b7a5c5ae003e42bebbbdc73952"><div class="ttname"><a href="httpc_8h.html#a004025b7a5c5ae003e42bebbbdc73952">httpcGetResponseStatusCode</a></div><div class="ttdeci">Result httpcGetResponseStatusCode(httpcContext *context, u32 *out)</div><div class="ttdoc">Gets the response code of the HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a004e59467a69491deb1f4fa44b160c81"><div class="ttname"><a href="httpc_8h.html#a004e59467a69491deb1f4fa44b160c81">httpcBeginRequest</a></div><div class="ttdeci">Result httpcBeginRequest(httpcContext *context)</div><div class="ttdoc">Begins a HTTP request.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a07190e9fc2a2f50a097e0cb92e0c87c0"><div class="ttname"><a href="httpc_8h.html#a07190e9fc2a2f50a097e0cb92e0c87c0">httpcOpenClientCertContext</a></div><div class="ttdeci">Result httpcOpenClientCertContext(const u8 *cert, u32 certsize, const u8 *privk, u32 privk_size, u32 *ClientCert_contexthandle)</div><div class="ttdoc">Opens a ClientCert-context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a08124d231e4fd936c516d90e481c1352"><div class="ttname"><a href="httpc_8h.html#a08124d231e4fd936c516d90e481c1352">httpcGetResponseHeader</a></div><div class="ttdeci">Result httpcGetResponseHeader(httpcContext *context, const char *name, char *value, u32 valuebuf_maxsize)</div><div class="ttdoc">Gets a response header field from a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a0b37506a0414ea48b9b098ae598bec7f"><div class="ttname"><a href="httpc_8h.html#a0b37506a0414ea48b9b098ae598bec7f">httpcOpenDefaultClientCertContext</a></div><div class="ttdeci">Result httpcOpenDefaultClientCertContext(SSLC_DefaultClientCert certID, u32 *ClientCert_contexthandle)</div><div class="ttdoc">Opens a ClientCert-context with a default clientclient.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a0eaca70f8e0ea6568106993d108bce11"><div class="ttname"><a href="httpc_8h.html#a0eaca70f8e0ea6568106993d108bce11">httpcAddPostDataBinary</a></div><div class="ttdeci">Result httpcAddPostDataBinary(httpcContext *context, const char *name, const u8 *value, u32 len)</div><div class="ttdoc">Adds a POST form field with binary data to a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a1b8077d1e1f871f340f6d93d4731c666"><div class="ttname"><a href="httpc_8h.html#a1b8077d1e1f871f340f6d93d4731c666">httpcGetDownloadSizeState</a></div><div class="ttdeci">Result httpcGetDownloadSizeState(httpcContext *context, u32 *downloadedsize, u32 *contentsize)</div><div class="ttdoc">Gets the download size state of a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a1be3e33a15f9edd323a56d52b1124fdd"><div class="ttname"><a href="httpc_8h.html#a1be3e33a15f9edd323a56d52b1124fdd">httpcSetKeepAlive</a></div><div class="ttdeci">Result httpcSetKeepAlive(httpcContext *context, HTTPC_KeepAlive option)</div><div class="ttdoc">Sets Keep-Alive for the context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a1e1a5c6166a3b7bfaa5f452acd764c04"><div class="ttname"><a href="httpc_8h.html#a1e1a5c6166a3b7bfaa5f452acd764c04">httpcAddTrustedRootCA</a></div><div class="ttdeci">Result httpcAddTrustedRootCA(httpcContext *context, const u8 *cert, u32 certsize)</div><div class="ttdoc">Adds a trusted RootCA cert to a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a24454dec91560ebb36daa0d53f147428"><div class="ttname"><a href="httpc_8h.html#a24454dec91560ebb36daa0d53f147428">httpcAddPostDataAscii</a></div><div class="ttdeci">Result httpcAddPostDataAscii(httpcContext *context, const char *name, const char *value)</div><div class="ttdoc">Adds a POST form field to a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a2cab0161a0658a3710697ee9c0423d05"><div class="ttname"><a href="httpc_8h.html#a2cab0161a0658a3710697ee9c0423d05">httpcAddDefaultCert</a></div><div class="ttdeci">Result httpcAddDefaultCert(httpcContext *context, SSLC_DefaultRootCert certID)</div><div class="ttdoc">Adds a default RootCA cert to a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a413541946669b0f85f07002a5dfa0fe7"><div class="ttname"><a href="httpc_8h.html#a413541946669b0f85f07002a5dfa0fe7">httpcDestroyRootCertChain</a></div><div class="ttdeci">Result httpcDestroyRootCertChain(u32 RootCertChain_contexthandle)</div><div class="ttdoc">Destroy a RootCertChain.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a4a33b1dbb404c4f78b9ec0b7a5b02ee1"><div class="ttname"><a href="httpc_8h.html#a4a33b1dbb404c4f78b9ec0b7a5b02ee1">httpcCloseClientCertContext</a></div><div class="ttdeci">Result httpcCloseClientCertContext(u32 ClientCert_contexthandle)</div><div class="ttdoc">Closes a ClientCert context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a4b60b715a3729fa085517b4c973d174b"><div class="ttname"><a href="httpc_8h.html#a4b60b715a3729fa085517b4c973d174b">httpcSelectRootCertChain</a></div><div class="ttdeci">Result httpcSelectRootCertChain(httpcContext *context, u32 RootCertChain_contexthandle)</div><div class="ttdoc">Sets the RootCertChain for a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a5159d5a5198e932ac8f2f13d40ef89cf"><div class="ttname"><a href="httpc_8h.html#a5159d5a5198e932ac8f2f13d40ef89cf">httpcReceiveDataTimeout</a></div><div class="ttdeci">Result httpcReceiveDataTimeout(httpcContext *context, u8 *buffer, u32 size, u64 timeout)</div><div class="ttdoc">Receives data from a HTTP context with a timeout value.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a518ad8e0992bd341c489d5ae0b2fe7aa"><div class="ttname"><a href="httpc_8h.html#a518ad8e0992bd341c489d5ae0b2fe7aa">httpcAddRequestHeaderField</a></div><div class="ttdeci">Result httpcAddRequestHeaderField(httpcContext *context, const char *name, const char *value)</div><div class="ttdoc">Adds a request header field to a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a5f28efe4eea836febc6ae618200ba7a1"><div class="ttname"><a href="httpc_8h.html#a5f28efe4eea836febc6ae618200ba7a1">httpcInit</a></div><div class="ttdeci">Result httpcInit(u32 sharedmem_size)</div><div class="ttdoc">Initializes HTTPC. For HTTP GET the sharedmem_size can be zero. The sharedmem contains data which wil...</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a62e3e9bfa4c07393a3c149a825451da5"><div class="ttname"><a href="httpc_8h.html#a62e3e9bfa4c07393a3c149a825451da5">httpcDownloadData</a></div><div class="ttdeci">Result httpcDownloadData(httpcContext *context, u8 *buffer, u32 size, u32 *downloadedsize)</div><div class="ttdoc">Downloads data from the HTTP context into a buffer.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a65b01b4c2c3c8d3805698d682417cb64"><div class="ttname"><a href="httpc_8h.html#a65b01b4c2c3c8d3805698d682417cb64">httpcSetClientCertDefault</a></div><div class="ttdeci">Result httpcSetClientCertDefault(httpcContext *context, SSLC_DefaultClientCert certID)</div><div class="ttdoc">Sets the default clientcert for a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a6af4c5a10432a68c705adac29c50e1e4"><div class="ttname"><a href="httpc_8h.html#a6af4c5a10432a68c705adac29c50e1e4">httpcReceiveData</a></div><div class="ttdeci">Result httpcReceiveData(httpcContext *context, u8 *buffer, u32 size)</div><div class="ttdoc">Receives data from a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a6ed4daffa542d35e3a9cd33f61738545"><div class="ttname"><a href="httpc_8h.html#a6ed4daffa542d35e3a9cd33f61738545">httpcOpenContext</a></div><div class="ttdeci">Result httpcOpenContext(httpcContext *context, HTTPC_RequestMethod method, const char *url, u32 use_defaultproxy)</div><div class="ttdoc">Opens a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a70a9e219190bacbb11eb95094ee8c3f1"><div class="ttname"><a href="httpc_8h.html#a70a9e219190bacbb11eb95094ee8c3f1">httpcGetRequestState</a></div><div class="ttdeci">Result httpcGetRequestState(httpcContext *context, HTTPC_RequestStatus *out)</div><div class="ttdoc">Gets the request state of a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a745527cd864f2240d767d85b8479a6bd"><div class="ttname"><a href="httpc_8h.html#a745527cd864f2240d767d85b8479a6bd">HTTPC_KeepAlive</a></div><div class="ttdeci">HTTPC_KeepAlive</div><div class="ttdoc">HTTP KeepAlive option.</div><div class="ttdef"><b>Definition:</b> httpc.h:29</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a7b4d4079c3afac6ce38dc1244a6d0be1"><div class="ttname"><a href="httpc_8h.html#a7b4d4079c3afac6ce38dc1244a6d0be1">httpcExit</a></div><div class="ttdeci">void httpcExit(void)</div><div class="ttdoc">Exits HTTPC.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a7c5b528743e6462893d7bd9ecd11bca1"><div class="ttname"><a href="httpc_8h.html#a7c5b528743e6462893d7bd9ecd11bca1">httpcAddPostDataRaw</a></div><div class="ttdeci">Result httpcAddPostDataRaw(httpcContext *context, const u32 *data, u32 len)</div><div class="ttdoc">Adds a POST body to a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a8d04e9f19b82970a3260b6f361c079dd"><div class="ttname"><a href="httpc_8h.html#a8d04e9f19b82970a3260b6f361c079dd">HTTPC_RequestMethod</a></div><div class="ttdeci">HTTPC_RequestMethod</div><div class="ttdoc">HTTP request method.</div><div class="ttdef"><b>Definition:</b> httpc.h:14</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a8f8158cc91ea695edf2d4fe506f8a8b6"><div class="ttname"><a href="httpc_8h.html#a8f8158cc91ea695edf2d4fe506f8a8b6">httpcCancelConnection</a></div><div class="ttdeci">Result httpcCancelConnection(httpcContext *context)</div><div class="ttdoc">Cancels a HTTP connection.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a9336148bc6194431bbe9b46e52ac291d"><div class="ttname"><a href="httpc_8h.html#a9336148bc6194431bbe9b46e52ac291d">httpcRootCertChainAddDefaultCert</a></div><div class="ttdeci">Result httpcRootCertChainAddDefaultCert(u32 RootCertChain_contexthandle, SSLC_DefaultRootCert certID, u32 *cert_contexthandle)</div><div class="ttdoc">Adds a default RootCA cert to a RootCertChain.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_a971cee3c9136cd37ced5422ba6ef76dc"><div class="ttname"><a href="httpc_8h.html#a971cee3c9136cd37ced5422ba6ef76dc">httpcSetClientCert</a></div><div class="ttdeci">Result httpcSetClientCert(httpcContext *context, const u8 *cert, u32 certsize, const u8 *privk, u32 privk_size)</div><div class="ttdoc">Sets the ClientCert for a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_ab2942f552241a762fad2894da6657d42"><div class="ttname"><a href="httpc_8h.html#ab2942f552241a762fad2894da6657d42">httpcSetSSLOpt</a></div><div class="ttdeci">Result httpcSetSSLOpt(httpcContext *context, u32 options)</div><div class="ttdoc">Sets SSL options for the context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_ab60cd535a6b0b6eb9d785b3e17caab02"><div class="ttname"><a href="httpc_8h.html#ab60cd535a6b0b6eb9d785b3e17caab02">httpcSetClientCertContext</a></div><div class="ttdeci">Result httpcSetClientCertContext(httpcContext *context, u32 ClientCert_contexthandle)</div><div class="ttdoc">Sets the ClientCert contexthandle for a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_ac93d03fa9a93a73c18edd53208d28939"><div class="ttname"><a href="httpc_8h.html#ac93d03fa9a93a73c18edd53208d28939">httpcSetSSLClearOpt</a></div><div class="ttdeci">Result httpcSetSSLClearOpt(httpcContext *context, u32 options)</div><div class="ttdoc">Sets the SSL options which will be cleared for the context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_acdecef13551522531ce287d019326057"><div class="ttname"><a href="httpc_8h.html#acdecef13551522531ce287d019326057">httpcGetResponseStatusCodeTimeout</a></div><div class="ttdeci">Result httpcGetResponseStatusCodeTimeout(httpcContext *context, u32 *out, u64 timeout)</div><div class="ttdoc">Gets the response code of the HTTP context with a timeout value.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_acf1d4f75e50ea1f3d391d4260f91d64d"><div class="ttname"><a href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64d">HTTPC_RequestStatus</a></div><div class="ttdeci">HTTPC_RequestStatus</div><div class="ttdoc">HTTP request status.</div><div class="ttdef"><b>Definition:</b> httpc.h:23</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_acf1d4f75e50ea1f3d391d4260f91d64da2e62946f93c0092d62c20577c6be1c19"><div class="ttname"><a href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64da2e62946f93c0092d62c20577c6be1c19">HTTPC_STATUS_DOWNLOAD_READY</a></div><div class="ttdeci">@ HTTPC_STATUS_DOWNLOAD_READY</div><div class="ttdoc">Download ready.</div><div class="ttdef"><b>Definition:</b> httpc.h:25</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_acf1d4f75e50ea1f3d391d4260f91d64dad210be04b032dbcebec1d139ec446885"><div class="ttname"><a href="httpc_8h.html#acf1d4f75e50ea1f3d391d4260f91d64dad210be04b032dbcebec1d139ec446885">HTTPC_STATUS_REQUEST_IN_PROGRESS</a></div><div class="ttdeci">@ HTTPC_STATUS_REQUEST_IN_PROGRESS</div><div class="ttdoc">Request in progress.</div><div class="ttdef"><b>Definition:</b> httpc.h:24</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_ade878d05b08d6c761e165cae4e63ea49"><div class="ttname"><a href="httpc_8h.html#ade878d05b08d6c761e165cae4e63ea49">httpcCloseContext</a></div><div class="ttdeci">Result httpcCloseContext(httpcContext *context)</div><div class="ttdoc">Closes a HTTP context.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_af22f3288fe1b978fb1c1e7088b024f2d"><div class="ttname"><a href="httpc_8h.html#af22f3288fe1b978fb1c1e7088b024f2d">httpcCreateRootCertChain</a></div><div class="ttdeci">Result httpcCreateRootCertChain(u32 *RootCertChain_contexthandle)</div><div class="ttdoc">Creates a RootCertChain.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_af29138760e47d6d90bd47577d17d07cf"><div class="ttname"><a href="httpc_8h.html#af29138760e47d6d90bd47577d17d07cf">httpcRootCertChainRemoveCert</a></div><div class="ttdeci">Result httpcRootCertChainRemoveCert(u32 RootCertChain_contexthandle, u32 cert_contexthandle)</div><div class="ttdoc">Removes a cert from a RootCertChain.</div></div>
|
|
<div class="ttc" id="ahttpc_8h_html_afb5aa819772f7aa0540a304425f8c566"><div class="ttname"><a href="httpc_8h.html#afb5aa819772f7aa0540a304425f8c566">httpcRootCertChainAddCert</a></div><div class="ttdeci">Result httpcRootCertChainAddCert(u32 RootCertChain_contexthandle, const u8 *cert, u32 certsize, u32 *cert_contexthandle)</div><div class="ttdoc">Adds a RootCA cert to a RootCertChain.</div></div>
|
|
<div class="ttc" id="astructhttpcContext_html"><div class="ttname"><a href="structhttpcContext.html">httpcContext</a></div><div class="ttdoc">HTTP context.</div><div class="ttdef"><b>Definition:</b> httpc.h:8</div></div>
|
|
<div class="ttc" id="astructhttpcContext_html_a026a48ba3da27fee529b344e256d612f"><div class="ttname"><a href="structhttpcContext.html#a026a48ba3da27fee529b344e256d612f">httpcContext::servhandle</a></div><div class="ttdeci">Handle servhandle</div><div class="ttdoc">Service handle.</div><div class="ttdef"><b>Definition:</b> httpc.h:9</div></div>
|
|
<div class="ttc" id="astructhttpcContext_html_af77b3063ba2ea67ee4971a8a5407cb88"><div class="ttname"><a href="structhttpcContext.html#af77b3063ba2ea67ee4971a8a5407cb88">httpcContext::httphandle</a></div><div class="ttdeci">u32 httphandle</div><div class="ttdoc">HTTP handle.</div><div class="ttdef"><b>Definition:</b> httpc.h:10</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:24</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
|
|
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
</div><!-- fragment --></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>
|