esp8266-std/ESP8266_RTOS_SDK/documents/html/structespconn.html

213 lines
10 KiB
HTML
Raw Normal View History

2018-11-23 01:43:17 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.10"/>
<title>ESP8266_RTOS_SDK: espconn 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="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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">ESP8266_RTOS_SDK
&#160;<span id="projectnumber">v1.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">espconn Struct Reference<div class="ingroups"><a class="el" href="group__Espconn__APIs.html">Network Espconn APIs</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="espconn_8h_source.html">espconn.h</a>&gt;</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:a2431ce92ac5c0bda2b6e5812ba8e3323"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__Espconn__APIs.html#ga822c96862e04f46aff8d65cb8170b60f">espconn_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structespconn.html#a2431ce92ac5c0bda2b6e5812ba8e3323">type</a></td></tr>
<tr class="separator:a2431ce92ac5c0bda2b6e5812ba8e3323"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3a8d9cd6eef4ec46bcabfd07120e40c"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__Espconn__APIs.html#ga27ebed6341108494ecf41ec8a7d37c4b">espconn_state</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structespconn.html#ac3a8d9cd6eef4ec46bcabfd07120e40c">state</a></td></tr>
<tr class="separator:ac3a8d9cd6eef4ec46bcabfd07120e40c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab621821baf11c894c969c4ebb7063b2c"><td class="memItemLeft" ><a class="anchor" id="ab621821baf11c894c969c4ebb7063b2c"></a>
union {</td></tr>
<tr class="memitem:a449a6179b20173e4e51009fc017d2bb7"><td class="memItemLeft" >
&#160;&#160;&#160;<a class="el" href="struct__esp__tcp.html">esp_tcp</a> *&#160;&#160;&#160;<b>tcp</b></td></tr>
<tr class="separator:a449a6179b20173e4e51009fc017d2bb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67cbeea826a6b0c254fcd2ad58ee472c"><td class="memItemLeft" >
&#160;&#160;&#160;<a class="el" href="struct__esp__udp.html">esp_udp</a> *&#160;&#160;&#160;<b>udp</b></td></tr>
<tr class="separator:a67cbeea826a6b0c254fcd2ad58ee472c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab621821baf11c894c969c4ebb7063b2c"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><b>proto</b></td></tr>
<tr class="separator:ab621821baf11c894c969c4ebb7063b2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66d8db64dbb623bab3e442dd923371b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Espconn__APIs.html#ga5c93b1b8d3455a8f4fdeb35b064c4b0f">espconn_recv_callback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structespconn.html#a66d8db64dbb623bab3e442dd923371b5">recv_callback</a></td></tr>
<tr class="separator:a66d8db64dbb623bab3e442dd923371b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee31e3e88191acb2de9dbbc43a40cd47"><td class="memItemLeft" align="right" valign="top">espconn_sent_callback&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structespconn.html#aee31e3e88191acb2de9dbbc43a40cd47">sent_callback</a></td></tr>
<tr class="separator:aee31e3e88191acb2de9dbbc43a40cd47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44c66baf2083925ae34e6ff46e7ec281"><td class="memItemLeft" align="right" valign="top">uint8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structespconn.html#a44c66baf2083925ae34e6ff46e7ec281">link_cnt</a></td></tr>
<tr class="separator:a44c66baf2083925ae34e6ff46e7ec281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaaa8d264a32f8754cf0ffa69f70d8f8d"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structespconn.html#aaaa8d264a32f8754cf0ffa69f70d8f8d">reserve</a></td></tr>
<tr class="separator:aaaa8d264a32f8754cf0ffa69f70d8f8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A espconn descriptor </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a44c66baf2083925ae34e6ff46e7ec281"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8 link_cnt</td>
</tr>
</table>
</div><div class="memdoc">
<p>link count </p>
</div>
</div>
<a class="anchor" id="a66d8db64dbb623bab3e442dd923371b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Espconn__APIs.html#ga5c93b1b8d3455a8f4fdeb35b064c4b0f">espconn_recv_callback</a> recv_callback</td>
</tr>
</table>
</div><div class="memdoc">
<p>data received callback </p>
</div>
</div>
<a class="anchor" id="aaaa8d264a32f8754cf0ffa69f70d8f8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* reserve</td>
</tr>
</table>
</div><div class="memdoc">
<p>reserved for user data </p>
</div>
</div>
<a class="anchor" id="aee31e3e88191acb2de9dbbc43a40cd47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">espconn_sent_callback sent_callback</td>
</tr>
</table>
</div><div class="memdoc">
<p>data sent callback </p>
</div>
</div>
<a class="anchor" id="ac3a8d9cd6eef4ec46bcabfd07120e40c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Espconn__APIs.html#ga27ebed6341108494ecf41ec8a7d37c4b">espconn_state</a> state</td>
</tr>
</table>
</div><div class="memdoc">
<p>current state of the espconn </p>
</div>
</div>
<a class="anchor" id="a2431ce92ac5c0bda2b6e5812ba8e3323"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Espconn__APIs.html#ga822c96862e04f46aff8d65cb8170b60f">espconn_type</a> type</td>
</tr>
</table>
</div><div class="memdoc">
<p>type of the espconn (TCP or UDP) </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/espressif/<a class="el" href="espconn_8h_source.html">espconn.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:27 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>