395 lines
18 KiB
HTML
395 lines
18 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.8.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>lwIP: api_msg Struct Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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">lwIP
|
|
 <span id="projectnumber">2.2.1</span>
|
|
</div>
|
|
<div id="projectbrief">Lightweight IP stack</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<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');
|
|
/* @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>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('structapi__msg.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">api_msg Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <api_msg.h></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:abec5e33802d69f1b601543d60699f028"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structnetconn.html">netconn</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapi__msg.html#abec5e33802d69f1b601543d60699f028">conn</a></td></tr>
|
|
<tr class="separator:abec5e33802d69f1b601543d60699f028"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c66bd95217fa627f13f2f0847bbb25f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structapi__msg.html#a8c66bd95217fa627f13f2f0847bbb25f">err</a></td></tr>
|
|
<tr class="separator:a8c66bd95217fa627f13f2f0847bbb25f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af525b0f6060c444b40c159a63c811f43"><td class="memItemLeft" >union {</td></tr>
|
|
<tr class="memitem:a247344c2290f471588b0ee6548a8e487"><td class="memItemLeft" >   struct <a class="el" href="structnetbuf.html">netbuf</a> *   <a class="el" href="structapi__msg.html#ab0abd60527e96cc24c2c20c835cdac05">b</a></td></tr>
|
|
<tr class="separator:a247344c2290f471588b0ee6548a8e487"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae317351c9e5b544afdc33c529ee9b37b"><td class="memItemLeft" >   struct {</td></tr>
|
|
<tr class="memitem:ae317351c9e5b544afdc33c529ee9b37b"><td class="memItemLeft" valign="top">   }   <a class="el" href="structapi__msg.html#a8f0dd41f75454c18db3d091691a4aed1">n</a></td></tr>
|
|
<tr class="separator:ae317351c9e5b544afdc33c529ee9b37b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc8b04e40d27555a932f7f63cf952d5c"><td class="memItemLeft" >   struct {</td></tr>
|
|
<tr class="memitem:afc8b04e40d27555a932f7f63cf952d5c"><td class="memItemLeft" valign="top">   }   <a class="el" href="structapi__msg.html#a0a33b01e3b7db8869f3ac6986063d8bc">bc</a></td></tr>
|
|
<tr class="separator:afc8b04e40d27555a932f7f63cf952d5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a140a909b1d8a9e040603da4f314ea3a2"><td class="memItemLeft" >   struct {</td></tr>
|
|
<tr class="memitem:a140a909b1d8a9e040603da4f314ea3a2"><td class="memItemLeft" valign="top">   }   <a class="el" href="structapi__msg.html#a72be8f70a573c80b5984a9facc5ab514">ad</a></td></tr>
|
|
<tr class="separator:a140a909b1d8a9e040603da4f314ea3a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b3d9bb6067dfa47b7877e0fcad5f3d1"><td class="memItemLeft" >   struct {</td></tr>
|
|
<tr class="memitem:af35e9ac4255e0e4c9dd1769f4be47a7f"><td class="memItemLeft" >      const struct <a class="el" href="structnetvector.html">netvector</a> *   <a class="el" href="structapi__msg.html#a1ceb9822ba49ba439e30d98492593612">vector</a></td></tr>
|
|
<tr class="separator:af35e9ac4255e0e4c9dd1769f4be47a7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbac7be0bb6115ec0c8f3e32a718c7e6"><td class="memItemLeft" >      u16_t   <a class="el" href="structapi__msg.html#ab6f14157a3e6735b69a569249d3286a2">vector_cnt</a></td></tr>
|
|
<tr class="separator:adbac7be0bb6115ec0c8f3e32a718c7e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa27946d23420465162f44ce911aaba66"><td class="memItemLeft" >      size_t   <a class="el" href="structapi__msg.html#a6896ae78ebddefdf2d8358ab5f21f444">vector_off</a></td></tr>
|
|
<tr class="separator:aa27946d23420465162f44ce911aaba66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a740b7491aab5003eb3dc0f02f0883915"><td class="memItemLeft" >      size_t   <a class="el" href="structapi__msg.html#a40624c398d1939bfee54bffa708a363e">len</a></td></tr>
|
|
<tr class="separator:a740b7491aab5003eb3dc0f02f0883915"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac56f4c9c1ef63ee959993d529dc03faa"><td class="memItemLeft" >      size_t   <a class="el" href="structapi__msg.html#a4bd9382dd42b18120803e246a0203353">offset</a></td></tr>
|
|
<tr class="separator:ac56f4c9c1ef63ee959993d529dc03faa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b3d9bb6067dfa47b7877e0fcad5f3d1"><td class="memItemLeft" valign="top">   }   <a class="el" href="structapi__msg.html#a111e1c280f86a030ae0cdb9015ab10b9">w</a></td></tr>
|
|
<tr class="separator:a0b3d9bb6067dfa47b7877e0fcad5f3d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa57da01424bc5398880480e8650a1363"><td class="memItemLeft" >   struct {</td></tr>
|
|
<tr class="memitem:aa57da01424bc5398880480e8650a1363"><td class="memItemLeft" valign="top">   }   <a class="el" href="structapi__msg.html#a77b5f2c0844a967f6509444aedf2c1f7">r</a></td></tr>
|
|
<tr class="separator:aa57da01424bc5398880480e8650a1363"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a457291c75efa297c1c12f087ae08f5b4"><td class="memItemLeft" >   struct {</td></tr>
|
|
<tr class="memitem:a457291c75efa297c1c12f087ae08f5b4"><td class="memItemLeft" valign="top">   }   <a class="el" href="structapi__msg.html#ace4d7afbfa85632c67ef34ea5f8f310b">sd</a></td></tr>
|
|
<tr class="separator:a457291c75efa297c1c12f087ae08f5b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a618b2c77b3fed08d8d80d18636ee67ca"><td class="memItemLeft" >   struct {</td></tr>
|
|
<tr class="memitem:a618b2c77b3fed08d8d80d18636ee67ca"><td class="memItemLeft" valign="top">   }   <a class="el" href="structapi__msg.html#a7857015bc617bee22ac4a065e6bdef0b">jl</a></td></tr>
|
|
<tr class="separator:a618b2c77b3fed08d8d80d18636ee67ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af525b0f6060c444b40c159a63c811f43"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structapi__msg.html#af525b0f6060c444b40c159a63c811f43">msg</a></td></tr>
|
|
<tr class="separator:af525b0f6060c444b40c159a63c811f43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This struct includes everything that is necessary to execute a function for a netconn in another thread context (mainly used to process netconns in the tcpip_thread context to be thread safe). </p>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a72be8f70a573c80b5984a9facc5ab514"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a72be8f70a573c80b5984a9facc5ab514">◆ </a></span>ad</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct { ... } api_msg::ad</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>used for lwip_netconn_do_getaddr </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0abd60527e96cc24c2c20c835cdac05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0abd60527e96cc24c2c20c835cdac05">◆ </a></span>b</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct <a class="el" href="structnetbuf.html">netbuf</a>* api_msg::b</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>used for lwip_netconn_do_send </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a33b01e3b7db8869f3ac6986063d8bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a33b01e3b7db8869f3ac6986063d8bc">◆ </a></span>bc</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct { ... } api_msg::bc</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>used for lwip_netconn_do_bind and lwip_netconn_do_connect </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abec5e33802d69f1b601543d60699f028"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abec5e33802d69f1b601543d60699f028">◆ </a></span>conn</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct <a class="el" href="structnetconn.html">netconn</a>* api_msg::conn</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The netconn which to process - always needed: it includes the semaphore which is used to block the application thread until the function finished. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c66bd95217fa627f13f2f0847bbb25f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c66bd95217fa627f13f2f0847bbb25f">◆ </a></span>err</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> api_msg::err</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>The return value of the function executed in tcpip_thread. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7857015bc617bee22ac4a065e6bdef0b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7857015bc617bee22ac4a065e6bdef0b">◆ </a></span>jl</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct { ... } api_msg::jl</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>used for lwip_netconn_do_join_leave_group </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40624c398d1939bfee54bffa708a363e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40624c398d1939bfee54bffa708a363e">◆ </a></span>len</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t api_msg::len</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>total length across vectors </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af525b0f6060c444b40c159a63c811f43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af525b0f6060c444b40c159a63c811f43">◆ </a></span>msg</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">union { ... } api_msg::msg</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Depending on the executed function, one of these union members is used </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f0dd41f75454c18db3d091691a4aed1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f0dd41f75454c18db3d091691a4aed1">◆ </a></span>n</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct { ... } api_msg::n</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>used for lwip_netconn_do_newconn </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4bd9382dd42b18120803e246a0203353"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4bd9382dd42b18120803e246a0203353">◆ </a></span>offset</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t api_msg::offset</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>offset into total length/output of bytes written when err == ERR_OK </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a77b5f2c0844a967f6509444aedf2c1f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77b5f2c0844a967f6509444aedf2c1f7">◆ </a></span>r</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct { ... } api_msg::r</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>used for lwip_netconn_do_recv </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ace4d7afbfa85632c67ef34ea5f8f310b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ace4d7afbfa85632c67ef34ea5f8f310b">◆ </a></span>sd</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct { ... } api_msg::sd</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>used for lwip_netconn_do_close (/shutdown) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1ceb9822ba49ba439e30d98492593612"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ceb9822ba49ba439e30d98492593612">◆ </a></span>vector</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const struct <a class="el" href="structnetvector.html">netvector</a>* api_msg::vector</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>current vector to write </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab6f14157a3e6735b69a569249d3286a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6f14157a3e6735b69a569249d3286a2">◆ </a></span>vector_cnt</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">u16_t api_msg::vector_cnt</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>number of unwritten vectors </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6896ae78ebddefdf2d8358ab5f21f444"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6896ae78ebddefdf2d8358ab5f21f444">◆ </a></span>vector_off</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t api_msg::vector_off</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>offset into current vector </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a111e1c280f86a030ae0cdb9015ab10b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a111e1c280f86a030ae0cdb9015ab10b9">◆ </a></span>w</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct { ... } api_msg::w</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>used for lwip_netconn_do_write </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>src/include/lwip/priv/<a class="el" href="api__msg_8h.html">api_msg.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="structapi__msg.html">api_msg</a></li>
|
|
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|