natas_hw
/
paho
mirror of https://github.com/eclipse/paho.mqtt.c
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
paho/docs/MQTTClient_internal/html/structSockets.html

136 lines
9.1 KiB
HTML
Raw Permalink Blame History

<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MQTT C Client Libraries Internals: Sockets 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>
<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="projectlogo"><img alt="Logo" src="pahologo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MQTT C Client Libraries Internals
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">Sockets Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Structure to hold all socket data for the module.
<a href="structSockets.html#details">More...</a></p>
<p><code>#include &lt;Socket.h&gt;</code></p>
<div class="dynheader">
Collaboration diagram for Sockets:</div>
<div class="dyncontent">
<div class="center"><img src="structSockets__coll__graph.png" border="0" usemap="#Sockets_coll__map" alt="Collaboration graph"/></div>
<map name="Sockets_coll__map" id="Sockets_coll__map">
<area shape="rect" title="Structure to hold all socket data for the module." alt="" coords="33,245,104,272"/>
<area shape="rect" href="structListElementStruct.html" title="Structure to hold all data for one list element." alt="" coords="5,7,132,33"/>
<area shape="rect" href="structList.html" title="Structure to hold all data for one list." alt="" coords="153,127,197,153"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:aa56708bbaf392eb8d372d01f6bd2e7e8"><td class="memItemLeft" align="right" valign="top"><a id="aa56708bbaf392eb8d372d01f6bd2e7e8"></a>
fd_set&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#aa56708bbaf392eb8d372d01f6bd2e7e8">rset</a></td></tr>
<tr class="memdesc:aa56708bbaf392eb8d372d01f6bd2e7e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">socket read set (see select doc) <br /></td></tr>
<tr class="separator:aa56708bbaf392eb8d372d01f6bd2e7e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e2c4da3be7756df304ed1aaef86b894"><td class="memItemLeft" align="right" valign="top"><a id="a1e2c4da3be7756df304ed1aaef86b894"></a>
fd_set&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a1e2c4da3be7756df304ed1aaef86b894">rset_saved</a></td></tr>
<tr class="memdesc:a1e2c4da3be7756df304ed1aaef86b894"><td class="mdescLeft">&#160;</td><td class="mdescRight">saved socket read set <br /></td></tr>
<tr class="separator:a1e2c4da3be7756df304ed1aaef86b894"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af528092a8513ffbb0d3c342503835a47"><td class="memItemLeft" align="right" valign="top"><a id="af528092a8513ffbb0d3c342503835a47"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#af528092a8513ffbb0d3c342503835a47">maxfdp1</a></td></tr>
<tr class="memdesc:af528092a8513ffbb0d3c342503835a47"><td class="mdescLeft">&#160;</td><td class="mdescRight">max descriptor used +1 (again see select doc) <br /></td></tr>
<tr class="separator:af528092a8513ffbb0d3c342503835a47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dc0c5bf258cdb8dc1617a7a122caa7e"><td class="memItemLeft" align="right" valign="top"><a id="a7dc0c5bf258cdb8dc1617a7a122caa7e"></a>
<a class="el" href="structList.html">List</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a7dc0c5bf258cdb8dc1617a7a122caa7e">clientsds</a></td></tr>
<tr class="memdesc:a7dc0c5bf258cdb8dc1617a7a122caa7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of client socket descriptors <br /></td></tr>
<tr class="separator:a7dc0c5bf258cdb8dc1617a7a122caa7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a310c298235783930aaa043a85e556b51"><td class="memItemLeft" align="right" valign="top"><a id="a310c298235783930aaa043a85e556b51"></a>
<a class="el" href="structListElementStruct.html">ListElement</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a310c298235783930aaa043a85e556b51">cur_clientsds</a></td></tr>
<tr class="memdesc:a310c298235783930aaa043a85e556b51"><td class="mdescLeft">&#160;</td><td class="mdescRight">current client socket descriptor (iterator) <br /></td></tr>
<tr class="separator:a310c298235783930aaa043a85e556b51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1b74c5f7fd463159318d2ef3c8fcee6"><td class="memItemLeft" align="right" valign="top"><a id="ac1b74c5f7fd463159318d2ef3c8fcee6"></a>
<a class="el" href="structList.html">List</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#ac1b74c5f7fd463159318d2ef3c8fcee6">connect_pending</a></td></tr>
<tr class="memdesc:ac1b74c5f7fd463159318d2ef3c8fcee6"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of sockets for which a connect is pending <br /></td></tr>
<tr class="separator:ac1b74c5f7fd463159318d2ef3c8fcee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a852db7c3edf654d8ee451be18b3f5743"><td class="memItemLeft" align="right" valign="top"><a id="a852db7c3edf654d8ee451be18b3f5743"></a>
<a class="el" href="structList.html">List</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a852db7c3edf654d8ee451be18b3f5743">write_pending</a></td></tr>
<tr class="memdesc:a852db7c3edf654d8ee451be18b3f5743"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of sockets for which a write is pending <br /></td></tr>
<tr class="separator:a852db7c3edf654d8ee451be18b3f5743"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a410464774efcdea446293ed6d4ea9c94"><td class="memItemLeft" align="right" valign="top"><a id="a410464774efcdea446293ed6d4ea9c94"></a>
fd_set&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a410464774efcdea446293ed6d4ea9c94">pending_wset</a></td></tr>
<tr class="memdesc:a410464774efcdea446293ed6d4ea9c94"><td class="mdescLeft">&#160;</td><td class="mdescRight">socket pending write set for select <br /></td></tr>
<tr class="separator:a410464774efcdea446293ed6d4ea9c94"><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>Structure to hold all socket data for the module. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>Socket.h</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon May 24 2021 18:05:54 for MQTT C Client Libraries Internals by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink