<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>Apache Portable Runtime Utility Library: Optional Hook Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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">
<img id="MSearchSelect" src="search/search.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)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>Optional Hook Functions<br/>
<small>
[<a class="el" href="group___a_p_r___util___hook.html">Hook Functions</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___o_p_t___h_o_o_k.html#ga808d07f9a3e5df6517ba027972c79e4f">APR_OPTIONAL_HOOK</a>(ns, name, pfn, aszPre, aszSucc, nOrder)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___o_p_t___h_o_o_k.html#ga3e6fa7b8e9ce140b26d8f6ce34e6ae82">APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL</a>(ns, link, ret, name, args_decl, args_use, ok, decline)</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___o_p_t___h_o_o_k.html#gaff32812046580ae53b0368918374a3b6">apr_optional_hook_add</a> (const char *szName, void(*pfn)(void), const char *const *aszPre, const char *const *aszSucc, int nOrder)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae7cfa7b32c41fb38eb19f0bba85abfeb"></a><!-- doxytag: member="APR_Util_OPT_HOOK::apr_optional_hook_get" ref="gae7cfa7b32c41fb38eb19f0bba85abfeb" args="(const char *szName)" -->
apr_array_header_t * </td><td class="memItemRight" valign="bottom"><b>apr_optional_hook_get</b> (const char *szName)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga3e6fa7b8e9ce140b26d8f6ce34e6ae82"></a><!-- doxytag: member="apr_optional_hooks.h::APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL" ref="ga3e6fa7b8e9ce140b26d8f6ce34e6ae82" args="(ns, link, ret, name, args_decl, args_use, ok, decline)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL</td>
<td>(</td>
<td class="paramtype">ns, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">link, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ret, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">args_decl, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">args_use, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ok, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">decline </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">link##_DECLARE(ret) ns<span class="preprocessor">##_run_##name args_decl \</span>
<span class="preprocessor"> { \</span>
<span class="preprocessor"> ns##_LINK_##name##_t *pHook; \</span>
<span class="preprocessor"> int n; \</span>
<span class="preprocessor"> ret rv; \</span>
<span class="preprocessor"> apr_array_header_t *pHookArray=apr_optional_hook_get(#name); \</span>
<span class="preprocessor">\</span>
<span class="preprocessor"> if(!pHookArray) \</span>
<span class="preprocessor"> return ok; \</span>
<span class="preprocessor">\</span>
<span class="preprocessor"> pHook=(ns##_LINK_##name##_t *)pHookArray->elts; \</span>
<span class="preprocessor"> for(n=0 ; n < pHookArray->nelts ; ++n) \</span>
<span class="preprocessor"> { \</span>
<span class="preprocessor"> rv=(pHook[n].pFunc)args_use; \</span>
<span class="preprocessor">\</span>
<span class="preprocessor"> if(rv != ok && rv != decline) \</span>
<span class="preprocessor"> return rv; \</span>
<span class="preprocessor"> } \</span>
<span class="preprocessor"> return ok; \</span>
<span class="preprocessor"> }</span>
</pre></div><p>Implement an optional hook that runs until one of the functions returns something other than OK or DECLINE.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ns</em> </td><td>The namespace prefix of the hook functions </td></tr>
<tr><td valign="top"></td><td valign="top"><em>link</em> </td><td>The linkage declaration prefix of the hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>The type of the return value of the hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>The type of the return value of the hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args_decl</em> </td><td>The declaration of the arguments for the hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args_use</em> </td><td>The names for the arguments for the hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ok</em> </td><td>Success value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>decline</em> </td><td>Decline value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga808d07f9a3e5df6517ba027972c79e4f"></a><!-- doxytag: member="apr_optional_hooks.h::APR_OPTIONAL_HOOK" ref="ga808d07f9a3e5df6517ba027972c79e4f" args="(ns, name, pfn, aszPre, aszSucc, nOrder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OPTIONAL_HOOK</td>
<td>(</td>
<td class="paramtype">ns, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">pfn, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">aszPre, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">aszSucc, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">nOrder </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordflow">do</span> { \
ns##_HOOK_##name##_t *apu__hook = pfn; \
<a class="code" href="group___a_p_r___util___o_p_t___h_o_o_k.html#gaff32812046580ae53b0368918374a3b6">apr_optional_hook_add</a>(#name,(<span class="keywordtype">void</span> (*)(<span class="keywordtype">void</span>))apu__hook,aszPre, aszSucc, nOrder); \
} <span class="keywordflow">while</span> (0)
</pre></div><p>Hook to an optional hook.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ns</em> </td><td>The namespace prefix of the hook functions </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the hook </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pfn</em> </td><td>A pointer to a function that will be called </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aszPre</em> </td><td>a NULL-terminated array of strings that name modules whose hooks should precede this one </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aszSucc</em> </td><td>a NULL-terminated array of strings that name modules whose hooks should succeed this one </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nOrder</em> </td><td>an integer determining order before honouring aszPre and aszSucc (for example HOOK_MIDDLE) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaff32812046580ae53b0368918374a3b6"></a><!-- doxytag: member="apr_optional_hooks.h::apr_optional_hook_add" ref="gaff32812046580ae53b0368918374a3b6" args="(const char *szName, void(*pfn)(void), const char *const *aszPre, const char *const *aszSucc, int nOrder)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_optional_hook_add </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>szName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void) </td>
<td class="paramname"> <em>pfn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const * </td>
<td class="paramname"> <em>aszPre</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const * </td>
<td class="paramname"> <em>aszSucc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nOrder</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function to implemnt the APR_OPTIONAL_HOOK Macro </p>
</div>
</div>
</div>
<!--- 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>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Feb 1 12:19:48 2012 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.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
7c859c6f61469ed11e2ab179848b0178
>
files
>
170
