api__msg_8c.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>lwIP: src/api/api_msg.c File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20. <script type="text/javascript" src="search/searchdata.js"></script>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 56px;">
  30. <td id="projectalign" style="padding-left: 0.5em;">
  31. <div id="projectname">lwIP
  32. &#160;<span id="projectnumber">2.1.2</span>
  33. </div>
  34. <div id="projectbrief">Lightweight IP stack</div>
  35. </td>
  36. </tr>
  37. </tbody>
  38. </table>
  39. </div>
  40. <!-- end header part -->
  41. <!-- Generated by Doxygen 1.8.13 -->
  42. <script type="text/javascript">
  43. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  44. </script>
  45. <script type="text/javascript" src="menudata.js"></script>
  46. <script type="text/javascript" src="menu.js"></script>
  47. <script type="text/javascript">
  48. $(function() {
  49. initMenu('',true,false,'search.php','Search');
  50. $(document).ready(function() { init_search(); });
  51. });
  52. </script>
  53. <div id="main-nav"></div>
  54. </div><!-- top -->
  55. <div id="side-nav" class="ui-resizable side-nav-resizable">
  56. <div id="nav-tree">
  57. <div id="nav-tree-contents">
  58. <div id="nav-sync" class="sync"></div>
  59. </div>
  60. </div>
  61. <div id="splitbar" style="-moz-user-select:none;"
  62. class="ui-resizable-handle">
  63. </div>
  64. </div>
  65. <script type="text/javascript">
  66. $(document).ready(function(){initNavTree('api__msg_8c.html','');});
  67. </script>
  68. <div id="doc-content">
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. </div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#func-members">Functions</a> </div>
  84. <div class="headertitle">
  85. <div class="title">api_msg.c File Reference</div> </div>
  86. </div><!--header-->
  87. <div class="contents">
  88. <div class="textblock"><code>#include &quot;<a class="el" href="opt_8h.html">lwip/opt.h</a>&quot;</code><br />
  89. <code>#include &quot;<a class="el" href="api__msg_8h.html">lwip/priv/api_msg.h</a>&quot;</code><br />
  90. <code>#include &quot;<a class="el" href="ip_8h.html">lwip/ip.h</a>&quot;</code><br />
  91. <code>#include &quot;<a class="el" href="ip__addr_8h.html">lwip/ip_addr.h</a>&quot;</code><br />
  92. <code>#include &quot;<a class="el" href="udp_8h.html">lwip/udp.h</a>&quot;</code><br />
  93. <code>#include &quot;<a class="el" href="tcp_8h.html">lwip/tcp.h</a>&quot;</code><br />
  94. <code>#include &quot;<a class="el" href="raw_8h.html">lwip/raw.h</a>&quot;</code><br />
  95. <code>#include &quot;<a class="el" href="memp_8h.html">lwip/memp.h</a>&quot;</code><br />
  96. <code>#include &quot;<a class="el" href="igmp_8h.html">lwip/igmp.h</a>&quot;</code><br />
  97. <code>#include &quot;<a class="el" href="dns_8h.html">lwip/dns.h</a>&quot;</code><br />
  98. <code>#include &quot;<a class="el" href="mld6_8h.html">lwip/mld6.h</a>&quot;</code><br />
  99. <code>#include &quot;<a class="el" href="tcpip__priv_8h.html">lwip/priv/tcpip_priv.h</a>&quot;</code><br />
  100. <code>#include &lt;string.h&gt;</code><br />
  101. </div><table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  103. Functions</h2></td></tr>
  104. <tr class="memitem:abc6e1a4f8dd4640ab00eae4bbfdb7236"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#abc6e1a4f8dd4640ab00eae4bbfdb7236">lwip_netconn_do_newconn</a> (void *m)</td></tr>
  105. <tr class="separator:abc6e1a4f8dd4640ab00eae4bbfdb7236"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a919865fa64270a3e4cb719ddff2fead9"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structnetconn.html">netconn</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#a919865fa64270a3e4cb719ddff2fead9">netconn_alloc</a> (enum <a class="el" href="group__netconn__common.html#gaaba260d28d105fb4bce9185fd0300d91">netconn_type</a> t, <a class="el" href="api_8h.html#a3e130339f00202b3ab714af502163a2d">netconn_callback</a> callback)</td></tr>
  107. <tr class="separator:a919865fa64270a3e4cb719ddff2fead9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a875b82ad129bdec1c6f2c21cbeedc48b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#a875b82ad129bdec1c6f2c21cbeedc48b">netconn_free</a> (struct <a class="el" href="structnetconn.html">netconn</a> *conn)</td></tr>
  109. <tr class="separator:a875b82ad129bdec1c6f2c21cbeedc48b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a9e77da8492e93d570bc1ec37f3c91d59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#a9e77da8492e93d570bc1ec37f3c91d59">lwip_netconn_do_delconn</a> (void *m)</td></tr>
  111. <tr class="separator:a9e77da8492e93d570bc1ec37f3c91d59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:aa8e265922cda9f7fd54bf39e4ecf3768"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#aa8e265922cda9f7fd54bf39e4ecf3768">lwip_netconn_do_bind</a> (void *m)</td></tr>
  113. <tr class="separator:aa8e265922cda9f7fd54bf39e4ecf3768"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:af4fed475f06818552ffefc8a1eda6605"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#af4fed475f06818552ffefc8a1eda6605">lwip_netconn_do_bind_if</a> (void *m)</td></tr>
  115. <tr class="separator:af4fed475f06818552ffefc8a1eda6605"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a6f18f57eeda7b0596110930e696f9902"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#a6f18f57eeda7b0596110930e696f9902">lwip_netconn_do_connect</a> (void *m)</td></tr>
  117. <tr class="separator:a6f18f57eeda7b0596110930e696f9902"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:adec8a5ddbcbdacba099c630c8310d34a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#adec8a5ddbcbdacba099c630c8310d34a">lwip_netconn_do_disconnect</a> (void *m)</td></tr>
  119. <tr class="separator:adec8a5ddbcbdacba099c630c8310d34a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:aa7d753d86818bfd77c1d73dab8dc943f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#aa7d753d86818bfd77c1d73dab8dc943f">lwip_netconn_do_listen</a> (void *m)</td></tr>
  121. <tr class="separator:aa7d753d86818bfd77c1d73dab8dc943f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ac714bdd3d57e34f0a6517a469d80df6c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#ac714bdd3d57e34f0a6517a469d80df6c">lwip_netconn_do_send</a> (void *m)</td></tr>
  123. <tr class="separator:ac714bdd3d57e34f0a6517a469d80df6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ab6ae6036baf5c8fef22228ceb5e3ff9f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#ab6ae6036baf5c8fef22228ceb5e3ff9f">lwip_netconn_do_recv</a> (void *m)</td></tr>
  125. <tr class="separator:ab6ae6036baf5c8fef22228ceb5e3ff9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:afc455a5f63fa3bc85022e34861a2fea5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#afc455a5f63fa3bc85022e34861a2fea5">lwip_netconn_do_accepted</a> (void *m)</td></tr>
  127. <tr class="separator:afc455a5f63fa3bc85022e34861a2fea5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:aca4545a471ead1bc673ea93fe85f7e5c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#aca4545a471ead1bc673ea93fe85f7e5c">lwip_netconn_do_write</a> (void *m)</td></tr>
  129. <tr class="separator:aca4545a471ead1bc673ea93fe85f7e5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:af33f432db6e3f111d4ee5876089e4163"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#af33f432db6e3f111d4ee5876089e4163">lwip_netconn_do_getaddr</a> (void *m)</td></tr>
  131. <tr class="separator:af33f432db6e3f111d4ee5876089e4163"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:aff73e0fcdc13c7cb97a4bfbd71a4347d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#aff73e0fcdc13c7cb97a4bfbd71a4347d">lwip_netconn_do_close</a> (void *m)</td></tr>
  133. <tr class="separator:aff73e0fcdc13c7cb97a4bfbd71a4347d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a7402b52416828906a5679828cce37546"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#a7402b52416828906a5679828cce37546">lwip_netconn_do_join_leave_group</a> (void *m)</td></tr>
  135. <tr class="separator:a7402b52416828906a5679828cce37546"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:aacc47257c0a5aa5eb107da0cfc699722"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#aacc47257c0a5aa5eb107da0cfc699722">lwip_netconn_do_join_leave_group_netif</a> (void *m)</td></tr>
  137. <tr class="separator:aacc47257c0a5aa5eb107da0cfc699722"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:afd3802b2f12e27928ccc0f759b887d61"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="api__msg_8c.html#afd3802b2f12e27928ccc0f759b887d61">lwip_netconn_do_gethostbyname</a> (void *arg)</td></tr>
  139. <tr class="separator:afd3802b2f12e27928ccc0f759b887d61"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table>
  141. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  142. <div class="textblock"><p>Sequential API Internal module </p>
  143. </div><h2 class="groupheader">Function Documentation</h2>
  144. <a id="afc455a5f63fa3bc85022e34861a2fea5"></a>
  145. <h2 class="memtitle"><span class="permalink"><a href="#afc455a5f63fa3bc85022e34861a2fea5">&#9670;&nbsp;</a></span>lwip_netconn_do_accepted()</h2>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">void lwip_netconn_do_accepted </td>
  151. <td>(</td>
  152. <td class="paramtype">void *&#160;</td>
  153. <td class="paramname"><em>m</em></td><td>)</td>
  154. <td></td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <p>Indicate that a TCP pcb has been accepted Called from netconn_accept</p>
  159. <dl class="params"><dt>Parameters</dt><dd>
  160. <table class="params">
  161. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  162. </table>
  163. </dd>
  164. </dl>
  165. </div>
  166. </div>
  167. <a id="aa8e265922cda9f7fd54bf39e4ecf3768"></a>
  168. <h2 class="memtitle"><span class="permalink"><a href="#aa8e265922cda9f7fd54bf39e4ecf3768">&#9670;&nbsp;</a></span>lwip_netconn_do_bind()</h2>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">void lwip_netconn_do_bind </td>
  174. <td>(</td>
  175. <td class="paramtype">void *&#160;</td>
  176. <td class="paramname"><em>m</em></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>Bind a pcb contained in a netconn Called from netconn_bind.</p>
  182. <dl class="params"><dt>Parameters</dt><dd>
  183. <table class="params">
  184. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection and containing the IP address and port to bind to </td></tr>
  185. </table>
  186. </dd>
  187. </dl>
  188. </div>
  189. </div>
  190. <a id="af4fed475f06818552ffefc8a1eda6605"></a>
  191. <h2 class="memtitle"><span class="permalink"><a href="#af4fed475f06818552ffefc8a1eda6605">&#9670;&nbsp;</a></span>lwip_netconn_do_bind_if()</h2>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">void lwip_netconn_do_bind_if </td>
  197. <td>(</td>
  198. <td class="paramtype">void *&#160;</td>
  199. <td class="paramname"><em>m</em></td><td>)</td>
  200. <td></td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>Bind a pcb contained in a netconn to an interface Called from netconn_bind_if.</p>
  205. <dl class="params"><dt>Parameters</dt><dd>
  206. <table class="params">
  207. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection and containing the IP address and port to bind to </td></tr>
  208. </table>
  209. </dd>
  210. </dl>
  211. </div>
  212. </div>
  213. <a id="aff73e0fcdc13c7cb97a4bfbd71a4347d"></a>
  214. <h2 class="memtitle"><span class="permalink"><a href="#aff73e0fcdc13c7cb97a4bfbd71a4347d">&#9670;&nbsp;</a></span>lwip_netconn_do_close()</h2>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">void lwip_netconn_do_close </td>
  220. <td>(</td>
  221. <td class="paramtype">void *&#160;</td>
  222. <td class="paramname"><em>m</em></td><td>)</td>
  223. <td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Close or half-shutdown a TCP pcb contained in a netconn Called from netconn_close In contrast to closing sockets, the netconn is not deallocated.</p>
  228. <dl class="params"><dt>Parameters</dt><dd>
  229. <table class="params">
  230. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  231. </table>
  232. </dd>
  233. </dl>
  234. </div>
  235. </div>
  236. <a id="a6f18f57eeda7b0596110930e696f9902"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#a6f18f57eeda7b0596110930e696f9902">&#9670;&nbsp;</a></span>lwip_netconn_do_connect()</h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">void lwip_netconn_do_connect </td>
  243. <td>(</td>
  244. <td class="paramtype">void *&#160;</td>
  245. <td class="paramname"><em>m</em></td><td>)</td>
  246. <td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Connect a pcb contained inside a netconn Called from netconn_connect.</p>
  251. <dl class="params"><dt>Parameters</dt><dd>
  252. <table class="params">
  253. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection and containing the IP address and port to connect to </td></tr>
  254. </table>
  255. </dd>
  256. </dl>
  257. </div>
  258. </div>
  259. <a id="a9e77da8492e93d570bc1ec37f3c91d59"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#a9e77da8492e93d570bc1ec37f3c91d59">&#9670;&nbsp;</a></span>lwip_netconn_do_delconn()</h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">void lwip_netconn_do_delconn </td>
  266. <td>(</td>
  267. <td class="paramtype">void *&#160;</td>
  268. <td class="paramname"><em>m</em></td><td>)</td>
  269. <td></td>
  270. </tr>
  271. </table>
  272. </div><div class="memdoc">
  273. <p>Delete the pcb inside a netconn. Called from netconn_delete.</p>
  274. <dl class="params"><dt>Parameters</dt><dd>
  275. <table class="params">
  276. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  277. </table>
  278. </dd>
  279. </dl>
  280. </div>
  281. </div>
  282. <a id="adec8a5ddbcbdacba099c630c8310d34a"></a>
  283. <h2 class="memtitle"><span class="permalink"><a href="#adec8a5ddbcbdacba099c630c8310d34a">&#9670;&nbsp;</a></span>lwip_netconn_do_disconnect()</h2>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">void lwip_netconn_do_disconnect </td>
  289. <td>(</td>
  290. <td class="paramtype">void *&#160;</td>
  291. <td class="paramname"><em>m</em></td><td>)</td>
  292. <td></td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Disconnect a pcb contained inside a netconn Only used for UDP netconns. Called from netconn_disconnect.</p>
  297. <dl class="params"><dt>Parameters</dt><dd>
  298. <table class="params">
  299. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection to disconnect </td></tr>
  300. </table>
  301. </dd>
  302. </dl>
  303. </div>
  304. </div>
  305. <a id="af33f432db6e3f111d4ee5876089e4163"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#af33f432db6e3f111d4ee5876089e4163">&#9670;&nbsp;</a></span>lwip_netconn_do_getaddr()</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">void lwip_netconn_do_getaddr </td>
  312. <td>(</td>
  313. <td class="paramtype">void *&#160;</td>
  314. <td class="paramname"><em>m</em></td><td>)</td>
  315. <td></td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Return a connection's local or remote address Called from netconn_getaddr</p>
  320. <dl class="params"><dt>Parameters</dt><dd>
  321. <table class="params">
  322. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  323. </table>
  324. </dd>
  325. </dl>
  326. </div>
  327. </div>
  328. <a id="afd3802b2f12e27928ccc0f759b887d61"></a>
  329. <h2 class="memtitle"><span class="permalink"><a href="#afd3802b2f12e27928ccc0f759b887d61">&#9670;&nbsp;</a></span>lwip_netconn_do_gethostbyname()</h2>
  330. <div class="memitem">
  331. <div class="memproto">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname">void lwip_netconn_do_gethostbyname </td>
  335. <td>(</td>
  336. <td class="paramtype">void *&#160;</td>
  337. <td class="paramname"><em>arg</em></td><td>)</td>
  338. <td></td>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>Execute a DNS query Called from netconn_gethostbyname</p>
  343. <dl class="params"><dt>Parameters</dt><dd>
  344. <table class="params">
  345. <tr><td class="paramname">arg</td><td>the <a class="el" href="structdns__api__msg.html">dns_api_msg</a> pointing to the query </td></tr>
  346. </table>
  347. </dd>
  348. </dl>
  349. </div>
  350. </div>
  351. <a id="a7402b52416828906a5679828cce37546"></a>
  352. <h2 class="memtitle"><span class="permalink"><a href="#a7402b52416828906a5679828cce37546">&#9670;&nbsp;</a></span>lwip_netconn_do_join_leave_group()</h2>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="memname">
  356. <tr>
  357. <td class="memname">void lwip_netconn_do_join_leave_group </td>
  358. <td>(</td>
  359. <td class="paramtype">void *&#160;</td>
  360. <td class="paramname"><em>m</em></td><td>)</td>
  361. <td></td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <p>Join multicast groups for UDP netconns. Called from netconn_join_leave_group</p>
  366. <dl class="params"><dt>Parameters</dt><dd>
  367. <table class="params">
  368. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  369. </table>
  370. </dd>
  371. </dl>
  372. </div>
  373. </div>
  374. <a id="aacc47257c0a5aa5eb107da0cfc699722"></a>
  375. <h2 class="memtitle"><span class="permalink"><a href="#aacc47257c0a5aa5eb107da0cfc699722">&#9670;&nbsp;</a></span>lwip_netconn_do_join_leave_group_netif()</h2>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <table class="memname">
  379. <tr>
  380. <td class="memname">void lwip_netconn_do_join_leave_group_netif </td>
  381. <td>(</td>
  382. <td class="paramtype">void *&#160;</td>
  383. <td class="paramname"><em>m</em></td><td>)</td>
  384. <td></td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Join multicast groups for UDP netconns. Called from netconn_join_leave_group_netif</p>
  389. <dl class="params"><dt>Parameters</dt><dd>
  390. <table class="params">
  391. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  392. </table>
  393. </dd>
  394. </dl>
  395. </div>
  396. </div>
  397. <a id="aa7d753d86818bfd77c1d73dab8dc943f"></a>
  398. <h2 class="memtitle"><span class="permalink"><a href="#aa7d753d86818bfd77c1d73dab8dc943f">&#9670;&nbsp;</a></span>lwip_netconn_do_listen()</h2>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">void lwip_netconn_do_listen </td>
  404. <td>(</td>
  405. <td class="paramtype">void *&#160;</td>
  406. <td class="paramname"><em>m</em></td><td>)</td>
  407. <td></td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. <p>Set a TCP pcb contained in a netconn into listen mode Called from netconn_listen.</p>
  412. <dl class="params"><dt>Parameters</dt><dd>
  413. <table class="params">
  414. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  415. </table>
  416. </dd>
  417. </dl>
  418. </div>
  419. </div>
  420. <a id="abc6e1a4f8dd4640ab00eae4bbfdb7236"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#abc6e1a4f8dd4640ab00eae4bbfdb7236">&#9670;&nbsp;</a></span>lwip_netconn_do_newconn()</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">void lwip_netconn_do_newconn </td>
  427. <td>(</td>
  428. <td class="paramtype">void *&#160;</td>
  429. <td class="paramname"><em>m</em></td><td>)</td>
  430. <td></td>
  431. </tr>
  432. </table>
  433. </div><div class="memdoc">
  434. <p>Create a new pcb of a specific type inside a netconn. Called from netconn_new_with_proto_and_callback.</p>
  435. <dl class="params"><dt>Parameters</dt><dd>
  436. <table class="params">
  437. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> describing the connection type </td></tr>
  438. </table>
  439. </dd>
  440. </dl>
  441. </div>
  442. </div>
  443. <a id="ab6ae6036baf5c8fef22228ceb5e3ff9f"></a>
  444. <h2 class="memtitle"><span class="permalink"><a href="#ab6ae6036baf5c8fef22228ceb5e3ff9f">&#9670;&nbsp;</a></span>lwip_netconn_do_recv()</h2>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname">void lwip_netconn_do_recv </td>
  450. <td>(</td>
  451. <td class="paramtype">void *&#160;</td>
  452. <td class="paramname"><em>m</em></td><td>)</td>
  453. <td></td>
  454. </tr>
  455. </table>
  456. </div><div class="memdoc">
  457. <p>Indicate data has been received from a TCP pcb contained in a netconn Called from netconn_recv</p>
  458. <dl class="params"><dt>Parameters</dt><dd>
  459. <table class="params">
  460. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  461. </table>
  462. </dd>
  463. </dl>
  464. </div>
  465. </div>
  466. <a id="ac714bdd3d57e34f0a6517a469d80df6c"></a>
  467. <h2 class="memtitle"><span class="permalink"><a href="#ac714bdd3d57e34f0a6517a469d80df6c">&#9670;&nbsp;</a></span>lwip_netconn_do_send()</h2>
  468. <div class="memitem">
  469. <div class="memproto">
  470. <table class="memname">
  471. <tr>
  472. <td class="memname">void lwip_netconn_do_send </td>
  473. <td>(</td>
  474. <td class="paramtype">void *&#160;</td>
  475. <td class="paramname"><em>m</em></td><td>)</td>
  476. <td></td>
  477. </tr>
  478. </table>
  479. </div><div class="memdoc">
  480. <p>Send some data on a RAW or UDP pcb contained in a netconn Called from netconn_send</p>
  481. <dl class="params"><dt>Parameters</dt><dd>
  482. <table class="params">
  483. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  484. </table>
  485. </dd>
  486. </dl>
  487. </div>
  488. </div>
  489. <a id="aca4545a471ead1bc673ea93fe85f7e5c"></a>
  490. <h2 class="memtitle"><span class="permalink"><a href="#aca4545a471ead1bc673ea93fe85f7e5c">&#9670;&nbsp;</a></span>lwip_netconn_do_write()</h2>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname">void lwip_netconn_do_write </td>
  496. <td>(</td>
  497. <td class="paramtype">void *&#160;</td>
  498. <td class="paramname"><em>m</em></td><td>)</td>
  499. <td></td>
  500. </tr>
  501. </table>
  502. </div><div class="memdoc">
  503. <p>Send some data on a TCP pcb contained in a netconn Called from netconn_write</p>
  504. <dl class="params"><dt>Parameters</dt><dd>
  505. <table class="params">
  506. <tr><td class="paramname">m</td><td>the <a class="el" href="structapi__msg.html">api_msg</a> pointing to the connection </td></tr>
  507. </table>
  508. </dd>
  509. </dl>
  510. </div>
  511. </div>
  512. <a id="a919865fa64270a3e4cb719ddff2fead9"></a>
  513. <h2 class="memtitle"><span class="permalink"><a href="#a919865fa64270a3e4cb719ddff2fead9">&#9670;&nbsp;</a></span>netconn_alloc()</h2>
  514. <div class="memitem">
  515. <div class="memproto">
  516. <table class="memname">
  517. <tr>
  518. <td class="memname">struct <a class="el" href="structnetconn.html">netconn</a>* netconn_alloc </td>
  519. <td>(</td>
  520. <td class="paramtype">enum <a class="el" href="group__netconn__common.html#gaaba260d28d105fb4bce9185fd0300d91">netconn_type</a>&#160;</td>
  521. <td class="paramname"><em>t</em>, </td>
  522. </tr>
  523. <tr>
  524. <td class="paramkey"></td>
  525. <td></td>
  526. <td class="paramtype"><a class="el" href="api_8h.html#a3e130339f00202b3ab714af502163a2d">netconn_callback</a>&#160;</td>
  527. <td class="paramname"><em>callback</em>&#160;</td>
  528. </tr>
  529. <tr>
  530. <td></td>
  531. <td>)</td>
  532. <td></td><td></td>
  533. </tr>
  534. </table>
  535. </div><div class="memdoc">
  536. <p>Create a new netconn (of a specific type) that has a callback function. The corresponding pcb is NOT created!</p>
  537. <dl class="params"><dt>Parameters</dt><dd>
  538. <table class="params">
  539. <tr><td class="paramname">t</td><td>the type of 'connection' to create (</td></tr>
  540. </table>
  541. </dd>
  542. </dl>
  543. <dl class="section see"><dt>See also</dt><dd>enum <a class="el" href="group__netconn__common.html#gaaba260d28d105fb4bce9185fd0300d91">netconn_type</a>) </dd></dl>
  544. <dl class="params"><dt>Parameters</dt><dd>
  545. <table class="params">
  546. <tr><td class="paramname">callback</td><td>a function to call on status changes (RX available, TX'ed) </td></tr>
  547. </table>
  548. </dd>
  549. </dl>
  550. <dl class="section return"><dt>Returns</dt><dd>a newly allocated struct netconn or NULL on memory error </dd></dl>
  551. </div>
  552. </div>
  553. <a id="a875b82ad129bdec1c6f2c21cbeedc48b"></a>
  554. <h2 class="memtitle"><span class="permalink"><a href="#a875b82ad129bdec1c6f2c21cbeedc48b">&#9670;&nbsp;</a></span>netconn_free()</h2>
  555. <div class="memitem">
  556. <div class="memproto">
  557. <table class="memname">
  558. <tr>
  559. <td class="memname">void netconn_free </td>
  560. <td>(</td>
  561. <td class="paramtype">struct <a class="el" href="structnetconn.html">netconn</a> *&#160;</td>
  562. <td class="paramname"><em>conn</em></td><td>)</td>
  563. <td></td>
  564. </tr>
  565. </table>
  566. </div><div class="memdoc">
  567. <p>Delete a netconn and all its resources. The pcb is NOT freed (since we might not be in the right thread context do this).</p>
  568. <dl class="params"><dt>Parameters</dt><dd>
  569. <table class="params">
  570. <tr><td class="paramname">conn</td><td>the netconn to free </td></tr>
  571. </table>
  572. </dd>
  573. </dl>
  574. </div>
  575. </div>
  576. </div><!-- contents -->
  577. </div><!-- doc-content -->
  578. <!-- start footer part -->
  579. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  580. <ul>
  581. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_da61e3e9a357748887e3ca8d7c5a0c16.html">api</a></li><li class="navelem"><a class="el" href="api__msg_8c.html">api_msg.c</a></li>
  582. <li class="footer">Generated by
  583. <a href="http://www.doxygen.org/index.html">
  584. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  585. </ul>
  586. </div>
  587. </body>
  588. </html>