| Server IP : 20.75.53.88 / Your IP : 216.73.217.138 [ Web Server : Apache System : Linux VMRALP-3 4.4.0-256-generic #290~14.04.1-Ubuntu SMP Thu Jun 20 09:24:50 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 5.5.9-1ubuntu4.29+esm15 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority, Domains : 3 Domains MySQL : ON | cURL : OFF | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/libaprutil1-dev/html/ |
Upload File : |
<!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.6"/>
<title>Apache Portable Runtime Utility Library: Optional Functions</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime Utility Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Optional Functions<div class="ingroups"><a class="el" href="group___a_p_r___util.html">APR Utility Functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga987fcf75505450f1b4ff9d7b3a7ff5d3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name)   apr_OFN_##name##_t</td></tr>
<tr class="separator:ga987fcf75505450f1b4ff9d7b3a7ff5d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf3ff372e28978d4ce0be7517ca2fddbd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#gaf3ff372e28978d4ce0be7517ca2fddbd">APR_DECLARE_OPTIONAL_FN</a>(ret, name, args)   typedef ret (<a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name)) args</td></tr>
<tr class="separator:gaf3ff372e28978d4ce0be7517ca2fddbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab611deabd6e78b5f666071e8cbdcc736"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#gab611deabd6e78b5f666071e8cbdcc736">APR_REGISTER_OPTIONAL_FN</a>(name)</td></tr>
<tr class="separator:gab611deabd6e78b5f666071e8cbdcc736"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35f2df25ca06248d2fdd3e7463446418"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#ga35f2df25ca06248d2fdd3e7463446418">APR_RETRIEVE_OPTIONAL_FN</a>(name)   (<a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name) *)apr_dynamic_fn_retrieve(#name)</td></tr>
<tr class="separator:ga35f2df25ca06248d2fdd3e7463446418"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga35e08c2dbf593e3dc5a2cb0fdc8cd637"><td class="memItemLeft" align="right" valign="top">typedef void( </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#ga35e08c2dbf593e3dc5a2cb0fdc8cd637">apr_opt_fn_t</a> )(void)</td></tr>
<tr class="separator:ga35e08c2dbf593e3dc5a2cb0fdc8cd637"><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:gaa9c7d3cc32128521274543c384e9698d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa9c7d3cc32128521274543c384e9698d"></a>
void </td><td class="memItemRight" valign="bottom"><b>apr_dynamic_fn_register</b> (const char *szName, <a class="el" href="group___a_p_r___util___opt.html#ga35e08c2dbf593e3dc5a2cb0fdc8cd637">apr_opt_fn_t</a> *pfn)</td></tr>
<tr class="separator:gaa9c7d3cc32128521274543c384e9698d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1ecfa6a6ced7332d03b5867735a5e49d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1ecfa6a6ced7332d03b5867735a5e49d"></a>
<a class="el" href="group___a_p_r___util___opt.html#ga35e08c2dbf593e3dc5a2cb0fdc8cd637">apr_opt_fn_t</a> * </td><td class="memItemRight" valign="bottom"><b>apr_dynamic_fn_retrieve</b> (const char *szName)</td></tr>
<tr class="separator:ga1ecfa6a6ced7332d03b5867735a5e49d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Typesafe registration and retrieval of functions that may not be present (i.e. functions exported by optional modules) </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gaf3ff372e28978d4ce0be7517ca2fddbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_DECLARE_OPTIONAL_FN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">ret, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">args </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   typedef ret (<a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name)) args</td>
</tr>
</table>
</div><div class="memdoc">
<p>Declare an optional function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ret</td><td>The return type of the function </td></tr>
<tr><td class="paramname">name</td><td>The name of the function </td></tr>
<tr><td class="paramname">args</td><td>The function arguments (including brackets) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga987fcf75505450f1b4ff9d7b3a7ff5d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OPTIONAL_FN_TYPE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   apr_OFN_##name##_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of an optional function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab611deabd6e78b5f666071e8cbdcc736"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_REGISTER_OPTIONAL_FN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { <a class="code" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">\</a></div>
<div class="line"><a class="code" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3"> APR_OPTIONAL_FN_TYPE</a>(name) *apu__opt = name; \</div>
<div class="line"> apr_dynamic_fn_register(#name,(<a class="code" href="group___a_p_r___util___opt.html#ga35e08c2dbf593e3dc5a2cb0fdc8cd637">apr_opt_fn_t</a> *)apu__opt); \</div>
<div class="line">} <span class="keywordflow">while</span> (0)</div>
<div class="ttc" id="group___a_p_r___util___opt_html_ga987fcf75505450f1b4ff9d7b3a7ff5d3"><div class="ttname"><a href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a></div><div class="ttdeci">#define APR_OPTIONAL_FN_TYPE(name)</div><div class="ttdef"><b>Definition:</b> apr_optional.h:42</div></div>
<div class="ttc" id="group___a_p_r___util___opt_html_ga35e08c2dbf593e3dc5a2cb0fdc8cd637"><div class="ttname"><a href="group___a_p_r___util___opt.html#ga35e08c2dbf593e3dc5a2cb0fdc8cd637">apr_opt_fn_t</a></div><div class="ttdeci">void( apr_opt_fn_t)(void)</div><div class="ttdef"><b>Definition:</b> apr_optional.h:59</div></div>
</div><!-- fragment --><p>Register an optional function. This can be later retrieved, type-safely, by name. Like all global functions, the name must be unique. Note that, confusingly but correctly, the function itself can be static! </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga35f2df25ca06248d2fdd3e7463446418"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_RETRIEVE_OPTIONAL_FN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   (<a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name) *)apr_dynamic_fn_retrieve(#name)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve an optional function. Returns NULL if the function is not present. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga35e08c2dbf593e3dc5a2cb0fdc8cd637"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void( apr_opt_fn_t)(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>XXX: This doesn't belong here, then! Private function! DO NOT USE! </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Feb 13 2023 19:13:22 for Apache Portable Runtime Utility Library by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>