structMQTTClient__persistence.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  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: MQTTClient_persistence 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">MQTTClient_persistence Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>A structure containing the function pointers to a persistence implementation and the context or state that will be shared across all the persistence functions.
  70. <a href="structMQTTClient__persistence.html#details">More...</a></p>
  71. <p><code>#include &lt;MQTTClientPersistence.h&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  74. Data Fields</h2></td></tr>
  75. <tr class="memitem:a2066e737e00f3fcb016152b4a9cedad6"><td class="memItemLeft" align="right" valign="top"><a id="a2066e737e00f3fcb016152b4a9cedad6"></a>
  76. void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#a2066e737e00f3fcb016152b4a9cedad6">context</a></td></tr>
  77. <tr class="memdesc:a2066e737e00f3fcb016152b4a9cedad6"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to any data required to initialize the persistent store. <br /></td></tr>
  78. <tr class="separator:a2066e737e00f3fcb016152b4a9cedad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ae58084438624ad267f7c050debd1b2ff"><td class="memItemLeft" align="right" valign="top"><a id="ae58084438624ad267f7c050debd1b2ff"></a>
  80. <a class="el" href="MQTTClientPersistence_8h.html#a4c7d332bb16907058ae3b375488b6008">Persistence_open</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#ae58084438624ad267f7c050debd1b2ff">popen</a></td></tr>
  81. <tr class="memdesc:ae58084438624ad267f7c050debd1b2ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to an implementation of <a class="el" href="MQTTClientPersistence_8h.html#a4c7d332bb16907058ae3b375488b6008" title="Initialize the persistent store.">Persistence_open()</a>. <br /></td></tr>
  82. <tr class="separator:ae58084438624ad267f7c050debd1b2ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a1bcc2ebaee1ab155b906493b14088a33"><td class="memItemLeft" align="right" valign="top"><a id="a1bcc2ebaee1ab155b906493b14088a33"></a>
  84. <a class="el" href="MQTTClientPersistence_8h.html#a3582de2c87e89f617e8e553b2a0e279a">Persistence_close</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#a1bcc2ebaee1ab155b906493b14088a33">pclose</a></td></tr>
  85. <tr class="memdesc:a1bcc2ebaee1ab155b906493b14088a33"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to an implementation of <a class="el" href="MQTTClientPersistence_8h.html#a3582de2c87e89f617e8e553b2a0e279a" title="Close the persistent store referred to by the handle.">Persistence_close()</a>. <br /></td></tr>
  86. <tr class="separator:a1bcc2ebaee1ab155b906493b14088a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a0f7846e9b4118a7a63702c504f4c8e9d"><td class="memItemLeft" align="right" valign="top"><a id="a0f7846e9b4118a7a63702c504f4c8e9d"></a>
  88. <a class="el" href="MQTTClientPersistence_8h.html#a44679cab77cfbd6e2a4639cdd27ac80c">Persistence_put</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#a0f7846e9b4118a7a63702c504f4c8e9d">pput</a></td></tr>
  89. <tr class="memdesc:a0f7846e9b4118a7a63702c504f4c8e9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to an implementation of <a class="el" href="MQTTClientPersistence_8h.html#a44679cab77cfbd6e2a4639cdd27ac80c" title="Put the specified data into the persistent store.">Persistence_put()</a>. <br /></td></tr>
  90. <tr class="separator:a0f7846e9b4118a7a63702c504f4c8e9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a0f9fe9edd3946f0647862de7904e4098"><td class="memItemLeft" align="right" valign="top"><a id="a0f9fe9edd3946f0647862de7904e4098"></a>
  92. <a class="el" href="MQTTClientPersistence_8h.html#adc3aff3c570fa5509e9d6814a85ab867">Persistence_get</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#a0f9fe9edd3946f0647862de7904e4098">pget</a></td></tr>
  93. <tr class="memdesc:a0f9fe9edd3946f0647862de7904e4098"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to an implementation of <a class="el" href="MQTTClientPersistence_8h.html#adc3aff3c570fa5509e9d6814a85ab867" title="Retrieve the specified data from the persistent store.">Persistence_get()</a>. <br /></td></tr>
  94. <tr class="separator:a0f9fe9edd3946f0647862de7904e4098"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a815d4110bfd7f2678a60f9264b13e075"><td class="memItemLeft" align="right" valign="top"><a id="a815d4110bfd7f2678a60f9264b13e075"></a>
  96. <a class="el" href="MQTTClientPersistence_8h.html#a73350bf7208658bf5434a59f7bdbae90">Persistence_remove</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#a815d4110bfd7f2678a60f9264b13e075">premove</a></td></tr>
  97. <tr class="memdesc:a815d4110bfd7f2678a60f9264b13e075"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to an implementation of <a class="el" href="MQTTClientPersistence_8h.html#a73350bf7208658bf5434a59f7bdbae90" title="Remove the data for the specified key from the store.">Persistence_remove()</a>. <br /></td></tr>
  98. <tr class="separator:a815d4110bfd7f2678a60f9264b13e075"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a36a69926a618f7e0f5098db61ece101b"><td class="memItemLeft" align="right" valign="top"><a id="a36a69926a618f7e0f5098db61ece101b"></a>
  100. <a class="el" href="MQTTClientPersistence_8h.html#a2601cc91eeabdbf9578f8dd45e4997a8">Persistence_keys</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#a36a69926a618f7e0f5098db61ece101b">pkeys</a></td></tr>
  101. <tr class="memdesc:a36a69926a618f7e0f5098db61ece101b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to an implementation of <a class="el" href="MQTTClientPersistence_8h.html#a2601cc91eeabdbf9578f8dd45e4997a8" title="Returns the keys in this persistent data store.">Persistence_keys()</a>. <br /></td></tr>
  102. <tr class="separator:a36a69926a618f7e0f5098db61ece101b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a4eb919940dcc01a005abcdeb08a7eb10"><td class="memItemLeft" align="right" valign="top"><a id="a4eb919940dcc01a005abcdeb08a7eb10"></a>
  104. <a class="el" href="MQTTClientPersistence_8h.html#acee7097c1a0ab44b98c870f533687887">Persistence_clear</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#a4eb919940dcc01a005abcdeb08a7eb10">pclear</a></td></tr>
  105. <tr class="memdesc:a4eb919940dcc01a005abcdeb08a7eb10"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to an implementation of <a class="el" href="MQTTClientPersistence_8h.html#acee7097c1a0ab44b98c870f533687887" title="Clears the persistence store, so that it no longer contains any persisted data.">Persistence_clear()</a>. <br /></td></tr>
  106. <tr class="separator:a4eb919940dcc01a005abcdeb08a7eb10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a049d548dc2bbe906309a9f869a60653c"><td class="memItemLeft" align="right" valign="top"><a id="a049d548dc2bbe906309a9f869a60653c"></a>
  108. <a class="el" href="MQTTClientPersistence_8h.html#a753a0f9a9c51284d63a907af19c7bbba">Persistence_containskey</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMQTTClient__persistence.html#a049d548dc2bbe906309a9f869a60653c">pcontainskey</a></td></tr>
  109. <tr class="memdesc:a049d548dc2bbe906309a9f869a60653c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function pointer to an implementation of <a class="el" href="MQTTClientPersistence_8h.html#a753a0f9a9c51284d63a907af19c7bbba" title="Returns whether any data has been persisted using the specified key.">Persistence_containskey()</a>. <br /></td></tr>
  110. <tr class="separator:a049d548dc2bbe906309a9f869a60653c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  113. <div class="textblock"><p>A structure containing the function pointers to a persistence implementation and the context or state that will be shared across all the persistence functions. </p>
  114. </div><hr/>The documentation for this struct was generated from the following file:<ul>
  115. <li><a class="el" href="MQTTClientPersistence_8h.html">MQTTClientPersistence.h</a></li>
  116. </ul>
  117. </div><!-- contents -->
  118. <!-- start footer part -->
  119. <hr class="footer"/><address class="footer"><small>
  120. 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">
  121. <img class="footer" src="doxygen.png" alt="doxygen"/>
  122. </a> 1.8.17
  123. </small></address>
  124. </body>
  125. </html>