123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157 |
- <!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&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>
- <!-- 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 <Socket.h></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,231,104,257"/>
- <area shape="rect" href="structList.html" title="Structure to hold all data for one list." alt="" coords="47,127,91,153"/>
- <area shape="rect" href="structListElementStruct.html" title="Structure to hold all data for one list element." alt="" coords="5,7,132,33"/>
- </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:ac1b74c5f7fd463159318d2ef3c8fcee6"><td class="memItemLeft" align="right" valign="top"><a id="ac1b74c5f7fd463159318d2ef3c8fcee6"></a>
- <a class="el" href="structList.html">List</a> * </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"> </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"> </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> * </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"> </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"> </td></tr>
- <tr class="memitem:a9bee5974437201a4b7728955de2ebd50"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a9bee5974437201a4b7728955de2ebd50">nfds</a></td></tr>
- <tr class="memdesc:a9bee5974437201a4b7728955de2ebd50"><td class="mdescLeft"> </td><td class="mdescRight">no of file descriptors for poll <a href="structSockets.html#a9bee5974437201a4b7728955de2ebd50">More...</a><br /></td></tr>
- <tr class="separator:a9bee5974437201a4b7728955de2ebd50"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9e91e6577708542a4aab9c43976f7923"><td class="memItemLeft" align="right" valign="top"><a id="a9e91e6577708542a4aab9c43976f7923"></a>
- struct pollfd * </td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a9e91e6577708542a4aab9c43976f7923">fds_read</a></td></tr>
- <tr class="memdesc:a9e91e6577708542a4aab9c43976f7923"><td class="mdescLeft"> </td><td class="mdescRight">poll read file descriptors <br /></td></tr>
- <tr class="separator:a9e91e6577708542a4aab9c43976f7923"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6d20a690336a18c8d832d1eff3a6a02f"><td class="memItemLeft" align="right" valign="top"><a id="a6d20a690336a18c8d832d1eff3a6a02f"></a>
- struct pollfd * </td><td class="memItemRight" valign="bottom"><b>fds_write</b></td></tr>
- <tr class="separator:a6d20a690336a18c8d832d1eff3a6a02f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9541b61559daa5f23fe63576e44f63aa"><td class="memItemLeft" ><a id="a9541b61559daa5f23fe63576e44f63aa"></a>
- struct {</td></tr>
- <tr class="memitem:a790baeb63c2dd4807d9a88019a820939"><td class="memItemLeft" >
-    int   <a class="el" href="structSockets.html#a4ebc1178e3d1516f31b7dbc276cfde2b">cur_fd</a></td></tr>
- <tr class="memdesc:a790baeb63c2dd4807d9a88019a820939"><td class="mdescLeft"> </td><td class="mdescRight">index into the fds_saved array <br /></td></tr>
- <tr class="separator:a790baeb63c2dd4807d9a88019a820939"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8495253a8afdc9328b22e43469565584"><td class="memItemLeft" >
-    unsigned int   <a class="el" href="structSockets.html#a9bee5974437201a4b7728955de2ebd50">nfds</a></td></tr>
- <tr class="memdesc:a8495253a8afdc9328b22e43469565584"><td class="mdescLeft"> </td><td class="mdescRight">number of fds in the fds_saved array <br /></td></tr>
- <tr class="separator:a8495253a8afdc9328b22e43469565584"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad9b00c4836433b27fc2ffdea7a47588a"><td class="memItemLeft" >
-    struct pollfd *   <b>fds_write</b></td></tr>
- <tr class="separator:ad9b00c4836433b27fc2ffdea7a47588a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac14fafaad85ed6a8587fa494e2284fee"><td class="memItemLeft" >
-    struct pollfd *   <b>fds_read</b></td></tr>
- <tr class="separator:ac14fafaad85ed6a8587fa494e2284fee"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9541b61559daa5f23fe63576e44f63aa"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><b>saved</b></td></tr>
- <tr class="separator:a9541b61559daa5f23fe63576e44f63aa"><td class="memSeparator" colspan="2"> </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><h2 class="groupheader">Field Documentation</h2>
- <a id="a9bee5974437201a4b7728955de2ebd50"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9bee5974437201a4b7728955de2ebd50">◆ </a></span>nfds</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">unsigned int Sockets::nfds</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>no of file descriptors for poll </p>
- <p>number of fds in the fds_saved array </p>
- </div>
- </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 Thu Sep 29 2022 11:34:46 for MQTT C Client Libraries Internals by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|