1
0

group__jose__cfg.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>José: Config</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="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">José
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.13 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <script type="text/javascript" src="menudata.js"></script>
  37. <script type="text/javascript" src="menu.js"></script>
  38. <script type="text/javascript">
  39. $(function() {
  40. initMenu('',true,false,'search.php','Search');
  41. $(document).ready(function() { init_search(); });
  42. });
  43. </script>
  44. <div id="main-nav"></div>
  45. </div><!-- top -->
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div class="header">
  59. <div class="summary">
  60. <a href="#typedef-members">Typedefs</a> &#124;
  61. <a href="#func-members">Functions</a> </div>
  62. <div class="headertitle">
  63. <div class="title">Config</div> </div>
  64. </div><!--header-->
  65. <div class="contents">
  66. <p>José Configuration.
  67. <a href="#details">More...</a></p>
  68. <table class="memberdecls">
  69. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  70. Typedefs</h2></td></tr>
  71. <tr class="memitem:gaf1dca939bc91e5f203f440307240b08f"><td class="memItemLeft" align="right" valign="top">typedef jose_cfg_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#gaf1dca939bc91e5f203f440307240b08f">jose_cfg_auto_t</a></td></tr>
  72. <tr class="memdesc:gaf1dca939bc91e5f203f440307240b08f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines a jose_cfg_t which calls <a class="el" href="group__jose__cfg.html#ga30ea7bdd659e6f8620f3d4d72ed2f87a" title="Decreases the reference count of a configuration instance. ">jose_cfg_decref()</a> at end of scope. <a href="#gaf1dca939bc91e5f203f440307240b08f">More...</a><br /></td></tr>
  73. <tr class="separator:gaf1dca939bc91e5f203f440307240b08f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. </table><table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  76. Functions</h2></td></tr>
  77. <tr class="memitem:ga6d89919bf7dd7969cefdb113c49a61e6"><td class="memItemLeft" align="right" valign="top">jose_cfg_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#ga6d89919bf7dd7969cefdb113c49a61e6">jose_cfg</a> (void)</td></tr>
  78. <tr class="memdesc:ga6d89919bf7dd7969cefdb113c49a61e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new configuration instance. <a href="#ga6d89919bf7dd7969cefdb113c49a61e6">More...</a><br /></td></tr>
  79. <tr class="separator:ga6d89919bf7dd7969cefdb113c49a61e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga1c0caea470553360b15b312a123c7ce4"><td class="memItemLeft" align="right" valign="top">jose_cfg_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#ga1c0caea470553360b15b312a123c7ce4">jose_cfg_incref</a> (jose_cfg_t *cfg)</td></tr>
  81. <tr class="memdesc:ga1c0caea470553360b15b312a123c7ce4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increases the reference count of a configuration instance. <a href="#ga1c0caea470553360b15b312a123c7ce4">More...</a><br /></td></tr>
  82. <tr class="separator:ga1c0caea470553360b15b312a123c7ce4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ga30ea7bdd659e6f8620f3d4d72ed2f87a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#ga30ea7bdd659e6f8620f3d4d72ed2f87a">jose_cfg_decref</a> (jose_cfg_t *cfg)</td></tr>
  84. <tr class="memdesc:ga30ea7bdd659e6f8620f3d4d72ed2f87a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decreases the reference count of a configuration instance. <a href="#ga30ea7bdd659e6f8620f3d4d72ed2f87a">More...</a><br /></td></tr>
  85. <tr class="separator:ga30ea7bdd659e6f8620f3d4d72ed2f87a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ga2383b689e066b463b0e62b6f9853295f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#ga2383b689e066b463b0e62b6f9853295f">jose_cfg_set_err_func</a> (jose_cfg_t *cfg, jose_cfg_err_t *err, void *misc)</td></tr>
  87. <tr class="memdesc:ga2383b689e066b463b0e62b6f9853295f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the error handler function for this configuration instance. <a href="#ga2383b689e066b463b0e62b6f9853295f">More...</a><br /></td></tr>
  88. <tr class="separator:ga2383b689e066b463b0e62b6f9853295f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ga92220346ca7051fd44685b71dbc5ce3c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#ga92220346ca7051fd44685b71dbc5ce3c">jose_cfg_get_err_misc</a> (jose_cfg_t *cfg)</td></tr>
  90. <tr class="memdesc:ga92220346ca7051fd44685b71dbc5ce3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the miscellaneous data associated with the current error handler. <a href="#ga92220346ca7051fd44685b71dbc5ce3c">More...</a><br /></td></tr>
  91. <tr class="separator:ga92220346ca7051fd44685b71dbc5ce3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ga8193855cf711805afc0bbcfe03b9faf4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#ga8193855cf711805afc0bbcfe03b9faf4">jose_cfg_err</a> (jose_cfg_t *cfg, uint64_t err, const char *fmt,...)</td></tr>
  93. <tr class="memdesc:ga8193855cf711805afc0bbcfe03b9faf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit an error. <a href="#ga8193855cf711805afc0bbcfe03b9faf4">More...</a><br /></td></tr>
  94. <tr class="separator:ga8193855cf711805afc0bbcfe03b9faf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table>
  96. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  97. <p>José Configuration. </p>
  98. <h2 class="groupheader">Typedef Documentation</h2>
  99. <a id="gaf1dca939bc91e5f203f440307240b08f"></a>
  100. <h2 class="memtitle"><span class="permalink"><a href="#gaf1dca939bc91e5f203f440307240b08f">&#9670;&nbsp;</a></span>jose_cfg_auto_t</h2>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="memname">
  104. <tr>
  105. <td class="memname">typedef jose_cfg_t <a class="el" href="group__jose__cfg.html#gaf1dca939bc91e5f203f440307240b08f">jose_cfg_auto_t</a></td>
  106. </tr>
  107. </table>
  108. </div><div class="memdoc">
  109. <p>Defines a jose_cfg_t which calls <a class="el" href="group__jose__cfg.html#ga30ea7bdd659e6f8620f3d4d72ed2f87a" title="Decreases the reference count of a configuration instance. ">jose_cfg_decref()</a> at end of scope. </p>
  110. <p>For example: </p><pre class="fragment">void foo() {
  111. jose_cfg_auto_t *cfg = jose_cfg();
  112. // jose_cfg_decref() implicitly called
  113. }</pre>
  114. </div>
  115. </div>
  116. <h2 class="groupheader">Function Documentation</h2>
  117. <a id="ga6d89919bf7dd7969cefdb113c49a61e6"></a>
  118. <h2 class="memtitle"><span class="permalink"><a href="#ga6d89919bf7dd7969cefdb113c49a61e6">&#9670;&nbsp;</a></span>jose_cfg()</h2>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname">jose_cfg_t* jose_cfg </td>
  124. <td>(</td>
  125. <td class="paramtype">void&#160;</td>
  126. <td class="paramname"></td><td>)</td>
  127. <td></td>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. <p>Creates a new configuration instance. </p>
  132. <dl class="section return"><dt>Returns</dt><dd>A newly-allocated configuration instance. </dd></dl>
  133. </div>
  134. </div>
  135. <a id="ga1c0caea470553360b15b312a123c7ce4"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#ga1c0caea470553360b15b312a123c7ce4">&#9670;&nbsp;</a></span>jose_cfg_incref()</h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">jose_cfg_t* jose_cfg_incref </td>
  142. <td>(</td>
  143. <td class="paramtype">jose_cfg_t *&#160;</td>
  144. <td class="paramname"><em>cfg</em></td><td>)</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Increases the reference count of a configuration instance. </p>
  150. <p>This function always succeeds.</p>
  151. <dl class="params"><dt>Parameters</dt><dd>
  152. <table class="params">
  153. <tr><td class="paramname">cfg</td><td>The configuration context. </td></tr>
  154. </table>
  155. </dd>
  156. </dl>
  157. <dl class="section return"><dt>Returns</dt><dd>The value of <code>cfg</code> (for convenience). </dd></dl>
  158. </div>
  159. </div>
  160. <a id="ga30ea7bdd659e6f8620f3d4d72ed2f87a"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#ga30ea7bdd659e6f8620f3d4d72ed2f87a">&#9670;&nbsp;</a></span>jose_cfg_decref()</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">void jose_cfg_decref </td>
  167. <td>(</td>
  168. <td class="paramtype">jose_cfg_t *&#160;</td>
  169. <td class="paramname"><em>cfg</em></td><td>)</td>
  170. <td></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Decreases the reference count of a configuration instance. </p>
  175. <p>When the reference count reaches zero, the configuration instance is freed.</p>
  176. <dl class="params"><dt>Parameters</dt><dd>
  177. <table class="params">
  178. <tr><td class="paramname">cfg</td><td>The configuration context. </td></tr>
  179. </table>
  180. </dd>
  181. </dl>
  182. </div>
  183. </div>
  184. <a id="ga2383b689e066b463b0e62b6f9853295f"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#ga2383b689e066b463b0e62b6f9853295f">&#9670;&nbsp;</a></span>jose_cfg_set_err_func()</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">void jose_cfg_set_err_func </td>
  191. <td>(</td>
  192. <td class="paramtype">jose_cfg_t *&#160;</td>
  193. <td class="paramname"><em>cfg</em>, </td>
  194. </tr>
  195. <tr>
  196. <td class="paramkey"></td>
  197. <td></td>
  198. <td class="paramtype">jose_cfg_err_t *&#160;</td>
  199. <td class="paramname"><em>err</em>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype">void *&#160;</td>
  205. <td class="paramname"><em>misc</em>&#160;</td>
  206. </tr>
  207. <tr>
  208. <td></td>
  209. <td>)</td>
  210. <td></td><td></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Sets the error handler function for this configuration instance. </p>
  215. <p>The value of <code>misc</code> will be passed to the error handler function.</p>
  216. <p>You may pass NULL to <code>err</code> to return to the default error handler.</p>
  217. <dl class="params"><dt>Parameters</dt><dd>
  218. <table class="params">
  219. <tr><td class="paramname">cfg</td><td>The configuration context. </td></tr>
  220. <tr><td class="paramname">err</td><td>The error handler function you wish to enable. </td></tr>
  221. <tr><td class="paramname">misc</td><td>The miscellaneous data you wish to pass to the error handler. </td></tr>
  222. </table>
  223. </dd>
  224. </dl>
  225. </div>
  226. </div>
  227. <a id="ga92220346ca7051fd44685b71dbc5ce3c"></a>
  228. <h2 class="memtitle"><span class="permalink"><a href="#ga92220346ca7051fd44685b71dbc5ce3c">&#9670;&nbsp;</a></span>jose_cfg_get_err_misc()</h2>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">void* jose_cfg_get_err_misc </td>
  234. <td>(</td>
  235. <td class="paramtype">jose_cfg_t *&#160;</td>
  236. <td class="paramname"><em>cfg</em></td><td>)</td>
  237. <td></td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Gets the miscellaneous data associated with the current error handler. </p>
  242. <dl class="params"><dt>Parameters</dt><dd>
  243. <table class="params">
  244. <tr><td class="paramname">cfg</td><td>The configuration context. </td></tr>
  245. </table>
  246. </dd>
  247. </dl>
  248. <dl class="section return"><dt>Returns</dt><dd>The miscellaneous data associated with the error handler. </dd></dl>
  249. </div>
  250. </div>
  251. <a id="ga8193855cf711805afc0bbcfe03b9faf4"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#ga8193855cf711805afc0bbcfe03b9faf4">&#9670;&nbsp;</a></span>jose_cfg_err()</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">void jose_cfg_err </td>
  258. <td>(</td>
  259. <td class="paramtype">jose_cfg_t *&#160;</td>
  260. <td class="paramname"><em>cfg</em>, </td>
  261. </tr>
  262. <tr>
  263. <td class="paramkey"></td>
  264. <td></td>
  265. <td class="paramtype">uint64_t&#160;</td>
  266. <td class="paramname"><em>err</em>, </td>
  267. </tr>
  268. <tr>
  269. <td class="paramkey"></td>
  270. <td></td>
  271. <td class="paramtype">const char *&#160;</td>
  272. <td class="paramname"><em>fmt</em>, </td>
  273. </tr>
  274. <tr>
  275. <td class="paramkey"></td>
  276. <td></td>
  277. <td class="paramtype">&#160;</td>
  278. <td class="paramname"><em>...</em>&#160;</td>
  279. </tr>
  280. <tr>
  281. <td></td>
  282. <td>)</td>
  283. <td></td><td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <p>Submit an error. </p>
  288. <p>The error handler will be called with the error provided.</p>
  289. <dl class="params"><dt>Parameters</dt><dd>
  290. <table class="params">
  291. <tr><td class="paramname">cfg</td><td>The configuration context (optional). </td></tr>
  292. <tr><td class="paramname">err</td><td>The number corresponding to this error type. </td></tr>
  293. <tr><td class="paramname">fmt</td><td>A printf()-style format string. </td></tr>
  294. <tr><td class="paramname">...</td><td>The printf()-style arguments. </td></tr>
  295. </table>
  296. </dd>
  297. </dl>
  298. </div>
  299. </div>
  300. </div><!-- contents -->
  301. <!-- start footer part -->
  302. <hr class="footer"/><address class="footer"><small>
  303. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  304. <img class="footer" src="doxygen.png" alt="doxygen"/>
  305. </a> 1.8.13
  306. </small></address>
  307. </body>
  308. </html>