index.html 4.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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: MQTT Client Library Internals</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. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="PageDoc"><div class="header">
  63. <div class="headertitle">
  64. <div class="title">MQTT Client Library Internals </div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <div class="textblock"><p>In the beginning there was one MQTT C client library, MQTTClient, as implemented in <a class="el" href="MQTTClient_8c.html" title="Synchronous API implementation.">MQTTClient.c</a> This library was designed to be easy to use for applications which didn't mind if some of the calls blocked for a while. For instance, the MQTTClient_connect call will block until a successful connection has completed, or a connection has failed, which could be as long as the "connection
  68. timeout" interval, whose default is 30 seconds.</p>
  69. <p>However in mobile devices and other windowing environments, blocking on the GUI thread is a bad thing as it causes the user interface to freeze. Hence a new API, MQTTAsync, implemented in MQTTAsync.c, was devised. There are no blocking calls in this library, so it is well suited to GUI and mobile environments, at the expense of some extra complexity.</p>
  70. <p>Both libraries are designed to be sparing in the use of threads. So multiple client objects are handled by one or two threads, with a select call in <a class="el" href="Socket_8c.html#ab33a53c9fce80d5dfeb26426b157034a" title="Returns the next socket ready for communications as indicated by select.">Socket_getReadySocket()</a>, used to determine when a socket has incoming data. This API is thread safe: functions may be called by multiple application threads, with the exception of <a class="el" href="MQTTClient_8c.html#a8ad3d29864a9ca08202b0832e0f6678e" title="When implementing a single-threaded client, call this function periodically to allow processing of me...">MQTTClient_yield</a> and <a class="el" href="MQTTClient_8c.html#a4c2df88d00a3dadd510a8cb774739366" title="This function performs a synchronous receive of incoming messages.">MQTTClient_receive</a>, which are intended for single threaded environments only. </p>
  71. </div></div><!-- PageDoc -->
  72. </div><!-- contents -->
  73. <!-- start footer part -->
  74. <hr class="footer"/><address class="footer"><small>
  75. 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">
  76. <img class="footer" src="doxygen.png" alt="doxygen"/>
  77. </a> 1.8.17
  78. </small></address>
  79. </body>
  80. </html>