structSockets.html 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>MQTT C Client Libraries Internals: Sockets Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="pahologo.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">MQTT C Client Libraries Internals
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#pub-attribs">Data Fields</a> </div>
  65. <div class="headertitle">
  66. <div class="title">Sockets Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Structure to hold all socket data for the module.
  70. <a href="structSockets.html#details">More...</a></p>
  71. <p><code>#include &lt;Socket.h&gt;</code></p>
  72. <div class="dynheader">
  73. Collaboration diagram for Sockets:</div>
  74. <div class="dyncontent">
  75. <div class="center"><img src="structSockets__coll__graph.png" border="0" usemap="#Sockets_coll__map" alt="Collaboration graph"/></div>
  76. <map name="Sockets_coll__map" id="Sockets_coll__map">
  77. <area shape="rect" title="Structure to hold all socket data for the module." alt="" coords="33,231,104,257"/>
  78. <area shape="rect" href="structList.html" title="Structure to hold all data for one list." alt="" coords="47,127,91,153"/>
  79. <area shape="rect" href="structListElementStruct.html" title="Structure to hold all data for one list element." alt="" coords="5,7,132,33"/>
  80. </map>
  81. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  82. <table class="memberdecls">
  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  84. Data Fields</h2></td></tr>
  85. <tr class="memitem:ac1b74c5f7fd463159318d2ef3c8fcee6"><td class="memItemLeft" align="right" valign="top"><a id="ac1b74c5f7fd463159318d2ef3c8fcee6"></a>
  86. <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>
  87. <tr class="memdesc:ac1b74c5f7fd463159318d2ef3c8fcee6"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of sockets for which a connect is pending <br /></td></tr>
  88. <tr class="separator:ac1b74c5f7fd463159318d2ef3c8fcee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a852db7c3edf654d8ee451be18b3f5743"><td class="memItemLeft" align="right" valign="top"><a id="a852db7c3edf654d8ee451be18b3f5743"></a>
  90. <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>
  91. <tr class="memdesc:a852db7c3edf654d8ee451be18b3f5743"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of sockets for which a write is pending <br /></td></tr>
  92. <tr class="separator:a852db7c3edf654d8ee451be18b3f5743"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a9bee5974437201a4b7728955de2ebd50"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a9bee5974437201a4b7728955de2ebd50">nfds</a></td></tr>
  94. <tr class="memdesc:a9bee5974437201a4b7728955de2ebd50"><td class="mdescLeft">&#160;</td><td class="mdescRight">no of file descriptors for poll <a href="structSockets.html#a9bee5974437201a4b7728955de2ebd50">More...</a><br /></td></tr>
  95. <tr class="separator:a9bee5974437201a4b7728955de2ebd50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a9e91e6577708542a4aab9c43976f7923"><td class="memItemLeft" align="right" valign="top"><a id="a9e91e6577708542a4aab9c43976f7923"></a>
  97. struct pollfd *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSockets.html#a9e91e6577708542a4aab9c43976f7923">fds_read</a></td></tr>
  98. <tr class="memdesc:a9e91e6577708542a4aab9c43976f7923"><td class="mdescLeft">&#160;</td><td class="mdescRight">poll read file descriptors <br /></td></tr>
  99. <tr class="separator:a9e91e6577708542a4aab9c43976f7923"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a6d20a690336a18c8d832d1eff3a6a02f"><td class="memItemLeft" align="right" valign="top"><a id="a6d20a690336a18c8d832d1eff3a6a02f"></a>
  101. struct pollfd *&#160;</td><td class="memItemRight" valign="bottom"><b>fds_write</b></td></tr>
  102. <tr class="separator:a6d20a690336a18c8d832d1eff3a6a02f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a9541b61559daa5f23fe63576e44f63aa"><td class="memItemLeft" ><a id="a9541b61559daa5f23fe63576e44f63aa"></a>
  104. struct {</td></tr>
  105. <tr class="memitem:a790baeb63c2dd4807d9a88019a820939"><td class="memItemLeft" >
  106. &#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="structSockets.html#a4ebc1178e3d1516f31b7dbc276cfde2b">cur_fd</a></td></tr>
  107. <tr class="memdesc:a790baeb63c2dd4807d9a88019a820939"><td class="mdescLeft">&#160;</td><td class="mdescRight">index into the fds_saved array <br /></td></tr>
  108. <tr class="separator:a790baeb63c2dd4807d9a88019a820939"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a8495253a8afdc9328b22e43469565584"><td class="memItemLeft" >
  110. &#160;&#160;&#160;unsigned int&#160;&#160;&#160;<a class="el" href="structSockets.html#a9bee5974437201a4b7728955de2ebd50">nfds</a></td></tr>
  111. <tr class="memdesc:a8495253a8afdc9328b22e43469565584"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of fds in the fds_saved array <br /></td></tr>
  112. <tr class="separator:a8495253a8afdc9328b22e43469565584"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ad9b00c4836433b27fc2ffdea7a47588a"><td class="memItemLeft" >
  114. &#160;&#160;&#160;struct pollfd *&#160;&#160;&#160;<b>fds_write</b></td></tr>
  115. <tr class="separator:ad9b00c4836433b27fc2ffdea7a47588a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ac14fafaad85ed6a8587fa494e2284fee"><td class="memItemLeft" >
  117. &#160;&#160;&#160;struct pollfd *&#160;&#160;&#160;<b>fds_read</b></td></tr>
  118. <tr class="separator:ac14fafaad85ed6a8587fa494e2284fee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a9541b61559daa5f23fe63576e44f63aa"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><b>saved</b></td></tr>
  120. <tr class="separator:a9541b61559daa5f23fe63576e44f63aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  123. <div class="textblock"><p>Structure to hold all socket data for the module. </p>
  124. </div><h2 class="groupheader">Field Documentation</h2>
  125. <a id="a9bee5974437201a4b7728955de2ebd50"></a>
  126. <h2 class="memtitle"><span class="permalink"><a href="#a9bee5974437201a4b7728955de2ebd50">&#9670;&nbsp;</a></span>nfds</h2>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">unsigned int Sockets::nfds</td>
  132. </tr>
  133. </table>
  134. </div><div class="memdoc">
  135. <p>no of file descriptors for poll </p>
  136. <p>number of fds in the fds_saved array </p>
  137. </div>
  138. </div>
  139. <hr/>The documentation for this struct was generated from the following file:<ul>
  140. <li>Socket.h</li>
  141. </ul>
  142. </div><!-- contents -->
  143. <!-- start footer part -->
  144. <hr class="footer"/><address class="footer"><small>
  145. Generated on Thu Sep 29 2022 11:34:46 for MQTT C Client Libraries Internals by &#160;<a href="http://www.doxygen.org/index.html">
  146. <img class="footer" src="doxygen.png" alt="doxygen"/>
  147. </a> 1.8.17
  148. </small></address>
  149. </body>
  150. </html>