update master docs
[m6w6/ext-raphf] / master / globals.html
diff --git a/master/globals.html b/master/globals.html
new file mode 100644 (file)
index 0000000..88df4b1
--- /dev/null
@@ -0,0 +1,294 @@
+<!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.10"/>
+<title>Resource and persistent handle factory API: Globals</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="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+  $(document).ready(initResizable);
+  $(window).load(resizeHeight);
+</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>
+<script type="text/javascript">
+  $(document).ready(function() { init_search(); });
+</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="projectlogo"><img alt="Logo" src="raphf.png"/></td>
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">Resource and persistent handle factory API
+   </div>
+   <div id="projectbrief">A facility to manage possibly persistent resources with a comprehensible API.  Provides simliar functionality like the zend_list API, but with more flexiblity and freedom.</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.10 -->
+<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&#160;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
+      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
+      <li class="current"><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 id="navrow2" class="tabs2">
+    <ul class="tablist">
+      <li><a href="files.html"><span>File&#160;List</span></a></li>
+      <li class="current"><a href="globals.html"><span>Globals</span></a></li>
+    </ul>
+  </div>
+  <div id="navrow3" class="tabs2">
+    <ul class="tablist">
+      <li class="current"><a href="globals.html"><span>All</span></a></li>
+      <li><a href="globals_func.html"><span>Functions</span></a></li>
+      <li><a href="globals_vars.html"><span>Variables</span></a></li>
+      <li><a href="globals_type.html"><span>Typedefs</span></a></li>
+      <li><a href="globals_defs.html"><span>Macros</span></a></li>
+    </ul>
+  </div>
+  <div id="navrow4" class="tabs3">
+    <ul class="tablist">
+      <li><a href="#index_p"><span>p</span></a></li>
+      <li><a href="#index_r"><span>r</span></a></li>
+      <li><a href="#index_s"><span>s</span></a></li>
+      <li class="current"><a href="#index_z"><span>z</span></a></li>
+    </ul>
+  </div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('globals.html','');});
+</script>
+<div id="doc-content">
+<!-- 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="contents">
+<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div>
+
+<h3><a class="anchor" id="index_p"></a>- p -</h3><ul>
+<li>persistent_handle
+: <a class="el" href="php__raphf__api_8c.html#a385b722141c96392a35d8b6dfc29b0d3">php_raphf_api.c</a>
+</li>
+<li>PHP_MINFO_FUNCTION()
+: <a class="el" href="php__raphf__api_8c.html#afe0b826f07940e0297395eb758b6dc63">php_raphf_api.c</a>
+</li>
+<li>PHP_MINIT_FUNCTION()
+: <a class="el" href="php__raphf__api_8c.html#a98ef98eb514bf71723b22e93ef4fb099">php_raphf_api.c</a>
+</li>
+<li>PHP_MSHUTDOWN_FUNCTION()
+: <a class="el" href="php__raphf__api_8c.html#a9bdad7e7a27b1cce6be5ec842da0c921">php_raphf_api.c</a>
+</li>
+<li>php_persistent_handle_abandon()
+: <a class="el" href="php__raphf__api_8c.html#ab12ec2da7189e16fbed40a3b73bc9ee2">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#ab12ec2da7189e16fbed40a3b73bc9ee2">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_accrete()
+: <a class="el" href="php__raphf__api_8c.html#ae8124f3f73e96e2193ae03c5519d2763">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#ae8124f3f73e96e2193ae03c5519d2763">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_acquire()
+: <a class="el" href="php__raphf__api_8c.html#af6636e870497be0699d2781e5fc8a2a9">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#af6636e870497be0699d2781e5fc8a2a9">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_cleanup()
+: <a class="el" href="php__raphf__api_8c.html#a8368c07c20ecf1d4f06aa6a4e5849df8">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#a8368c07c20ecf1d4f06aa6a4e5849df8">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_concede()
+: <a class="el" href="php__raphf__api_8c.html#ab7cc28d4d1dcf715dc05069a0dcac11f">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#ab7cc28d4d1dcf715dc05069a0dcac11f">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_factory_t
+: <a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_get_resource_factory_ops()
+: <a class="el" href="php__raphf__api_8c.html#a93458ab12d810f0fd545fb1464ba9eca">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#a93458ab12d810f0fd545fb1464ba9eca">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_list_t
+: <a class="el" href="php__raphf__api_8h.html#a07f599598d2b87b188f39871d026c177">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_provide()
+: <a class="el" href="php__raphf__api_8c.html#ab7bc43582b0307526d80e83dba88c571">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#ab7bc43582b0307526d80e83dba88c571">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_provider_t
+: <a class="el" href="php__raphf__api_8h.html#a31f0595f4f726f762790cef844568fc4">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_release()
+: <a class="el" href="php__raphf__api_8c.html#af08ee05c51d52200755d24f6f52df144">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#af08ee05c51d52200755d24f6f52df144">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_resource_factory_init()
+: <a class="el" href="php__raphf__api_8c.html#ab754f4d59dab5de0edf702a9ab2f4e03">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#ab754f4d59dab5de0edf702a9ab2f4e03">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_retire_t
+: <a class="el" href="php__raphf__api_8h.html#a85e9e715d308dc5d98b980c9c57d02bf">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_statall()
+: <a class="el" href="php__raphf__api_8c.html#ae174fbe124d4cb6010e218a68379bd18">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#ae174fbe124d4cb6010e218a68379bd18">php_raphf_api.h</a>
+</li>
+<li>php_persistent_handle_wakeup_t
+: <a class="el" href="php__raphf__api_8h.html#a59f5566ecc4c76e048ad53469eb20142">php_raphf_api.h</a>
+</li>
+<li>PHP_RAPHF_API
+: <a class="el" href="php__raphf_8h.html#a379b9663dc302070f84fafdc4c48d7eb">php_raphf.h</a>
+</li>
+<li>PHP_RAPHF_DEBUG_PHANDLES
+: <a class="el" href="php__raphf__api_8c.html#a4ac4e8587a25a7617a3bb1b2b246fe7f">php_raphf_api.c</a>
+</li>
+<li>PHP_RAPHF_G
+: <a class="el" href="php__raphf__api_8c.html#a5a6099bca8801bd4a502806ab49c1d1c">php_raphf_api.c</a>
+</li>
+<li>PHP_RAPHF_TEST
+: <a class="el" href="php__raphf__api_8c.html#a1a89ef4d87548194ddf4eba935ca72ea">php_raphf_api.c</a>
+</li>
+<li>PHP_RAPHF_VERSION
+: <a class="el" href="php__raphf_8h.html#ad71962d03ef6d7009f69765ad54f8857">php_raphf.h</a>
+</li>
+<li>php_resource_factory_addref()
+: <a class="el" href="php__raphf__api_8c.html#ae8be369197905047ffbd05c0ca80f245">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#ae8be369197905047ffbd05c0ca80f245">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_dtor()
+: <a class="el" href="php__raphf__api_8c.html#a016b8a4159e698f915ab967711696847">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#a016b8a4159e698f915ab967711696847">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_free()
+: <a class="el" href="php__raphf__api_8c.html#a7f012d685f5f7c08f50288b61232e689">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#a7f012d685f5f7c08f50288b61232e689">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_handle_copy()
+: <a class="el" href="php__raphf__api_8c.html#a08db5f3698f2d0bf3d2f20dcf4e7b2b4">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#a08db5f3698f2d0bf3d2f20dcf4e7b2b4">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_handle_copy_t
+: <a class="el" href="php__raphf__api_8h.html#a23b073aa7b8b7dd182b336b07494288f">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_handle_ctor()
+: <a class="el" href="php__raphf__api_8c.html#a98d02dc80dd83095b8f901954350840c">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#a98d02dc80dd83095b8f901954350840c">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_handle_ctor_t
+: <a class="el" href="php__raphf__api_8h.html#abadff49d810f7ce220bd3537bdaecef7">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_handle_dtor()
+: <a class="el" href="php__raphf__api_8c.html#a97dbb9d342f33205b92374c586676bc6">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#a97dbb9d342f33205b92374c586676bc6">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_handle_dtor_t
+: <a class="el" href="php__raphf__api_8h.html#a1b826c765392c93336db79bd6697e33d">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_init()
+: <a class="el" href="php__raphf__api_8c.html#ad20f10c53e3f33756638da98819367f0">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#ad20f10c53e3f33756638da98819367f0">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_is_persistent()
+: <a class="el" href="php__raphf__api_8c.html#a617d2cc656ab6427388b938597194ebb">php_raphf_api.c</a>
+, <a class="el" href="php__raphf__api_8h.html#a617d2cc656ab6427388b938597194ebb">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_ops_t
+: <a class="el" href="php__raphf__api_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_raphf_api.h</a>
+</li>
+<li>php_resource_factory_t
+: <a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_raphf_api.h</a>
+</li>
+<li>phpext_raphf_ptr
+: <a class="el" href="php__raphf_8h.html#a41a94f99848b07699e3fde33180208c1">php_raphf.h</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
+<li>raphf_module_entry
+: <a class="el" href="php__raphf_8h.html#a42f904573a2c5b1eba6ccd6604269f99">php_raphf.h</a>
+, <a class="el" href="php__raphf__api_8c.html#a42f904573a2c5b1eba6ccd6604269f99">php_raphf_api.c</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
+<li>STD_PHP_INI_ENTRY()
+: <a class="el" href="php__raphf__api_8c.html#ad2aba389e88a1e9e11b7dae021bfddfc">php_raphf_api.c</a>
+</li>
+</ul>
+
+
+<h3><a class="anchor" id="index_z"></a>- z -</h3><ul>
+<li>ZEND_END_ARG_INFO()
+: <a class="el" href="php__raphf__api_8c.html#a9337bda6793399d5917999063e1aa636">php_raphf_api.c</a>
+</li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">Generated by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
+  </ul>
+</div>
+</body>
+</html>