1
0

cfg_8h_source.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  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é: /home/nmccallu/Projects/jose/jose/cfg.h Source File</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. <!-- window showing the filter options -->
  46. <div id="MSearchSelectWindow"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. onkeydown="return searchBox.OnSearchSelectKey(event)">
  50. </div>
  51. <!-- iframe showing the search results (closed by default) -->
  52. <div id="MSearchResultsWindow">
  53. <iframe src="javascript:void(0)" frameborder="0"
  54. name="MSearchResults" id="MSearchResults">
  55. </iframe>
  56. </div>
  57. <div id="nav-path" class="navpath">
  58. <ul>
  59. <li class="navelem"><a class="el" href="dir_f2bd36b8a3f3d476e48bdb5015c9fdfb.html">jose</a></li> </ul>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="headertitle">
  64. <div class="title">cfg.h</div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* vim: set tabstop=8 shiftwidth=4 softtabstop=4 expandtab smarttab colorcolumn=80: */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2017 Red Hat, Inc.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;stdarg.h&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">enum</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; _JOSE_CFG_ERR_BASE = 0x1053000000000000ULL,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; JOSE_CFG_ERR_JWK_INVALID,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; JOSE_CFG_ERR_JWK_MISMATCH,</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; JOSE_CFG_ERR_JWK_DENIED,</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; JOSE_CFG_ERR_ALG_NOTSUP,</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; JOSE_CFG_ERR_ALG_NOINFER,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; JOSE_CFG_ERR_JWS_INVALID,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;};</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#ifdef DOXYGEN</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="group__jose__cfg.html#gaf1dca939bc91e5f203f440307240b08f"> 51</a></span>&#160;<span class="keyword">typedef</span> jose_cfg_t <a class="code" href="group__jose__cfg.html#gaf1dca939bc91e5f203f440307240b08f">jose_cfg_auto_t</a>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#define jose_cfg_auto_t jose_cfg_t __attribute__((cleanup(jose_cfg_auto)))</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__jose__cfg.html#ga6d89919bf7dd7969cefdb113c49a61e6">jose_cfg</a> jose_cfg_t;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">typedef</span> void (jose_cfg_err_t)(<span class="keywordtype">void</span> *misc, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keywordtype">int</span> line,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; uint64_t err, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, va_list ap);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;jose_cfg_t *</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<a class="code" href="group__jose__cfg.html#ga6d89919bf7dd7969cefdb113c49a61e6">jose_cfg</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="keywordtype">void</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;jose_cfg_auto(jose_cfg_t **cfg);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;jose_cfg_t *</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<a class="code" href="group__jose__cfg.html#ga1c0caea470553360b15b312a123c7ce4">jose_cfg_incref</a>(jose_cfg_t *cfg);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="keywordtype">void</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<a class="code" href="group__jose__cfg.html#ga30ea7bdd659e6f8620f3d4d72ed2f87a">jose_cfg_decref</a>(jose_cfg_t *cfg);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="keywordtype">void</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<a class="code" href="group__jose__cfg.html#ga2383b689e066b463b0e62b6f9853295f">jose_cfg_set_err_func</a>(jose_cfg_t *cfg, jose_cfg_err_t *err, <span class="keywordtype">void</span> *misc);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="keywordtype">void</span> *</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<a class="code" href="group__jose__cfg.html#ga92220346ca7051fd44685b71dbc5ce3c">jose_cfg_get_err_misc</a>(jose_cfg_t *cfg);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="preprocessor">#ifdef DOXYGEN</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="keywordtype">void</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<a class="code" href="group__jose__cfg.html#ga8193855cf711805afc0bbcfe03b9faf4">jose_cfg_err</a>(jose_cfg_t *cfg, uint64_t err, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="keywordtype">void</span> __attribute__((format(printf, 5, 6)))</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<a class="code" href="group__jose__cfg.html#ga8193855cf711805afc0bbcfe03b9faf4">jose_cfg_err</a>(jose_cfg_t *cfg, const <span class="keywordtype">char</span> *file, <span class="keywordtype">int</span> line, uint64_t err,</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; const <span class="keywordtype">char</span> *fmt, ...);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="preprocessor">#define jose_cfg_err(cfg, err, ...) \</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="preprocessor"> jose_cfg_err(cfg, __FILE__, __LINE__, err, __VA_ARGS__)</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="ttc" id="group__jose__cfg_html_ga1c0caea470553360b15b312a123c7ce4"><div class="ttname"><a href="group__jose__cfg.html#ga1c0caea470553360b15b312a123c7ce4">jose_cfg_incref</a></div><div class="ttdeci">jose_cfg_t * jose_cfg_incref(jose_cfg_t *cfg)</div><div class="ttdoc">Increases the reference count of a configuration instance. </div></div>
  68. <div class="ttc" id="group__jose__cfg_html_gaf1dca939bc91e5f203f440307240b08f"><div class="ttname"><a href="group__jose__cfg.html#gaf1dca939bc91e5f203f440307240b08f">jose_cfg_auto_t</a></div><div class="ttdeci">jose_cfg_t jose_cfg_auto_t</div><div class="ttdoc">Defines a jose_cfg_t which calls jose_cfg_decref() at end of scope. </div><div class="ttdef"><b>Definition:</b> cfg.h:51</div></div>
  69. <div class="ttc" id="group__jose__cfg_html_ga92220346ca7051fd44685b71dbc5ce3c"><div class="ttname"><a href="group__jose__cfg.html#ga92220346ca7051fd44685b71dbc5ce3c">jose_cfg_get_err_misc</a></div><div class="ttdeci">void * jose_cfg_get_err_misc(jose_cfg_t *cfg)</div><div class="ttdoc">Gets the miscellaneous data associated with the current error handler. </div></div>
  70. <div class="ttc" id="group__jose__cfg_html_ga6d89919bf7dd7969cefdb113c49a61e6"><div class="ttname"><a href="group__jose__cfg.html#ga6d89919bf7dd7969cefdb113c49a61e6">jose_cfg</a></div><div class="ttdeci">jose_cfg_t * jose_cfg(void)</div><div class="ttdoc">Creates a new configuration instance. </div></div>
  71. <div class="ttc" id="group__jose__cfg_html_ga8193855cf711805afc0bbcfe03b9faf4"><div class="ttname"><a href="group__jose__cfg.html#ga8193855cf711805afc0bbcfe03b9faf4">jose_cfg_err</a></div><div class="ttdeci">void jose_cfg_err(jose_cfg_t *cfg, uint64_t err, const char *fmt,...)</div><div class="ttdoc">Submit an error. </div></div>
  72. <div class="ttc" id="group__jose__cfg_html_ga2383b689e066b463b0e62b6f9853295f"><div class="ttname"><a href="group__jose__cfg.html#ga2383b689e066b463b0e62b6f9853295f">jose_cfg_set_err_func</a></div><div class="ttdeci">void jose_cfg_set_err_func(jose_cfg_t *cfg, jose_cfg_err_t *err, void *misc)</div><div class="ttdoc">Sets the error handler function for this configuration instance. </div></div>
  73. <div class="ttc" id="group__jose__cfg_html_ga30ea7bdd659e6f8620f3d4d72ed2f87a"><div class="ttname"><a href="group__jose__cfg.html#ga30ea7bdd659e6f8620f3d4d72ed2f87a">jose_cfg_decref</a></div><div class="ttdeci">void jose_cfg_decref(jose_cfg_t *cfg)</div><div class="ttdoc">Decreases the reference count of a configuration instance. </div></div>
  74. </div><!-- fragment --></div><!-- contents -->
  75. <!-- start footer part -->
  76. <hr class="footer"/><address class="footer"><small>
  77. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  78. <img class="footer" src="doxygen.png" alt="doxygen"/>
  79. </a> 1.8.13
  80. </small></address>
  81. </body>
  82. </html>