<!-- 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: Hook probe capability</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>Hook probe capability<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__apr__hook__probes.html#ga258d03fb4cf228fcb9d2fa094625ffaf">APR_HOOK_INT_DCL_UD</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hook__probes.html#ga320422eebccc41f9329e34e11939e302">APR_HOOK_PROBE_ENTRY</a>(ud, ns, name, args)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hook__probes.html#gab3017efe0bb66b97b6b7931245211692">APR_HOOK_PROBE_RETURN</a>(ud, ns, name, rv, args)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hook__probes.html#ga030df3d86fe087857b32388e01ad3928">APR_HOOK_PROBE_INVOKE</a>(ud, ns, name, src, args)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hook__probes.html#ga5793578cb2da7815b20b9a87c281ed7c">APR_HOOK_PROBE_COMPLETE</a>(ud, ns, name, src, rv, args)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>APR hooks provide a trace probe capability for capturing the flow of control and return values with hooks.</p>
<p>In order to use this facility, the application must define the symbol APR_HOOK_PROBES_ENABLED and the four APR_HOOK_PROBE_ macros described below before including <a class="el" href="apr__hooks_8h.html" title="Apache hook functions.">apr_hooks.h</a> in files that use the APR_IMPLEMENT_EXTERNAL_HOOK_* macros.</p>
<p>This probe facility is not provided for APR optional hooks. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga258d03fb4cf228fcb9d2fa094625ffaf"></a><!-- doxytag: member="apr_hooks.h::APR_HOOK_INT_DCL_UD" ref="ga258d03fb4cf228fcb9d2fa094625ffaf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_HOOK_INT_DCL_UD</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>internal implementation detail to avoid the ud declaration when hook probes are not used </p>
</div>
</div>
<a class="anchor" id="ga5793578cb2da7815b20b9a87c281ed7c"></a><!-- doxytag: member="apr_hooks.h::APR_HOOK_PROBE_COMPLETE" ref="ga5793578cb2da7815b20b9a87c281ed7c" args="(ud, ns, name, src, rv, args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_HOOK_PROBE_COMPLETE</td>
<td>(</td>
<td class="paramtype">ud, </td>
</tr>
<tr>
<td class="paramkey"></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">src, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">rv, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">args </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>User-defined hook probe macro that is invoked after calling a hook function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ud</em> </td><td>A void * user data field that was filled in by the user- provided <a class="el" href="group__apr__hook__probes.html#ga320422eebccc41f9329e34e11939e302">APR_HOOK_PROBE_ENTRY()</a>. </td></tr>
<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>src</em> </td><td>The value of apr_hook_debug_current at the time the function was hooked (usually the source file implementing the hook function). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rv</em> </td><td>The return value of the hook function, or 0 if the hook is void. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>The argument list to the hook functions, with enclosing parens. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga320422eebccc41f9329e34e11939e302"></a><!-- doxytag: member="apr_hooks.h::APR_HOOK_PROBE_ENTRY" ref="ga320422eebccc41f9329e34e11939e302" args="(ud, ns, name, args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_HOOK_PROBE_ENTRY</td>
<td>(</td>
<td class="paramtype">ud, </td>
</tr>
<tr>
<td class="paramkey"></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">args </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>User-defined hook probe macro that is invoked when the hook is run, before calling any hook functions. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ud</em> </td><td>A void * user data field that should be filled in by this macro, and will be provided to the other hook probe macros. </td></tr>
<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>args</em> </td><td>The argument list to the hook functions, with enclosing parens. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga030df3d86fe087857b32388e01ad3928"></a><!-- doxytag: member="apr_hooks.h::APR_HOOK_PROBE_INVOKE" ref="ga030df3d86fe087857b32388e01ad3928" args="(ud, ns, name, src, args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_HOOK_PROBE_INVOKE</td>
<td>(</td>
<td class="paramtype">ud, </td>
</tr>
<tr>
<td class="paramkey"></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">src, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">args </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>User-defined hook probe macro that is invoked before calling a hook function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ud</em> </td><td>A void * user data field that was filled in by the user- provided <a class="el" href="group__apr__hook__probes.html#ga320422eebccc41f9329e34e11939e302">APR_HOOK_PROBE_ENTRY()</a>. </td></tr>
<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>src</em> </td><td>The value of apr_hook_debug_current at the time the function was hooked (usually the source file implementing the hook function). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>The argument list to the hook functions, with enclosing parens. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab3017efe0bb66b97b6b7931245211692"></a><!-- doxytag: member="apr_hooks.h::APR_HOOK_PROBE_RETURN" ref="gab3017efe0bb66b97b6b7931245211692" args="(ud, ns, name, rv, args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_HOOK_PROBE_RETURN</td>
<td>(</td>
<td class="paramtype">ud, </td>
</tr>
<tr>
<td class="paramkey"></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">rv, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">args </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>User-defined hook probe macro that is invoked after the hook has run. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ud</em> </td><td>A void * user data field that was filled in by the user- provided <a class="el" href="group__apr__hook__probes.html#ga320422eebccc41f9329e34e11939e302">APR_HOOK_PROBE_ENTRY()</a>. </td></tr>
<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>rv</em> </td><td>The return value of the hook, or 0 if the hook is void. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>The argument list to the hook functions, with enclosing parens. </td></tr>
</table>
</dd>
</dl>
</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
>
180
