/
usr
/
share
/
doc
/
libaprutil1-dev
/
html
/
Upload File
HOME
<!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>Apache Portable Runtime Utility Library: Hook probe capability</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">Apache Portable Runtime Utility Library </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="#define-members">Macros</a> </div> <div class="headertitle"> <div class="title">Hook probe capability<div class="ingroups"><a class="el" href="group___a_p_r___util.html">APR Utility Functions</a> » <a class="el" href="group___a_p_r___util___hook.html">Hook Functions</a></div></div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Collaboration diagram for Hook probe capability:</div> <div class="dyncontent"> <center><table><tr><td><img src="group__apr__hook__probes.png" border="0" alt="" usemap="#group____apr____hook____probes"/> <!-- MAP 0 --> </td></tr></table></center> </div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:ga258d03fb4cf228fcb9d2fa094625ffaf"><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 class="separator:ga258d03fb4cf228fcb9d2fa094625ffaf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga320422eebccc41f9329e34e11939e302"><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 class="separator:ga320422eebccc41f9329e34e11939e302"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab3017efe0bb66b97b6b7931245211692"><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 class="separator:gab3017efe0bb66b97b6b7931245211692"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga030df3d86fe087857b32388e01ad3928"><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 class="separator:ga030df3d86fe087857b32388e01ad3928"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5793578cb2da7815b20b9a87c281ed7c"><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> <tr class="separator:ga5793578cb2da7815b20b9a87c281ed7c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">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> <h2 class="groupheader">Macro Definition Documentation</h2> <a id="ga258d03fb4cf228fcb9d2fa094625ffaf"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga258d03fb4cf228fcb9d2fa094625ffaf">◆ </a></span>APR_HOOK_INT_DCL_UD</h2> <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 id="ga5793578cb2da7815b20b9a87c281ed7c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga5793578cb2da7815b20b9a87c281ed7c">◆ </a></span>APR_HOOK_PROBE_COMPLETE</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_HOOK_PROBE_COMPLETE</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">ud, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">ns, </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">src, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">rv, </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></td> </tr> </table> </div><div class="memdoc"> <p>User-defined hook probe macro that is invoked after calling a hook function. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ud</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 class="paramname">ns</td><td>The namespace prefix of the hook functions </td></tr> <tr><td class="paramname">name</td><td>The name of the hook </td></tr> <tr><td class="paramname">src</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 class="paramname">rv</td><td>The return value of the hook function, or 0 if the hook is void. </td></tr> <tr><td class="paramname">args</td><td>The argument list to the hook functions, with enclosing parens. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga320422eebccc41f9329e34e11939e302"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga320422eebccc41f9329e34e11939e302">◆ </a></span>APR_HOOK_PROBE_ENTRY</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_HOOK_PROBE_ENTRY</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">ud, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">ns, </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></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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ud</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 class="paramname">ns</td><td>The namespace prefix of the hook functions </td></tr> <tr><td class="paramname">name</td><td>The name of the hook </td></tr> <tr><td class="paramname">args</td><td>The argument list to the hook functions, with enclosing parens. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga030df3d86fe087857b32388e01ad3928"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga030df3d86fe087857b32388e01ad3928">◆ </a></span>APR_HOOK_PROBE_INVOKE</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_HOOK_PROBE_INVOKE</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">ud, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">ns, </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">src, </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></td> </tr> </table> </div><div class="memdoc"> <p>User-defined hook probe macro that is invoked before calling a hook function. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ud</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 class="paramname">ns</td><td>The namespace prefix of the hook functions </td></tr> <tr><td class="paramname">name</td><td>The name of the hook </td></tr> <tr><td class="paramname">src</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 class="paramname">args</td><td>The argument list to the hook functions, with enclosing parens. </td></tr> </table> </dd> </dl> </div> </div> <a id="gab3017efe0bb66b97b6b7931245211692"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab3017efe0bb66b97b6b7931245211692">◆ </a></span>APR_HOOK_PROBE_RETURN</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_HOOK_PROBE_RETURN</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">ud, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">ns, </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">rv, </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></td> </tr> </table> </div><div class="memdoc"> <p>User-defined hook probe macro that is invoked after the hook has run. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ud</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 class="paramname">ns</td><td>The namespace prefix of the hook functions </td></tr> <tr><td class="paramname">name</td><td>The name of the hook </td></tr> <tr><td class="paramname">rv</td><td>The return value of the hook, or 0 if the hook is void. </td></tr> <tr><td class="paramname">args</td><td>The argument list to the hook functions, with enclosing parens. </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>