versioning
[m6w6/ext-raphf] / v1.1.x / structphp__persistent__handle__factory.html
diff --git a/v1.1.x/structphp__persistent__handle__factory.html b/v1.1.x/structphp__persistent__handle__factory.html
new file mode 100644 (file)
index 0000000..e4334f5
--- /dev/null
@@ -0,0 +1,267 @@
+<!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.5"/>
+<title>Resource and persistent handle factory API: php_persistent_handle_factory Struct Reference</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="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/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 id="projectlogo"><img alt="Logo" src="raphf.png"/></td>
+  <td 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.5 -->
+<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 class="current"><a href="annotated.html"><span>Data&#160;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 id="navrow2" class="tabs2">
+    <ul class="tablist">
+      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
+      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
+      <li><a href="functions.html"><span>Data&#160;Fields</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('structphp__persistent__handle__factory.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)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</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="#pub-attribs">Data Fields</a>  </div>
+  <div class="headertitle">
+<div class="title">php_persistent_handle_factory Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Definition of a persistent handle factory.  
+ <a href="structphp__persistent__handle__factory.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="php__raphf_8h_source.html">php_raphf.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for php_persistent_handle_factory:</div>
+<div class="dyncontent">
+<div class="center"><img src="structphp__persistent__handle__factory__coll__graph.png" border="0" usemap="#php__persistent__handle__factory_coll__map" alt="Collaboration graph"/></div>
+<map name="php__persistent__handle__factory_coll__map" id="php__persistent__handle__factory_coll__map">
+<area shape="rect" id="node2" href="structphp__persistent__handle__provider.html" title="Definition of a persistent handle provider. " alt="" coords="76,187,228,229"/><area shape="rect" id="node3" href="structphp__persistent__handle__list.html" title="Persistent handles storage. " alt="" coords="5,96,181,123"/><area shape="rect" id="node4" href="structphp__resource__factory.html" title="The resource factory. " alt="" coords="205,96,352,123"/><area shape="rect" id="node5" href="structphp__resource__factory__ops.html" title="The resource ops consisting of a ctor, a copy ctor and a dtor. " alt="" coords="191,5,365,32"/></map>
+<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Data Fields</h2></td></tr>
+<tr class="memitem:a43aabcbe7ec4b5ff463f74cfcf788f51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf_8h.html#a31f0595f4f726f762790cef844568fc4">php_persistent_handle_provider_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__persistent__handle__factory.html#a43aabcbe7ec4b5ff463f74cfcf788f51">provider</a></td></tr>
+<tr class="memdesc:a43aabcbe7ec4b5ff463f74cfcf788f51"><td class="mdescLeft">&#160;</td><td class="mdescRight">The persistent handle provider.  <a href="#a43aabcbe7ec4b5ff463f74cfcf788f51">More...</a><br/></td></tr>
+<tr class="separator:a43aabcbe7ec4b5ff463f74cfcf788f51"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6633b7c860e4538942e0367d64ed5af7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf_8h.html#a681ca1f7c1249199b45270be60c721c6">php_persistent_handle_wakeup_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__persistent__handle__factory.html#a6633b7c860e4538942e0367d64ed5af7">wakeup</a></td></tr>
+<tr class="memdesc:a6633b7c860e4538942e0367d64ed5af7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The persistent handle wakeup routine; may be NULL.  <a href="#a6633b7c860e4538942e0367d64ed5af7">More...</a><br/></td></tr>
+<tr class="separator:a6633b7c860e4538942e0367d64ed5af7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9299f3f0821061ad93d15c10cf735b6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf_8h.html#a8f7d6389c67478ca0b99729a5dd3d305">php_persistent_handle_retire_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__persistent__handle__factory.html#a9299f3f0821061ad93d15c10cf735b6b">retire</a></td></tr>
+<tr class="memdesc:a9299f3f0821061ad93d15c10cf735b6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The persistent handle retire routine; may be NULL.  <a href="#a9299f3f0821061ad93d15c10cf735b6b">More...</a><br/></td></tr>
+<tr class="separator:a9299f3f0821061ad93d15c10cf735b6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae874c03caffa8eaa265dd52ebf593c02"><td class="memItemLeft" >struct {</td></tr>
+<tr class="memitem:a3bfa871ff526fa80a3e5ccc5c163f9ab"><td class="memItemLeft" >&#160;&#160;&#160;char *&#160;&#160;&#160;<a class="el" href="structphp__persistent__handle__factory.html#a71be5a461851c6d3b93fa88126a2feae">str</a></td></tr>
+<tr class="memdesc:a3bfa871ff526fa80a3e5ccc5c163f9ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">ident string  <a href="#a3bfa871ff526fa80a3e5ccc5c163f9ab">More...</a><br/></td></tr>
+<tr class="separator:a3bfa871ff526fa80a3e5ccc5c163f9ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac2c77473ee2989bc86a02f4bcc69977e"><td class="memItemLeft" >&#160;&#160;&#160;size_t&#160;&#160;&#160;<a class="el" href="structphp__persistent__handle__factory.html#ab26e72bac3190bd8cd4dadc6a39d86c4">len</a></td></tr>
+<tr class="memdesc:ac2c77473ee2989bc86a02f4bcc69977e"><td class="mdescLeft">&#160;</td><td class="mdescRight">ident length  <a href="#ac2c77473ee2989bc86a02f4bcc69977e">More...</a><br/></td></tr>
+<tr class="separator:ac2c77473ee2989bc86a02f4bcc69977e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae874c03caffa8eaa265dd52ebf593c02"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__persistent__handle__factory.html#ae874c03caffa8eaa265dd52ebf593c02">ident</a></td></tr>
+<tr class="memdesc:ae874c03caffa8eaa265dd52ebf593c02"><td class="mdescLeft">&#160;</td><td class="mdescRight">The ident for which this factory manages resources.  <a href="#ae874c03caffa8eaa265dd52ebf593c02">More...</a><br/></td></tr>
+<tr class="separator:ae874c03caffa8eaa265dd52ebf593c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a84ffa94401b9869e14c190be4bb1b6be"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__persistent__handle__factory.html#a84ffa94401b9869e14c190be4bb1b6be">free_on_abandon</a>:1</td></tr>
+<tr class="memdesc:a84ffa94401b9869e14c190be4bb1b6be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether it has to be free'd on <a class="el" href="php__raphf_8h.html#ab12ec2da7189e16fbed40a3b73bc9ee2" title="Abandon the persistent handle factory. ">php_persistent_handle_abandon()</a>  <a href="#a84ffa94401b9869e14c190be4bb1b6be">More...</a><br/></td></tr>
+<tr class="separator:a84ffa94401b9869e14c190be4bb1b6be"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Definition of a persistent handle factory. </p>
+<p><a class="el" href="php__raphf_8h.html#a0a266874dafb69cf2b040378d4033901" title="Retrieve a persistent handle factory at runtime. ">php_persistent_handle_concede()</a> will return a pointer to a <a class="el" href="structphp__persistent__handle__factory.html" title="Definition of a persistent handle factory. ">php_persistent_handle_factory</a> if a provider for the <em>name_str</em> has been registered with <a class="el" href="php__raphf_8h.html#a3cbbe29c8a4ed9858c921c8ee539de59" title="Register a persistent handle provider in MINIT. ">php_persistent_handle_provide()</a>. </p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a class="anchor" id="a84ffa94401b9869e14c190be4bb1b6be"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">unsigned php_persistent_handle_factory::free_on_abandon</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Whether it has to be free'd on <a class="el" href="php__raphf_8h.html#ab12ec2da7189e16fbed40a3b73bc9ee2" title="Abandon the persistent handle factory. ">php_persistent_handle_abandon()</a> </p>
+
+</div>
+</div>
+<a class="anchor" id="ae874c03caffa8eaa265dd52ebf593c02"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct { ... }   php_persistent_handle_factory::ident</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>The ident for which this factory manages resources. </p>
+
+</div>
+</div>
+<a class="anchor" id="ab26e72bac3190bd8cd4dadc6a39d86c4"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">size_t php_persistent_handle_factory::len</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>ident length </p>
+
+</div>
+</div>
+<a class="anchor" id="a43aabcbe7ec4b5ff463f74cfcf788f51"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="php__raphf_8h.html#a31f0595f4f726f762790cef844568fc4">php_persistent_handle_provider_t</a>* php_persistent_handle_factory::provider</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>The persistent handle provider. </p>
+
+</div>
+</div>
+<a class="anchor" id="a9299f3f0821061ad93d15c10cf735b6b"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="php__raphf_8h.html#a8f7d6389c67478ca0b99729a5dd3d305">php_persistent_handle_retire_t</a> php_persistent_handle_factory::retire</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>The persistent handle retire routine; may be NULL. </p>
+
+</div>
+</div>
+<a class="anchor" id="a71be5a461851c6d3b93fa88126a2feae"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">char* php_persistent_handle_factory::str</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>ident string </p>
+
+</div>
+</div>
+<a class="anchor" id="a6633b7c860e4538942e0367d64ed5af7"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="php__raphf_8h.html#a681ca1f7c1249199b45270be60c721c6">php_persistent_handle_wakeup_t</a> php_persistent_handle_factory::wakeup</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>The persistent handle wakeup routine; may be NULL. </p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="php__raphf_8h_source.html">php_raphf.h</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="navelem"><a class="el" href="structphp__persistent__handle__factory.html">php_persistent_handle_factory</a></li>
+    <li class="footer">Generated on Wed Dec 4 2013 12:20:29 for Resource and persistent handle factory API by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
+  </ul>
+</div>
+</body>
+</html>