<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>José: Config</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">José
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Config</div> </div>
</div><!--header-->
<div class="contents">
<p>José Configuration.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaf1dca939bc91e5f203f440307240b08f"><td class="memItemLeft" align="right" valign="top">typedef jose_cfg_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#gaf1dca939bc91e5f203f440307240b08f">jose_cfg_auto_t</a></td></tr>
<tr class="memdesc:gaf1dca939bc91e5f203f440307240b08f"><td class="mdescLeft"> </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>
<tr class="separator:gaf1dca939bc91e5f203f440307240b08f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6d89919bf7dd7969cefdb113c49a61e6"><td class="memItemLeft" align="right" valign="top">jose_cfg_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__jose__cfg.html#ga6d89919bf7dd7969cefdb113c49a61e6">jose_cfg</a> (void)</td></tr>
<tr class="memdesc:ga6d89919bf7dd7969cefdb113c49a61e6"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new configuration instance. <a href="#ga6d89919bf7dd7969cefdb113c49a61e6">More...</a><br /></td></tr>
<tr class="separator:ga6d89919bf7dd7969cefdb113c49a61e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c0caea470553360b15b312a123c7ce4"><td class="memItemLeft" align="right" valign="top">jose_cfg_t * </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>
<tr class="memdesc:ga1c0caea470553360b15b312a123c7ce4"><td class="mdescLeft"> </td><td class="mdescRight">Increases the reference count of a configuration instance. <a href="#ga1c0caea470553360b15b312a123c7ce4">More...</a><br /></td></tr>
<tr class="separator:ga1c0caea470553360b15b312a123c7ce4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga30ea7bdd659e6f8620f3d4d72ed2f87a"><td class="memItemLeft" align="right" valign="top">void </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>
<tr class="memdesc:ga30ea7bdd659e6f8620f3d4d72ed2f87a"><td class="mdescLeft"> </td><td class="mdescRight">Decreases the reference count of a configuration instance. <a href="#ga30ea7bdd659e6f8620f3d4d72ed2f87a">More...</a><br /></td></tr>
<tr class="separator:ga30ea7bdd659e6f8620f3d4d72ed2f87a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2383b689e066b463b0e62b6f9853295f"><td class="memItemLeft" align="right" valign="top">void </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>
<tr class="memdesc:ga2383b689e066b463b0e62b6f9853295f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the error handler function for this configuration instance. <a href="#ga2383b689e066b463b0e62b6f9853295f">More...</a><br /></td></tr>
<tr class="separator:ga2383b689e066b463b0e62b6f9853295f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga92220346ca7051fd44685b71dbc5ce3c"><td class="memItemLeft" align="right" valign="top">void * </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>
<tr class="memdesc:ga92220346ca7051fd44685b71dbc5ce3c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the miscellaneous data associated with the current error handler. <a href="#ga92220346ca7051fd44685b71dbc5ce3c">More...</a><br /></td></tr>
<tr class="separator:ga92220346ca7051fd44685b71dbc5ce3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8193855cf711805afc0bbcfe03b9faf4"><td class="memItemLeft" align="right" valign="top">void </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>
<tr class="memdesc:ga8193855cf711805afc0bbcfe03b9faf4"><td class="mdescLeft"> </td><td class="mdescRight">Submit an error. <a href="#ga8193855cf711805afc0bbcfe03b9faf4">More...</a><br /></td></tr>
<tr class="separator:ga8193855cf711805afc0bbcfe03b9faf4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>José Configuration. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gaf1dca939bc91e5f203f440307240b08f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf1dca939bc91e5f203f440307240b08f">◆ </a></span>jose_cfg_auto_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef jose_cfg_t <a class="el" href="group__jose__cfg.html#gaf1dca939bc91e5f203f440307240b08f">jose_cfg_auto_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<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>
<p>For example: </p><pre class="fragment">void foo() {
jose_cfg_auto_t *cfg = jose_cfg();
// jose_cfg_decref() implicitly called
}</pre>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga6d89919bf7dd7969cefdb113c49a61e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6d89919bf7dd7969cefdb113c49a61e6">◆ </a></span>jose_cfg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">jose_cfg_t* jose_cfg </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new configuration instance. </p>
<dl class="section return"><dt>Returns</dt><dd>A newly-allocated configuration instance. </dd></dl>
</div>
</div>
<a id="ga1c0caea470553360b15b312a123c7ce4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c0caea470553360b15b312a123c7ce4">◆ </a></span>jose_cfg_incref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">jose_cfg_t* jose_cfg_incref </td>
<td>(</td>
<td class="paramtype">jose_cfg_t * </td>
<td class="paramname"><em>cfg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increases the reference count of a configuration instance. </p>
<p>This function always succeeds.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>The configuration context. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of <code>cfg</code> (for convenience). </dd></dl>
</div>
</div>
<a id="ga30ea7bdd659e6f8620f3d4d72ed2f87a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga30ea7bdd659e6f8620f3d4d72ed2f87a">◆ </a></span>jose_cfg_decref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jose_cfg_decref </td>
<td>(</td>
<td class="paramtype">jose_cfg_t * </td>
<td class="paramname"><em>cfg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decreases the reference count of a configuration instance. </p>
<p>When the reference count reaches zero, the configuration instance is freed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>The configuration context. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga2383b689e066b463b0e62b6f9853295f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2383b689e066b463b0e62b6f9853295f">◆ </a></span>jose_cfg_set_err_func()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jose_cfg_set_err_func </td>
<td>(</td>
<td class="paramtype">jose_cfg_t * </td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">jose_cfg_err_t * </td>
<td class="paramname"><em>err</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>misc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the error handler function for this configuration instance. </p>
<p>The value of <code>misc</code> will be passed to the error handler function.</p>
<p>You may pass NULL to <code>err</code> to return to the default error handler.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>The configuration context. </td></tr>
<tr><td class="paramname">err</td><td>The error handler function you wish to enable. </td></tr>
<tr><td class="paramname">misc</td><td>The miscellaneous data you wish to pass to the error handler. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga92220346ca7051fd44685b71dbc5ce3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga92220346ca7051fd44685b71dbc5ce3c">◆ </a></span>jose_cfg_get_err_misc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* jose_cfg_get_err_misc </td>
<td>(</td>
<td class="paramtype">jose_cfg_t * </td>
<td class="paramname"><em>cfg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the miscellaneous data associated with the current error handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>The configuration context. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The miscellaneous data associated with the error handler. </dd></dl>
</div>
</div>
<a id="ga8193855cf711805afc0bbcfe03b9faf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8193855cf711805afc0bbcfe03b9faf4">◆ </a></span>jose_cfg_err()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jose_cfg_err </td>
<td>(</td>
<td class="paramtype">jose_cfg_t * </td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>err</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Submit an error. </p>
<p>The error handler will be called with the error provided.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cfg</td><td>The configuration context (optional). </td></tr>
<tr><td class="paramname">err</td><td>The number corresponding to this error type. </td></tr>
<tr><td class="paramname">fmt</td><td>A printf()-style format string. </td></tr>
<tr><td class="paramname">...</td><td>The printf()-style arguments. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>