update master docs
[m6w6/ext-raphf] / master / php__raphf__api_8c.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.10"/>
7 <title>Resource and persistent handle factory API: src/php_raphf_api.c File Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="resize.js"></script>
13 <script type="text/javascript" src="navtreedata.js"></script>
14 <script type="text/javascript" src="navtree.js"></script>
15 <script type="text/javascript">
16 $(document).ready(initResizable);
17 $(window).load(resizeHeight);
18 </script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 $(document).ready(function() { init_search(); });
24 </script>
25 <link href="doxygen.css" rel="stylesheet" type="text/css" />
26 </head>
27 <body>
28 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29 <div id="titlearea">
30 <table cellspacing="0" cellpadding="0">
31 <tbody>
32 <tr style="height: 56px;">
33 <td id="projectlogo"><img alt="Logo" src="raphf.png"/></td>
34 <td id="projectalign" style="padding-left: 0.5em;">
35 <div id="projectname">Resource and persistent handle factory API
36 </div>
37 <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>
38 </td>
39 </tr>
40 </tbody>
41 </table>
42 </div>
43 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.10 -->
45 <script type="text/javascript">
46 var searchBox = new SearchBox("searchBox", "search",false,'Search');
47 </script>
48 <div id="navrow1" class="tabs">
49 <ul class="tablist">
50 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
51 <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
52 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
53 <li class="current"><a href="files.html"><span>Files</span></a></li>
54 <li>
55 <div id="MSearchBox" class="MSearchBoxInactive">
56 <span class="left">
57 <img id="MSearchSelect" src="search/mag_sel.png"
58 onmouseover="return searchBox.OnSearchSelectShow()"
59 onmouseout="return searchBox.OnSearchSelectHide()"
60 alt=""/>
61 <input type="text" id="MSearchField" value="Search" accesskey="S"
62 onfocus="searchBox.OnSearchFieldFocus(true)"
63 onblur="searchBox.OnSearchFieldFocus(false)"
64 onkeyup="searchBox.OnSearchFieldChange(event)"/>
65 </span><span class="right">
66 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
67 </span>
68 </div>
69 </li>
70 </ul>
71 </div>
72 <div id="navrow2" class="tabs2">
73 <ul class="tablist">
74 <li><a href="files.html"><span>File&#160;List</span></a></li>
75 <li><a href="globals.html"><span>Globals</span></a></li>
76 </ul>
77 </div>
78 </div><!-- top -->
79 <div id="side-nav" class="ui-resizable side-nav-resizable">
80 <div id="nav-tree">
81 <div id="nav-tree-contents">
82 <div id="nav-sync" class="sync"></div>
83 </div>
84 </div>
85 <div id="splitbar" style="-moz-user-select:none;"
86 class="ui-resizable-handle">
87 </div>
88 </div>
89 <script type="text/javascript">
90 $(document).ready(function(){initNavTree('php__raphf__api_8c.html','');});
91 </script>
92 <div id="doc-content">
93 <!-- window showing the filter options -->
94 <div id="MSearchSelectWindow"
95 onmouseover="return searchBox.OnSearchSelectShow()"
96 onmouseout="return searchBox.OnSearchSelectHide()"
97 onkeydown="return searchBox.OnSearchSelectKey(event)">
98 </div>
99
100 <!-- iframe showing the search results (closed by default) -->
101 <div id="MSearchResultsWindow">
102 <iframe src="javascript:void(0)" frameborder="0"
103 name="MSearchResults" id="MSearchResults">
104 </iframe>
105 </div>
106
107 <div class="header">
108 <div class="summary">
109 <a href="#define-members">Macros</a> &#124;
110 <a href="#func-members">Functions</a> &#124;
111 <a href="#var-members">Variables</a> </div>
112 <div class="headertitle">
113 <div class="title">php_raphf_api.c File Reference</div> </div>
114 </div><!--header-->
115 <div class="contents">
116 <div class="textblock"><code>#include &quot;php.h&quot;</code><br />
117 <code>#include &quot;php_ini.h&quot;</code><br />
118 <code>#include &quot;ext/standard/info.h&quot;</code><br />
119 <code>#include &quot;<a class="el" href="php__raphf_8h_source.html">php_raphf.h</a>&quot;</code><br />
120 </div><div class="textblock"><div class="dynheader">
121 Include dependency graph for php_raphf_api.c:</div>
122 <div class="dyncontent">
123 <div class="center"><img src="php__raphf__api_8c__incl.png" border="0" usemap="#src_2php__raphf__api_8c" alt=""/></div>
124 <map name="src_2php__raphf__api_8c" id="src_2php__raphf__api_8c">
125 <area shape="rect" id="node5" href="php__raphf_8h.html" title="php_raphf.h" alt="" coords="338,80,429,107"/>
126 <area shape="rect" id="node6" href="php__raphf__api_8h.html" title="php_raphf_api.h" alt="" coords="326,155,441,181"/>
127 </map>
128 </div>
129 </div><table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
131 Macros</h2></td></tr>
132 <tr class="memitem:a1a89ef4d87548194ddf4eba935ca72ea"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a1a89ef4d87548194ddf4eba935ca72ea">PHP_RAPHF_TEST</a>&#160;&#160;&#160;0</td></tr>
133 <tr class="separator:a1a89ef4d87548194ddf4eba935ca72ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
134 <tr class="memitem:a5a6099bca8801bd4a502806ab49c1d1c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a5a6099bca8801bd4a502806ab49c1d1c">PHP_RAPHF_G</a>&#160;&#160;&#160;(&amp;raphf_globals)</td></tr>
135 <tr class="separator:a5a6099bca8801bd4a502806ab49c1d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <tr class="memitem:a4ac4e8587a25a7617a3bb1b2b246fe7f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a4ac4e8587a25a7617a3bb1b2b246fe7f">PHP_RAPHF_DEBUG_PHANDLES</a>&#160;&#160;&#160;0</td></tr>
137 <tr class="separator:a4ac4e8587a25a7617a3bb1b2b246fe7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 </table><table class="memberdecls">
139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
140 Functions</h2></td></tr>
141 <tr class="memitem:ad20f10c53e3f33756638da98819367f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ad20f10c53e3f33756638da98819367f0">php_resource_factory_init</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *f, <a class="el" href="php__raphf__api_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a> *fops, void *data, void(*dtor)(void *data))</td></tr>
142 <tr class="memdesc:ad20f10c53e3f33756638da98819367f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a resource factory. <a href="#ad20f10c53e3f33756638da98819367f0">More...</a><br /></td></tr>
143 <tr class="separator:ad20f10c53e3f33756638da98819367f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:ae8be369197905047ffbd05c0ca80f245"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ae8be369197905047ffbd05c0ca80f245">php_resource_factory_addref</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *rf)</td></tr>
145 <tr class="memdesc:ae8be369197905047ffbd05c0ca80f245"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increase the refcount of the resource factory. <a href="#ae8be369197905047ffbd05c0ca80f245">More...</a><br /></td></tr>
146 <tr class="separator:ae8be369197905047ffbd05c0ca80f245"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a016b8a4159e698f915ab967711696847"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a016b8a4159e698f915ab967711696847">php_resource_factory_dtor</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *f)</td></tr>
148 <tr class="memdesc:a016b8a4159e698f915ab967711696847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the resource factory. <a href="#a016b8a4159e698f915ab967711696847">More...</a><br /></td></tr>
149 <tr class="separator:a016b8a4159e698f915ab967711696847"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a7f012d685f5f7c08f50288b61232e689"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a7f012d685f5f7c08f50288b61232e689">php_resource_factory_free</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> **f)</td></tr>
151 <tr class="memdesc:a7f012d685f5f7c08f50288b61232e689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy and free the resource factory. <a href="#a7f012d685f5f7c08f50288b61232e689">More...</a><br /></td></tr>
152 <tr class="separator:a7f012d685f5f7c08f50288b61232e689"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:a98d02dc80dd83095b8f901954350840c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a98d02dc80dd83095b8f901954350840c">php_resource_factory_handle_ctor</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *f, void *init_arg)</td></tr>
154 <tr class="memdesc:a98d02dc80dd83095b8f901954350840c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a resource by the resource factory <em>f</em>. <a href="#a98d02dc80dd83095b8f901954350840c">More...</a><br /></td></tr>
155 <tr class="separator:a98d02dc80dd83095b8f901954350840c"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:a08db5f3698f2d0bf3d2f20dcf4e7b2b4"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a08db5f3698f2d0bf3d2f20dcf4e7b2b4">php_resource_factory_handle_copy</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *f, void *handle)</td></tr>
157 <tr class="memdesc:a08db5f3698f2d0bf3d2f20dcf4e7b2b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a copy of the resource <em>handle</em>. <a href="#a08db5f3698f2d0bf3d2f20dcf4e7b2b4">More...</a><br /></td></tr>
158 <tr class="separator:a08db5f3698f2d0bf3d2f20dcf4e7b2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:a97dbb9d342f33205b92374c586676bc6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a97dbb9d342f33205b92374c586676bc6">php_resource_factory_handle_dtor</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *f, void *handle)</td></tr>
160 <tr class="memdesc:a97dbb9d342f33205b92374c586676bc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy (and free) the resource. <a href="#a97dbb9d342f33205b92374c586676bc6">More...</a><br /></td></tr>
161 <tr class="separator:a97dbb9d342f33205b92374c586676bc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:ab754f4d59dab5de0edf702a9ab2f4e03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ab754f4d59dab5de0edf702a9ab2f4e03">php_persistent_handle_resource_factory_init</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *a, <a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *pf)</td></tr>
163 <tr class="memdesc:ab754f4d59dab5de0edf702a9ab2f4e03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a resource factory for persistent handles. <a href="#ab754f4d59dab5de0edf702a9ab2f4e03">More...</a><br /></td></tr>
164 <tr class="separator:ab754f4d59dab5de0edf702a9ab2f4e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:a617d2cc656ab6427388b938597194ebb"><td class="memItemLeft" align="right" valign="top">zend_bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a617d2cc656ab6427388b938597194ebb">php_resource_factory_is_persistent</a> (<a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *a)</td></tr>
166 <tr class="memdesc:a617d2cc656ab6427388b938597194ebb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a resource factory is a persistent handle resource factory. <a href="#a617d2cc656ab6427388b938597194ebb">More...</a><br /></td></tr>
167 <tr class="separator:a617d2cc656ab6427388b938597194ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:ab7bc43582b0307526d80e83dba88c571"><td class="memItemLeft" align="right" valign="top">ZEND_RESULT_CODE&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ab7bc43582b0307526d80e83dba88c571">php_persistent_handle_provide</a> (zend_string *name, <a class="el" href="php__raphf__api_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a> *fops, void *data, void(*dtor)(void *))</td></tr>
169 <tr class="memdesc:ab7bc43582b0307526d80e83dba88c571"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a persistent handle provider in MINIT. <a href="#ab7bc43582b0307526d80e83dba88c571">More...</a><br /></td></tr>
170 <tr class="separator:ab7bc43582b0307526d80e83dba88c571"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <tr class="memitem:ab7cc28d4d1dcf715dc05069a0dcac11f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ab7cc28d4d1dcf715dc05069a0dcac11f">php_persistent_handle_concede</a> (<a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *a, zend_string *name, zend_string *ident, <a class="el" href="php__raphf__api_8h.html#a59f5566ecc4c76e048ad53469eb20142">php_persistent_handle_wakeup_t</a> wakeup, <a class="el" href="php__raphf__api_8h.html#a85e9e715d308dc5d98b980c9c57d02bf">php_persistent_handle_retire_t</a> retire)</td></tr>
172 <tr class="memdesc:ab7cc28d4d1dcf715dc05069a0dcac11f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a persistent handle factory at runtime. <a href="#ab7cc28d4d1dcf715dc05069a0dcac11f">More...</a><br /></td></tr>
173 <tr class="separator:ab7cc28d4d1dcf715dc05069a0dcac11f"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <tr class="memitem:ab12ec2da7189e16fbed40a3b73bc9ee2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ab12ec2da7189e16fbed40a3b73bc9ee2">php_persistent_handle_abandon</a> (<a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *a)</td></tr>
175 <tr class="memdesc:ab12ec2da7189e16fbed40a3b73bc9ee2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abandon the persistent handle factory. <a href="#ab12ec2da7189e16fbed40a3b73bc9ee2">More...</a><br /></td></tr>
176 <tr class="separator:ab12ec2da7189e16fbed40a3b73bc9ee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <tr class="memitem:af6636e870497be0699d2781e5fc8a2a9"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#af6636e870497be0699d2781e5fc8a2a9">php_persistent_handle_acquire</a> (<a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *a, void *init_arg)</td></tr>
178 <tr class="memdesc:af6636e870497be0699d2781e5fc8a2a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquire a persistent handle. <a href="#af6636e870497be0699d2781e5fc8a2a9">More...</a><br /></td></tr>
179 <tr class="separator:af6636e870497be0699d2781e5fc8a2a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <tr class="memitem:ae8124f3f73e96e2193ae03c5519d2763"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ae8124f3f73e96e2193ae03c5519d2763">php_persistent_handle_accrete</a> (<a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *a, void *handle)</td></tr>
181 <tr class="memdesc:ae8124f3f73e96e2193ae03c5519d2763"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy a persistent handle. <a href="#ae8124f3f73e96e2193ae03c5519d2763">More...</a><br /></td></tr>
182 <tr class="separator:ae8124f3f73e96e2193ae03c5519d2763"><td class="memSeparator" colspan="2">&#160;</td></tr>
183 <tr class="memitem:af08ee05c51d52200755d24f6f52df144"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#af08ee05c51d52200755d24f6f52df144">php_persistent_handle_release</a> (<a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *a, void *handle)</td></tr>
184 <tr class="memdesc:af08ee05c51d52200755d24f6f52df144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release a persistent handle. <a href="#af08ee05c51d52200755d24f6f52df144">More...</a><br /></td></tr>
185 <tr class="separator:af08ee05c51d52200755d24f6f52df144"><td class="memSeparator" colspan="2">&#160;</td></tr>
186 <tr class="memitem:a8368c07c20ecf1d4f06aa6a4e5849df8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a8368c07c20ecf1d4f06aa6a4e5849df8">php_persistent_handle_cleanup</a> (zend_string *name, zend_string *ident)</td></tr>
187 <tr class="memdesc:a8368c07c20ecf1d4f06aa6a4e5849df8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clean persistent handles up. <a href="#a8368c07c20ecf1d4f06aa6a4e5849df8">More...</a><br /></td></tr>
188 <tr class="separator:a8368c07c20ecf1d4f06aa6a4e5849df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
189 <tr class="memitem:ae174fbe124d4cb6010e218a68379bd18"><td class="memItemLeft" align="right" valign="top">HashTable *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ae174fbe124d4cb6010e218a68379bd18">php_persistent_handle_statall</a> (HashTable *ht)</td></tr>
190 <tr class="memdesc:ae174fbe124d4cb6010e218a68379bd18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve statistics about the current process/thread's persistent handles. <a href="#ae174fbe124d4cb6010e218a68379bd18">More...</a><br /></td></tr>
191 <tr class="separator:ae174fbe124d4cb6010e218a68379bd18"><td class="memSeparator" colspan="2">&#160;</td></tr>
192 <tr class="memitem:a93458ab12d810f0fd545fb1464ba9eca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf__api_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a93458ab12d810f0fd545fb1464ba9eca">php_persistent_handle_get_resource_factory_ops</a> (void)</td></tr>
193 <tr class="memdesc:a93458ab12d810f0fd545fb1464ba9eca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve persistent handle resource factory ops. <a href="#a93458ab12d810f0fd545fb1464ba9eca">More...</a><br /></td></tr>
194 <tr class="separator:a93458ab12d810f0fd545fb1464ba9eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
195 <tr class="memitem:a9337bda6793399d5917999063e1aa636"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a9337bda6793399d5917999063e1aa636">ZEND_END_ARG_INFO</a> ()</td></tr>
196 <tr class="separator:a9337bda6793399d5917999063e1aa636"><td class="memSeparator" colspan="2">&#160;</td></tr>
197 <tr class="memitem:ad2aba389e88a1e9e11b7dae021bfddfc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#ad2aba389e88a1e9e11b7dae021bfddfc">STD_PHP_INI_ENTRY</a> (&quot;raphf.persistent_handle.limit&quot;,&quot;-1&quot;, PHP_INI_SYSTEM, OnUpdateLong, persistent_handle.limit, zend_raphf_globals, raphf_globals) static HashTable *php_persistent_handles_global_hash</td></tr>
198 <tr class="separator:ad2aba389e88a1e9e11b7dae021bfddfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
199 <tr class="memitem:a98ef98eb514bf71723b22e93ef4fb099"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a98ef98eb514bf71723b22e93ef4fb099">PHP_MINIT_FUNCTION</a> (raphf)</td></tr>
200 <tr class="separator:a98ef98eb514bf71723b22e93ef4fb099"><td class="memSeparator" colspan="2">&#160;</td></tr>
201 <tr class="memitem:a9bdad7e7a27b1cce6be5ec842da0c921"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a9bdad7e7a27b1cce6be5ec842da0c921">PHP_MSHUTDOWN_FUNCTION</a> (raphf)</td></tr>
202 <tr class="separator:a9bdad7e7a27b1cce6be5ec842da0c921"><td class="memSeparator" colspan="2">&#160;</td></tr>
203 <tr class="memitem:afe0b826f07940e0297395eb758b6dc63"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#afe0b826f07940e0297395eb758b6dc63">PHP_MINFO_FUNCTION</a> (raphf)</td></tr>
204 <tr class="separator:afe0b826f07940e0297395eb758b6dc63"><td class="memSeparator" colspan="2">&#160;</td></tr>
205 </table><table class="memberdecls">
206 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
207 Variables</h2></td></tr>
208 <tr class="memitem:a385b722141c96392a35d8b6dfc29b0d3"><td class="memItemLeft" align="right" valign="top">struct php_persistent_handle_globals&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a385b722141c96392a35d8b6dfc29b0d3">persistent_handle</a></td></tr>
209 <tr class="separator:a385b722141c96392a35d8b6dfc29b0d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
210 <tr class="memitem:a42f904573a2c5b1eba6ccd6604269f99"><td class="memItemLeft" align="right" valign="top">zend_module_entry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="php__raphf__api_8c.html#a42f904573a2c5b1eba6ccd6604269f99">raphf_module_entry</a></td></tr>
211 <tr class="separator:a42f904573a2c5b1eba6ccd6604269f99"><td class="memSeparator" colspan="2">&#160;</td></tr>
212 </table>
213 <h2 class="groupheader">Macro Definition Documentation</h2>
214 <a class="anchor" id="a4ac4e8587a25a7617a3bb1b2b246fe7f"></a>
215 <div class="memitem">
216 <div class="memproto">
217 <table class="memname">
218 <tr>
219 <td class="memname">#define PHP_RAPHF_DEBUG_PHANDLES&#160;&#160;&#160;0</td>
220 </tr>
221 </table>
222 </div><div class="memdoc">
223
224 </div>
225 </div>
226 <a class="anchor" id="a5a6099bca8801bd4a502806ab49c1d1c"></a>
227 <div class="memitem">
228 <div class="memproto">
229 <table class="memname">
230 <tr>
231 <td class="memname">#define PHP_RAPHF_G&#160;&#160;&#160;(&amp;raphf_globals)</td>
232 </tr>
233 </table>
234 </div><div class="memdoc">
235
236 <p>Referenced by <a class="el" href="php__raphf__api_8c.html#afe0b826f07940e0297395eb758b6dc63">PHP_MINFO_FUNCTION()</a>, <a class="el" href="php__raphf__api_8c.html#a98ef98eb514bf71723b22e93ef4fb099">PHP_MINIT_FUNCTION()</a>, <a class="el" href="php__raphf__api_8h.html#a8368c07c20ecf1d4f06aa6a4e5849df8">php_persistent_handle_cleanup()</a>, <a class="el" href="php__raphf__api_8h.html#ab7cc28d4d1dcf715dc05069a0dcac11f">php_persistent_handle_concede()</a>, <a class="el" href="php__raphf__api_8h.html#ab7bc43582b0307526d80e83dba88c571">php_persistent_handle_provide()</a>, <a class="el" href="php__raphf__api_8h.html#af08ee05c51d52200755d24f6f52df144">php_persistent_handle_release()</a>, and <a class="el" href="php__raphf__api_8h.html#ae174fbe124d4cb6010e218a68379bd18">php_persistent_handle_statall()</a>.</p>
237
238 </div>
239 </div>
240 <a class="anchor" id="a1a89ef4d87548194ddf4eba935ca72ea"></a>
241 <div class="memitem">
242 <div class="memproto">
243 <table class="memname">
244 <tr>
245 <td class="memname">#define PHP_RAPHF_TEST&#160;&#160;&#160;0</td>
246 </tr>
247 </table>
248 </div><div class="memdoc">
249
250 </div>
251 </div>
252 <h2 class="groupheader">Function Documentation</h2>
253 <a class="anchor" id="afe0b826f07940e0297395eb758b6dc63"></a>
254 <div class="memitem">
255 <div class="memproto">
256 <table class="memname">
257 <tr>
258 <td class="memname">PHP_MINFO_FUNCTION </td>
259 <td>(</td>
260 <td class="paramtype">raphf&#160;</td>
261 <td class="paramname"></td><td>)</td>
262 <td></td>
263 </tr>
264 </table>
265 </div><div class="memdoc">
266
267 </div>
268 </div>
269 <a class="anchor" id="a98ef98eb514bf71723b22e93ef4fb099"></a>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="memname">
273 <tr>
274 <td class="memname">PHP_MINIT_FUNCTION </td>
275 <td>(</td>
276 <td class="paramtype">raphf&#160;</td>
277 <td class="paramname"></td><td>)</td>
278 <td></td>
279 </tr>
280 </table>
281 </div><div class="memdoc">
282
283 </div>
284 </div>
285 <a class="anchor" id="a9bdad7e7a27b1cce6be5ec842da0c921"></a>
286 <div class="memitem">
287 <div class="memproto">
288 <table class="memname">
289 <tr>
290 <td class="memname">PHP_MSHUTDOWN_FUNCTION </td>
291 <td>(</td>
292 <td class="paramtype">raphf&#160;</td>
293 <td class="paramname"></td><td>)</td>
294 <td></td>
295 </tr>
296 </table>
297 </div><div class="memdoc">
298
299 </div>
300 </div>
301 <a class="anchor" id="ab12ec2da7189e16fbed40a3b73bc9ee2"></a>
302 <div class="memitem">
303 <div class="memproto">
304 <table class="memname">
305 <tr>
306 <td class="memname">void php_persistent_handle_abandon </td>
307 <td>(</td>
308 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *&#160;</td>
309 <td class="paramname"><em>a</em></td><td>)</td>
310 <td></td>
311 </tr>
312 </table>
313 </div><div class="memdoc">
314
315 <p>Abandon the persistent handle factory. </p>
316 <p>Destroy a <a class="el" href="php__raphf__api_8h.html#structphp__persistent__handle__factory" title="Definition of a persistent handle factory. ">php_persistent_handle_factory</a> created by <a class="el" href="php__raphf__api_8h.html#ab7cc28d4d1dcf715dc05069a0dcac11f" title="Retrieve a persistent handle factory at runtime. ">php_persistent_handle_concede()</a>. If the memory for the factory was allocated, it will automatically be free'd.</p>
317 <dl class="params"><dt>Parameters</dt><dd>
318 <table class="params">
319 <tr><td class="paramname">a</td><td>the persistent handle factory to destroy </td></tr>
320 </table>
321 </dd>
322 </dl>
323
324 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#ab754f4d59dab5de0edf702a9ab2f4e03">php_persistent_handle_resource_factory_init()</a>, and <a class="el" href="php__raphf__api_8h.html#a617d2cc656ab6427388b938597194ebb">php_resource_factory_is_persistent()</a>.</p>
325
326 <p><div class="dynheader">
327 Here is the caller graph for this function:</div>
328 <div class="dyncontent">
329 <div class="center"><img src="php__raphf__api_8c_ab12ec2da7189e16fbed40a3b73bc9ee2_icgraph.png" border="0" usemap="#php__raphf__api_8c_ab12ec2da7189e16fbed40a3b73bc9ee2_icgraph" alt=""/></div>
330 <map name="php__raphf__api_8c_ab12ec2da7189e16fbed40a3b73bc9ee2_icgraph" id="php__raphf__api_8c_ab12ec2da7189e16fbed40a3b73bc9ee2_icgraph">
331 <area shape="rect" id="node2" href="php__raphf__api_8h.html#ab754f4d59dab5de0edf702a9ab2f4e03" title="Create a resource factory for persistent handles. " alt="" coords="205,5,357,47"/>
332 <area shape="rect" id="node3" href="php__raphf__api_8h.html#a617d2cc656ab6427388b938597194ebb" title="Check whether a resource factory is a persistent handle resource factory. " alt="" coords="208,71,355,112"/>
333 </map>
334 </div>
335 </p>
336
337 </div>
338 </div>
339 <a class="anchor" id="ae8124f3f73e96e2193ae03c5519d2763"></a>
340 <div class="memitem">
341 <div class="memproto">
342 <table class="memname">
343 <tr>
344 <td class="memname">void* php_persistent_handle_accrete </td>
345 <td>(</td>
346 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *&#160;</td>
347 <td class="paramname"><em>a</em>, </td>
348 </tr>
349 <tr>
350 <td class="paramkey"></td>
351 <td></td>
352 <td class="paramtype">void *&#160;</td>
353 <td class="paramname"><em>handle</em>&#160;</td>
354 </tr>
355 <tr>
356 <td></td>
357 <td>)</td>
358 <td></td><td></td>
359 </tr>
360 </table>
361 </div><div class="memdoc">
362
363 <p>Copy a persistent handle. </p>
364 <p>Let the underlying resource factory copy the <em>handle</em>.</p>
365 <dl class="params"><dt>Parameters</dt><dd>
366 <table class="params">
367 <tr><td class="paramname">a</td><td>the persistent handle factory </td></tr>
368 <tr><td class="paramname">handle</td><td>the resource to accrete </td></tr>
369 </table>
370 </dd>
371 </dl>
372
373 <p><div class="dynheader">
374 Here is the call graph for this function:</div>
375 <div class="dyncontent">
376 <div class="center"><img src="php__raphf__api_8c_ae8124f3f73e96e2193ae03c5519d2763_cgraph.png" border="0" usemap="#php__raphf__api_8c_ae8124f3f73e96e2193ae03c5519d2763_cgraph" alt=""/></div>
377 <map name="php__raphf__api_8c_ae8124f3f73e96e2193ae03c5519d2763_cgraph" id="php__raphf__api_8c_ae8124f3f73e96e2193ae03c5519d2763_cgraph">
378 <area shape="rect" id="node2" href="php__raphf__api_8c.html#a08db5f3698f2d0bf3d2f20dcf4e7b2b4" title="Create a copy of the resource handle. " alt="" coords="205,5,352,47"/>
379 </map>
380 </div>
381 </p>
382
383 </div>
384 </div>
385 <a class="anchor" id="af6636e870497be0699d2781e5fc8a2a9"></a>
386 <div class="memitem">
387 <div class="memproto">
388 <table class="memname">
389 <tr>
390 <td class="memname">void* php_persistent_handle_acquire </td>
391 <td>(</td>
392 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *&#160;</td>
393 <td class="paramname"><em>a</em>, </td>
394 </tr>
395 <tr>
396 <td class="paramkey"></td>
397 <td></td>
398 <td class="paramtype">void *&#160;</td>
399 <td class="paramname"><em>init_arg</em>&#160;</td>
400 </tr>
401 <tr>
402 <td></td>
403 <td>)</td>
404 <td></td><td></td>
405 </tr>
406 </table>
407 </div><div class="memdoc">
408
409 <p>Acquire a persistent handle. </p>
410 <p>That is, either re-use a resource from the free list or create a new handle.</p>
411 <p>If a handle is acquired from the free list, the <a class="el" href="php__raphf__api_8h.html#a6633b7c860e4538942e0367d64ed5af7" title="The persistent handle wakeup routine; may be NULL. ">php_persistent_handle_factory::wakeup</a> callback will be executed for that handle.</p>
412 <dl class="params"><dt>Parameters</dt><dd>
413 <table class="params">
414 <tr><td class="paramname">a</td><td>the persistent handle factory </td></tr>
415 <tr><td class="paramname">init_arg</td><td>the <em>init_arg</em> for <a class="el" href="php__raphf__api_8h.html#a98d02dc80dd83095b8f901954350840c" title="Construct a resource by the resource factory f. ">php_resource_factory_handle_ctor()</a> </td></tr>
416 </table>
417 </dd>
418 </dl>
419 <dl class="section return"><dt>Returns</dt><dd>the acquired resource </dd></dl>
420
421 <p><div class="dynheader">
422 Here is the call graph for this function:</div>
423 <div class="dyncontent">
424 <div class="center"><img src="php__raphf__api_8c_af6636e870497be0699d2781e5fc8a2a9_cgraph.png" border="0" usemap="#php__raphf__api_8c_af6636e870497be0699d2781e5fc8a2a9_cgraph" alt=""/></div>
425 <map name="php__raphf__api_8c_af6636e870497be0699d2781e5fc8a2a9_cgraph" id="php__raphf__api_8c_af6636e870497be0699d2781e5fc8a2a9_cgraph">
426 <area shape="rect" id="node2" href="php__raphf__api_8c.html#a98d02dc80dd83095b8f901954350840c" title="Construct a resource by the resource factory f. " alt="" coords="205,5,352,47"/>
427 </map>
428 </div>
429 </p>
430
431 </div>
432 </div>
433 <a class="anchor" id="a8368c07c20ecf1d4f06aa6a4e5849df8"></a>
434 <div class="memitem">
435 <div class="memproto">
436 <table class="memname">
437 <tr>
438 <td class="memname">void php_persistent_handle_cleanup </td>
439 <td>(</td>
440 <td class="paramtype">zend_string *&#160;</td>
441 <td class="paramname"><em>name</em>, </td>
442 </tr>
443 <tr>
444 <td class="paramkey"></td>
445 <td></td>
446 <td class="paramtype">zend_string *&#160;</td>
447 <td class="paramname"><em>ident</em>&#160;</td>
448 </tr>
449 <tr>
450 <td></td>
451 <td>)</td>
452 <td></td><td></td>
453 </tr>
454 </table>
455 </div><div class="memdoc">
456
457 <p>Clean persistent handles up. </p>
458 <p>Destroy persistent handles of provider <em>name</em> and in subsidiary namespace <em>ident</em>.</p>
459 <p>If <em>name</em> is NULL, all persistent handles of all providers with a matching <em>ident</em> will be cleaned up.</p>
460 <p>If <em>identr</em> is NULL all persistent handles of the provider will be cleaned up.</p>
461 <p>Ergo, if both, <em>name</em> and <em>ident</em> are NULL, then all persistent handles will be cleaned up.</p>
462 <p>You must call this in MSHUTDOWN, if your resource factory ops hold a registered <a class="el" href="structphp__resource__factory.html#a7d6c89f9c6035be8a5e166a6a86cd1c7" title="User data destructor. ">php_resource_factory::dtor</a>, else the dtor will point to memory not any more available if the extension has already been unloaded.</p>
463 <dl class="params"><dt>Parameters</dt><dd>
464 <table class="params">
465 <tr><td class="paramname">name</td><td>the provider name; may be NULL </td></tr>
466 <tr><td class="paramname">ident</td><td>the subsidiary namespace name; may be NULL </td></tr>
467 </table>
468 </dd>
469 </dl>
470
471 </div>
472 </div>
473 <a class="anchor" id="ab7cc28d4d1dcf715dc05069a0dcac11f"></a>
474 <div class="memitem">
475 <div class="memproto">
476 <table class="memname">
477 <tr>
478 <td class="memname"><a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a>* php_persistent_handle_concede </td>
479 <td>(</td>
480 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *&#160;</td>
481 <td class="paramname"><em>a</em>, </td>
482 </tr>
483 <tr>
484 <td class="paramkey"></td>
485 <td></td>
486 <td class="paramtype">zend_string *&#160;</td>
487 <td class="paramname"><em>name</em>, </td>
488 </tr>
489 <tr>
490 <td class="paramkey"></td>
491 <td></td>
492 <td class="paramtype">zend_string *&#160;</td>
493 <td class="paramname"><em>ident</em>, </td>
494 </tr>
495 <tr>
496 <td class="paramkey"></td>
497 <td></td>
498 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a59f5566ecc4c76e048ad53469eb20142">php_persistent_handle_wakeup_t</a>&#160;</td>
499 <td class="paramname"><em>wakeup</em>, </td>
500 </tr>
501 <tr>
502 <td class="paramkey"></td>
503 <td></td>
504 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a85e9e715d308dc5d98b980c9c57d02bf">php_persistent_handle_retire_t</a>&#160;</td>
505 <td class="paramname"><em>retire</em>&#160;</td>
506 </tr>
507 <tr>
508 <td></td>
509 <td>)</td>
510 <td></td><td></td>
511 </tr>
512 </table>
513 </div><div class="memdoc">
514
515 <p>Retrieve a persistent handle factory at runtime. </p>
516 <p>If a persistent handle provider has been registered for <em>name</em>, a new <a class="el" href="php__raphf__api_8h.html#structphp__persistent__handle__factory" title="Definition of a persistent handle factory. ">php_persistent_handle_factory</a> creating resources in the <em>ident</em> namespace will be constructed.</p>
517 <p>The wakeup routine <em>wakeup</em> and the retire routine <em>retire</em> will be assigned to the new <a class="el" href="php__raphf__api_8h.html#structphp__persistent__handle__factory" title="Definition of a persistent handle factory. ">php_persistent_handle_factory</a>.</p>
518 <dl class="params"><dt>Parameters</dt><dd>
519 <table class="params">
520 <tr><td class="paramname">a</td><td>pointer to a factory; allocated on the heap if NULL </td></tr>
521 <tr><td class="paramname">name</td><td>the provider name, e.g. "http\Client\Curl" </td></tr>
522 <tr><td class="paramname">ident</td><td>the subsidiary namespace, e.g. "php.net:80" </td></tr>
523 <tr><td class="paramname">wakeup</td><td>any persistent handle wakeup routine </td></tr>
524 <tr><td class="paramname">retire</td><td>any persistent handle retire routine </td></tr>
525 </table>
526 </dd>
527 </dl>
528 <dl class="section return"><dt>Returns</dt><dd><em>a</em> or an allocated persistent handle factory </dd></dl>
529
530 </div>
531 </div>
532 <a class="anchor" id="a93458ab12d810f0fd545fb1464ba9eca"></a>
533 <div class="memitem">
534 <div class="memproto">
535 <table class="memname">
536 <tr>
537 <td class="memname"><a class="el" href="php__raphf__api_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a>* php_persistent_handle_get_resource_factory_ops </td>
538 <td>(</td>
539 <td class="paramtype">void&#160;</td>
540 <td class="paramname"></td><td>)</td>
541 <td></td>
542 </tr>
543 </table>
544 </div><div class="memdoc">
545
546 <p>Retrieve persistent handle resource factory ops. </p>
547 <p>These ops can be used to mask a persistent handle factory as resource factory itself, so you can transparently use the resource factory API, both for persistent and non-persistent ressources.</p>
548 <p>Example: </p><div class="fragment"><div class="line"><a class="code" href="structphp__resource__factory.html">php_resource_factory_t</a> *create_my_rf(zend_string *persistent_id)</div>
549 <div class="line">{</div>
550 <div class="line"> <a class="code" href="structphp__resource__factory.html">php_resource_factory_t</a> *rf;</div>
551 <div class="line"></div>
552 <div class="line"> <span class="keywordflow">if</span> (persistent_id) {</div>
553 <div class="line"> <a class="code" href="php__raphf__api_8h.html#structphp__persistent__handle__factory">php_persistent_handle_factory_t</a> *pf;</div>
554 <div class="line"> <a class="code" href="php__raphf__api_8h.html#structphp__resource__factory__ops">php_resource_factory_ops_t</a> *ops;</div>
555 <div class="line"> zend_string *ns = zend_string_init(<span class="stringliteral">&quot;my&quot;</span>, 2, 1);</div>
556 <div class="line"></div>
557 <div class="line"> ops = <a class="code" href="php__raphf__api_8c.html#a93458ab12d810f0fd545fb1464ba9eca">php_persistent_handle_get_resource_factory_ops</a>();</div>
558 <div class="line"> pf = <a class="code" href="php__raphf__api_8c.html#ab7cc28d4d1dcf715dc05069a0dcac11f">php_persistent_handle_concede</a>(NULL, ns, persistent_id, NULL, NULL);</div>
559 <div class="line"> rf = <a class="code" href="php__raphf__api_8c.html#ab754f4d59dab5de0edf702a9ab2f4e03">php_persistent_handle_resource_factory_init</a>(NULL, pf);</div>
560 <div class="line"> zend_string_release(ns);</div>
561 <div class="line"> } <span class="keywordflow">else</span> {</div>
562 <div class="line"> rf = <a class="code" href="php__raphf__api_8c.html#ad20f10c53e3f33756638da98819367f0">php_resource_factory_init</a>(NULL, &amp;myops, NULL, NULL);</div>
563 <div class="line"> }</div>
564 <div class="line"> <span class="keywordflow">return</span> rf;</div>
565 <div class="line">}</div>
566 </div><!-- fragment -->
567 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#ab754f4d59dab5de0edf702a9ab2f4e03">php_persistent_handle_resource_factory_init()</a>.</p>
568
569 <p><div class="dynheader">
570 Here is the caller graph for this function:</div>
571 <div class="dyncontent">
572 <div class="center"><img src="php__raphf__api_8c_a93458ab12d810f0fd545fb1464ba9eca_icgraph.png" border="0" usemap="#php__raphf__api_8c_a93458ab12d810f0fd545fb1464ba9eca_icgraph" alt=""/></div>
573 <map name="php__raphf__api_8c_a93458ab12d810f0fd545fb1464ba9eca_icgraph" id="php__raphf__api_8c_a93458ab12d810f0fd545fb1464ba9eca_icgraph">
574 <area shape="rect" id="node2" href="php__raphf__api_8h.html#ab754f4d59dab5de0edf702a9ab2f4e03" title="Create a resource factory for persistent handles. " alt="" coords="232,5,384,47"/>
575 </map>
576 </div>
577 </p>
578
579 </div>
580 </div>
581 <a class="anchor" id="ab7bc43582b0307526d80e83dba88c571"></a>
582 <div class="memitem">
583 <div class="memproto">
584 <table class="memname">
585 <tr>
586 <td class="memname">ZEND_RESULT_CODE php_persistent_handle_provide </td>
587 <td>(</td>
588 <td class="paramtype">zend_string *&#160;</td>
589 <td class="paramname"><em>name</em>, </td>
590 </tr>
591 <tr>
592 <td class="paramkey"></td>
593 <td></td>
594 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a> *&#160;</td>
595 <td class="paramname"><em>fops</em>, </td>
596 </tr>
597 <tr>
598 <td class="paramkey"></td>
599 <td></td>
600 <td class="paramtype">void *&#160;</td>
601 <td class="paramname"><em>data</em>, </td>
602 </tr>
603 <tr>
604 <td class="paramkey"></td>
605 <td></td>
606 <td class="paramtype">void(*)(void *)&#160;</td>
607 <td class="paramname"><em>dtor</em>&#160;</td>
608 </tr>
609 <tr>
610 <td></td>
611 <td>)</td>
612 <td></td><td></td>
613 </tr>
614 </table>
615 </div><div class="memdoc">
616
617 <p>Register a persistent handle provider in MINIT. </p>
618 <p>Registers a factory provider for <em>name_str</em> with <em>fops</em> resource factory ops. Call this in your MINIT.</p>
619 <p>A <a class="el" href="structphp__resource__factory.html" title="The resource factory. ">php_resource_factory</a> will be created with <em>fops</em>, <em>data</em> and <em>dtor</em> and will be stored together with a <a class="el" href="php__raphf__api_8h.html#structphp__persistent__handle__list" title="Persistent handles storage. ">php_persistent_handle_list</a> in the global raphf hash.</p>
620 <p>A <a class="el" href="php__raphf__api_8h.html#structphp__persistent__handle__factory" title="Definition of a persistent handle factory. ">php_persistent_handle_factory</a> can then be retrieved by <a class="el" href="php__raphf__api_8h.html#ab7cc28d4d1dcf715dc05069a0dcac11f" title="Retrieve a persistent handle factory at runtime. ">php_persistent_handle_concede()</a> at runtime.</p>
621 <dl class="params"><dt>Parameters</dt><dd>
622 <table class="params">
623 <tr><td class="paramname">name</td><td>the provider name, e.g. "http\Client\Curl" </td></tr>
624 <tr><td class="paramname">fops</td><td>the resource factory ops </td></tr>
625 <tr><td class="paramname">data</td><td>opaque user data </td></tr>
626 <tr><td class="paramname">dtor</td><td><em>data</em> destructor </td></tr>
627 </table>
628 </dd>
629 </dl>
630 <dl class="section return"><dt>Returns</dt><dd>SUCCESS/FAILURE </dd></dl>
631
632 <p><div class="dynheader">
633 Here is the call graph for this function:</div>
634 <div class="dyncontent">
635 <div class="center"><img src="php__raphf__api_8c_ab7bc43582b0307526d80e83dba88c571_cgraph.png" border="0" usemap="#php__raphf__api_8c_ab7bc43582b0307526d80e83dba88c571_cgraph" alt=""/></div>
636 <map name="php__raphf__api_8c_ab7bc43582b0307526d80e83dba88c571_cgraph" id="php__raphf__api_8c_ab7bc43582b0307526d80e83dba88c571_cgraph">
637 <area shape="rect" id="node2" href="php__raphf__api_8c.html#ad20f10c53e3f33756638da98819367f0" title="Initialize a resource factory. " alt="" coords="208,5,379,32"/>
638 <area shape="rect" id="node3" href="php__raphf__api_8c.html#a016b8a4159e698f915ab967711696847" title="Destroy the resource factory. " alt="" coords="205,56,381,83"/>
639 </map>
640 </div>
641 </p>
642
643 </div>
644 </div>
645 <a class="anchor" id="af08ee05c51d52200755d24f6f52df144"></a>
646 <div class="memitem">
647 <div class="memproto">
648 <table class="memname">
649 <tr>
650 <td class="memname">void php_persistent_handle_release </td>
651 <td>(</td>
652 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *&#160;</td>
653 <td class="paramname"><em>a</em>, </td>
654 </tr>
655 <tr>
656 <td class="paramkey"></td>
657 <td></td>
658 <td class="paramtype">void *&#160;</td>
659 <td class="paramname"><em>handle</em>&#160;</td>
660 </tr>
661 <tr>
662 <td></td>
663 <td>)</td>
664 <td></td><td></td>
665 </tr>
666 </table>
667 </div><div class="memdoc">
668
669 <p>Release a persistent handle. </p>
670 <p>That is, either put it back into the free list for later re-use or clean it up with <a class="el" href="php__raphf__api_8h.html#a97dbb9d342f33205b92374c586676bc6" title="Destroy (and free) the resource. ">php_resource_factory_handle_dtor()</a>.</p>
671 <p>If a handle is put back into the free list, the <a class="el" href="php__raphf__api_8h.html#a9299f3f0821061ad93d15c10cf735b6b" title="The persistent handle retire routine; may be NULL. ">php_persistent_handle_factory::retire</a> callback will be executed for that handle.</p>
672 <dl class="params"><dt>Parameters</dt><dd>
673 <table class="params">
674 <tr><td class="paramname">a</td><td>the persistent handle factory </td></tr>
675 <tr><td class="paramname">handle</td><td>the handle to release </td></tr>
676 </table>
677 </dd>
678 </dl>
679
680 <p><div class="dynheader">
681 Here is the call graph for this function:</div>
682 <div class="dyncontent">
683 <div class="center"><img src="php__raphf__api_8c_af08ee05c51d52200755d24f6f52df144_cgraph.png" border="0" usemap="#php__raphf__api_8c_af08ee05c51d52200755d24f6f52df144_cgraph" alt=""/></div>
684 <map name="php__raphf__api_8c_af08ee05c51d52200755d24f6f52df144_cgraph" id="php__raphf__api_8c_af08ee05c51d52200755d24f6f52df144_cgraph">
685 <area shape="rect" id="node2" href="php__raphf__api_8c.html#a97dbb9d342f33205b92374c586676bc6" title="Destroy (and free) the resource. " alt="" coords="205,5,352,47"/>
686 </map>
687 </div>
688 </p>
689
690 </div>
691 </div>
692 <a class="anchor" id="ab754f4d59dab5de0edf702a9ab2f4e03"></a>
693 <div class="memitem">
694 <div class="memproto">
695 <table class="memname">
696 <tr>
697 <td class="memname"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a>* php_persistent_handle_resource_factory_init </td>
698 <td>(</td>
699 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td>
700 <td class="paramname"><em>a</em>, </td>
701 </tr>
702 <tr>
703 <td class="paramkey"></td>
704 <td></td>
705 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a833eaa62ffcc217e5749c26c18885b17">php_persistent_handle_factory_t</a> *&#160;</td>
706 <td class="paramname"><em>pf</em>&#160;</td>
707 </tr>
708 <tr>
709 <td></td>
710 <td>)</td>
711 <td></td><td></td>
712 </tr>
713 </table>
714 </div><div class="memdoc">
715
716 <p>Create a resource factory for persistent handles. </p>
717 <p>This will create a resource factory with persistent handle ops, which wraps the provided reource factory <em>pf</em>.</p>
718 <dl class="params"><dt>Parameters</dt><dd>
719 <table class="params">
720 <tr><td class="paramname">a</td><td>the persistent handle resource factory to initialize </td></tr>
721 <tr><td class="paramname">pf</td><td>the resource factory to wrap </td></tr>
722 </table>
723 </dd>
724 </dl>
725
726 <p><div class="dynheader">
727 Here is the call graph for this function:</div>
728 <div class="dyncontent">
729 <div class="center"><img src="php__raphf__api_8c_ab754f4d59dab5de0edf702a9ab2f4e03_cgraph.png" border="0" usemap="#php__raphf__api_8c_ab754f4d59dab5de0edf702a9ab2f4e03_cgraph" alt=""/></div>
730 <map name="php__raphf__api_8c_ab754f4d59dab5de0edf702a9ab2f4e03_cgraph" id="php__raphf__api_8c_ab754f4d59dab5de0edf702a9ab2f4e03_cgraph">
731 <area shape="rect" id="node2" href="php__raphf__api_8c.html#ad20f10c53e3f33756638da98819367f0" title="Initialize a resource factory. " alt="" coords="209,5,380,32"/>
732 <area shape="rect" id="node3" href="php__raphf__api_8c.html#a93458ab12d810f0fd545fb1464ba9eca" title="Retrieve persistent handle resource factory ops. " alt="" coords="205,57,384,98"/>
733 <area shape="rect" id="node4" href="php__raphf__api_8c.html#ab12ec2da7189e16fbed40a3b73bc9ee2" title="Abandon the persistent handle factory. " alt="" coords="219,122,371,163"/>
734 </map>
735 </div>
736 </p>
737
738 </div>
739 </div>
740 <a class="anchor" id="ae174fbe124d4cb6010e218a68379bd18"></a>
741 <div class="memitem">
742 <div class="memproto">
743 <table class="memname">
744 <tr>
745 <td class="memname">HashTable* php_persistent_handle_statall </td>
746 <td>(</td>
747 <td class="paramtype">HashTable *&#160;</td>
748 <td class="paramname"><em>ht</em></td><td>)</td>
749 <td></td>
750 </tr>
751 </table>
752 </div><div class="memdoc">
753
754 <p>Retrieve statistics about the current process/thread's persistent handles. </p>
755 <dl class="section return"><dt>Returns</dt><dd>a HashTable like: <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;[</div>
756 <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; &quot;name&quot; =&gt; [</div>
757 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; &quot;ident&quot; =&gt; [</div>
758 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; &quot;used&quot; =&gt; 1,</div>
759 <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; &quot;free&quot; =&gt; 0,</div>
760 <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; ]</div>
761 <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; ]</div>
762 <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;]</div>
763 </div><!-- fragment --> </dd></dl>
764
765 </div>
766 </div>
767 <a class="anchor" id="ae8be369197905047ffbd05c0ca80f245"></a>
768 <div class="memitem">
769 <div class="memproto">
770 <table class="memname">
771 <tr>
772 <td class="memname">unsigned php_resource_factory_addref </td>
773 <td>(</td>
774 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td>
775 <td class="paramname"><em>rf</em></td><td>)</td>
776 <td></td>
777 </tr>
778 </table>
779 </div><div class="memdoc">
780
781 <p>Increase the refcount of the resource factory. </p>
782 <dl class="params"><dt>Parameters</dt><dd>
783 <table class="params">
784 <tr><td class="paramname">rf</td><td>the resource factory </td></tr>
785 </table>
786 </dd>
787 </dl>
788 <dl class="section return"><dt>Returns</dt><dd>the new refcount </dd></dl>
789
790 </div>
791 </div>
792 <a class="anchor" id="a016b8a4159e698f915ab967711696847"></a>
793 <div class="memitem">
794 <div class="memproto">
795 <table class="memname">
796 <tr>
797 <td class="memname">void php_resource_factory_dtor </td>
798 <td>(</td>
799 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td>
800 <td class="paramname"><em>f</em></td><td>)</td>
801 <td></td>
802 </tr>
803 </table>
804 </div><div class="memdoc">
805
806 <p>Destroy the resource factory. </p>
807 <p>If the factory's refcount reaches 0, the <em>dtor</em> for <em>data</em> is called.</p>
808 <dl class="params"><dt>Parameters</dt><dd>
809 <table class="params">
810 <tr><td class="paramname">f</td><td>the resource factory </td></tr>
811 </table>
812 </dd>
813 </dl>
814
815 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#ab7bc43582b0307526d80e83dba88c571">php_persistent_handle_provide()</a>, and <a class="el" href="php__raphf__api_8h.html#a7f012d685f5f7c08f50288b61232e689">php_resource_factory_free()</a>.</p>
816
817 <p><div class="dynheader">
818 Here is the caller graph for this function:</div>
819 <div class="dyncontent">
820 <div class="center"><img src="php__raphf__api_8c_a016b8a4159e698f915ab967711696847_icgraph.png" border="0" usemap="#php__raphf__api_8c_a016b8a4159e698f915ab967711696847_icgraph" alt=""/></div>
821 <map name="php__raphf__api_8c_a016b8a4159e698f915ab967711696847_icgraph" id="php__raphf__api_8c_a016b8a4159e698f915ab967711696847_icgraph">
822 <area shape="rect" id="node2" href="php__raphf__api_8h.html#ab7bc43582b0307526d80e83dba88c571" title="Register a persistent handle provider in MINIT. " alt="" coords="241,5,393,47"/>
823 <area shape="rect" id="node3" href="php__raphf__api_8h.html#a7f012d685f5f7c08f50288b61232e689" title="Destroy and free the resource factory. " alt="" coords="229,71,405,98"/>
824 </map>
825 </div>
826 </p>
827
828 </div>
829 </div>
830 <a class="anchor" id="a7f012d685f5f7c08f50288b61232e689"></a>
831 <div class="memitem">
832 <div class="memproto">
833 <table class="memname">
834 <tr>
835 <td class="memname">void php_resource_factory_free </td>
836 <td>(</td>
837 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> **&#160;</td>
838 <td class="paramname"><em>f</em></td><td>)</td>
839 <td></td>
840 </tr>
841 </table>
842 </div><div class="memdoc">
843
844 <p>Destroy and free the resource factory. </p>
845 <p>Calls <a class="el" href="php__raphf__api_8h.html#a016b8a4159e698f915ab967711696847" title="Destroy the resource factory. ">php_resource_factory_dtor()</a> and frees <em>f</em> if the factory's refcount reached 0.</p>
846 <dl class="params"><dt>Parameters</dt><dd>
847 <table class="params">
848 <tr><td class="paramname">f</td><td>the resource factory </td></tr>
849 </table>
850 </dd>
851 </dl>
852
853 <p><div class="dynheader">
854 Here is the call graph for this function:</div>
855 <div class="dyncontent">
856 <div class="center"><img src="php__raphf__api_8c_a7f012d685f5f7c08f50288b61232e689_cgraph.png" border="0" usemap="#php__raphf__api_8c_a7f012d685f5f7c08f50288b61232e689_cgraph" alt=""/></div>
857 <map name="php__raphf__api_8c_a7f012d685f5f7c08f50288b61232e689_cgraph" id="php__raphf__api_8c_a7f012d685f5f7c08f50288b61232e689_cgraph">
858 <area shape="rect" id="node2" href="php__raphf__api_8c.html#a016b8a4159e698f915ab967711696847" title="Destroy the resource factory. " alt="" coords="229,5,405,32"/>
859 </map>
860 </div>
861 </p>
862
863 </div>
864 </div>
865 <a class="anchor" id="a08db5f3698f2d0bf3d2f20dcf4e7b2b4"></a>
866 <div class="memitem">
867 <div class="memproto">
868 <table class="memname">
869 <tr>
870 <td class="memname">void* php_resource_factory_handle_copy </td>
871 <td>(</td>
872 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td>
873 <td class="paramname"><em>f</em>, </td>
874 </tr>
875 <tr>
876 <td class="paramkey"></td>
877 <td></td>
878 <td class="paramtype">void *&#160;</td>
879 <td class="paramname"><em>handle</em>&#160;</td>
880 </tr>
881 <tr>
882 <td></td>
883 <td>)</td>
884 <td></td><td></td>
885 </tr>
886 </table>
887 </div><div class="memdoc">
888
889 <p>Create a copy of the resource <em>handle</em>. </p>
890 <dl class="params"><dt>Parameters</dt><dd>
891 <table class="params">
892 <tr><td class="paramname">f</td><td>the resource factory </td></tr>
893 <tr><td class="paramname">handle</td><td>the resource to copy </td></tr>
894 </table>
895 </dd>
896 </dl>
897 <dl class="section return"><dt>Returns</dt><dd>the copy </dd></dl>
898
899 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#ae8124f3f73e96e2193ae03c5519d2763">php_persistent_handle_accrete()</a>.</p>
900
901 <p><div class="dynheader">
902 Here is the caller graph for this function:</div>
903 <div class="dyncontent">
904 <div class="center"><img src="php__raphf__api_8c_a08db5f3698f2d0bf3d2f20dcf4e7b2b4_icgraph.png" border="0" usemap="#php__raphf__api_8c_a08db5f3698f2d0bf3d2f20dcf4e7b2b4_icgraph" alt=""/></div>
905 <map name="php__raphf__api_8c_a08db5f3698f2d0bf3d2f20dcf4e7b2b4_icgraph" id="php__raphf__api_8c_a08db5f3698f2d0bf3d2f20dcf4e7b2b4_icgraph">
906 <area shape="rect" id="node2" href="php__raphf__api_8h.html#ae8124f3f73e96e2193ae03c5519d2763" title="Copy a persistent handle. " alt="" coords="200,5,352,47"/>
907 </map>
908 </div>
909 </p>
910
911 </div>
912 </div>
913 <a class="anchor" id="a98d02dc80dd83095b8f901954350840c"></a>
914 <div class="memitem">
915 <div class="memproto">
916 <table class="memname">
917 <tr>
918 <td class="memname">void* php_resource_factory_handle_ctor </td>
919 <td>(</td>
920 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td>
921 <td class="paramname"><em>f</em>, </td>
922 </tr>
923 <tr>
924 <td class="paramkey"></td>
925 <td></td>
926 <td class="paramtype">void *&#160;</td>
927 <td class="paramname"><em>init_arg</em>&#160;</td>
928 </tr>
929 <tr>
930 <td></td>
931 <td>)</td>
932 <td></td><td></td>
933 </tr>
934 </table>
935 </div><div class="memdoc">
936
937 <p>Construct a resource by the resource factory <em>f</em>. </p>
938 <dl class="params"><dt>Parameters</dt><dd>
939 <table class="params">
940 <tr><td class="paramname">f</td><td>the resource factory </td></tr>
941 <tr><td class="paramname">init_arg</td><td>for the resource constructor </td></tr>
942 </table>
943 </dd>
944 </dl>
945 <dl class="section return"><dt>Returns</dt><dd>the new resource </dd></dl>
946
947 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#af6636e870497be0699d2781e5fc8a2a9">php_persistent_handle_acquire()</a>.</p>
948
949 <p><div class="dynheader">
950 Here is the caller graph for this function:</div>
951 <div class="dyncontent">
952 <div class="center"><img src="php__raphf__api_8c_a98d02dc80dd83095b8f901954350840c_icgraph.png" border="0" usemap="#php__raphf__api_8c_a98d02dc80dd83095b8f901954350840c_icgraph" alt=""/></div>
953 <map name="php__raphf__api_8c_a98d02dc80dd83095b8f901954350840c_icgraph" id="php__raphf__api_8c_a98d02dc80dd83095b8f901954350840c_icgraph">
954 <area shape="rect" id="node2" href="php__raphf__api_8h.html#af6636e870497be0699d2781e5fc8a2a9" title="Acquire a persistent handle. " alt="" coords="200,5,352,47"/>
955 </map>
956 </div>
957 </p>
958
959 </div>
960 </div>
961 <a class="anchor" id="a97dbb9d342f33205b92374c586676bc6"></a>
962 <div class="memitem">
963 <div class="memproto">
964 <table class="memname">
965 <tr>
966 <td class="memname">void php_resource_factory_handle_dtor </td>
967 <td>(</td>
968 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td>
969 <td class="paramname"><em>f</em>, </td>
970 </tr>
971 <tr>
972 <td class="paramkey"></td>
973 <td></td>
974 <td class="paramtype">void *&#160;</td>
975 <td class="paramname"><em>handle</em>&#160;</td>
976 </tr>
977 <tr>
978 <td></td>
979 <td>)</td>
980 <td></td><td></td>
981 </tr>
982 </table>
983 </div><div class="memdoc">
984
985 <p>Destroy (and free) the resource. </p>
986 <dl class="params"><dt>Parameters</dt><dd>
987 <table class="params">
988 <tr><td class="paramname">f</td><td>the resource factory </td></tr>
989 <tr><td class="paramname">handle</td><td>the resource to destroy </td></tr>
990 </table>
991 </dd>
992 </dl>
993
994 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#af08ee05c51d52200755d24f6f52df144">php_persistent_handle_release()</a>.</p>
995
996 <p><div class="dynheader">
997 Here is the caller graph for this function:</div>
998 <div class="dyncontent">
999 <div class="center"><img src="php__raphf__api_8c_a97dbb9d342f33205b92374c586676bc6_icgraph.png" border="0" usemap="#php__raphf__api_8c_a97dbb9d342f33205b92374c586676bc6_icgraph" alt=""/></div>
1000 <map name="php__raphf__api_8c_a97dbb9d342f33205b92374c586676bc6_icgraph" id="php__raphf__api_8c_a97dbb9d342f33205b92374c586676bc6_icgraph">
1001 <area shape="rect" id="node2" href="php__raphf__api_8h.html#af08ee05c51d52200755d24f6f52df144" title="Release a persistent handle. " alt="" coords="200,5,352,47"/>
1002 </map>
1003 </div>
1004 </p>
1005
1006 </div>
1007 </div>
1008 <a class="anchor" id="ad20f10c53e3f33756638da98819367f0"></a>
1009 <div class="memitem">
1010 <div class="memproto">
1011 <table class="memname">
1012 <tr>
1013 <td class="memname"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a>* php_resource_factory_init </td>
1014 <td>(</td>
1015 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td>
1016 <td class="paramname"><em>f</em>, </td>
1017 </tr>
1018 <tr>
1019 <td class="paramkey"></td>
1020 <td></td>
1021 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a> *&#160;</td>
1022 <td class="paramname"><em>fops</em>, </td>
1023 </tr>
1024 <tr>
1025 <td class="paramkey"></td>
1026 <td></td>
1027 <td class="paramtype">void *&#160;</td>
1028 <td class="paramname"><em>data</em>, </td>
1029 </tr>
1030 <tr>
1031 <td class="paramkey"></td>
1032 <td></td>
1033 <td class="paramtype">void(*)(void *data)&#160;</td>
1034 <td class="paramname"><em>dtor</em>&#160;</td>
1035 </tr>
1036 <tr>
1037 <td></td>
1038 <td>)</td>
1039 <td></td><td></td>
1040 </tr>
1041 </table>
1042 </div><div class="memdoc">
1043
1044 <p>Initialize a resource factory. </p>
1045 <p>If you register a <em>dtor</em> for a resource factory used with a persistent handle provider, be sure to call <a class="el" href="php__raphf__api_8h.html#a8368c07c20ecf1d4f06aa6a4e5849df8" title="Clean persistent handles up. ">php_persistent_handle_cleanup()</a> for your registered provider in MSHUTDOWN, else the dtor will point to no longer available memory if the extension has already been unloaded.</p>
1046 <dl class="params"><dt>Parameters</dt><dd>
1047 <table class="params">
1048 <tr><td class="paramname">f</td><td>the factory to initialize; if NULL allocated on the heap </td></tr>
1049 <tr><td class="paramname">fops</td><td>the resource ops to assign to the factory </td></tr>
1050 <tr><td class="paramname">data</td><td>opaque user data; may be NULL </td></tr>
1051 <tr><td class="paramname">dtor</td><td>a destructor for the data; may be NULL </td></tr>
1052 </table>
1053 </dd>
1054 </dl>
1055 <dl class="section return"><dt>Returns</dt><dd><em>f</em> or an allocated resource factory </dd></dl>
1056
1057 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#ab7bc43582b0307526d80e83dba88c571">php_persistent_handle_provide()</a>, and <a class="el" href="php__raphf__api_8h.html#ab754f4d59dab5de0edf702a9ab2f4e03">php_persistent_handle_resource_factory_init()</a>.</p>
1058
1059 <p><div class="dynheader">
1060 Here is the caller graph for this function:</div>
1061 <div class="dyncontent">
1062 <div class="center"><img src="php__raphf__api_8c_ad20f10c53e3f33756638da98819367f0_icgraph.png" border="0" usemap="#php__raphf__api_8c_ad20f10c53e3f33756638da98819367f0_icgraph" alt=""/></div>
1063 <map name="php__raphf__api_8c_ad20f10c53e3f33756638da98819367f0_icgraph" id="php__raphf__api_8c_ad20f10c53e3f33756638da98819367f0_icgraph">
1064 <area shape="rect" id="node2" href="php__raphf__api_8h.html#ab7bc43582b0307526d80e83dba88c571" title="Register a persistent handle provider in MINIT. " alt="" coords="224,5,376,47"/>
1065 <area shape="rect" id="node3" href="php__raphf__api_8h.html#ab754f4d59dab5de0edf702a9ab2f4e03" title="Create a resource factory for persistent handles. " alt="" coords="224,71,376,112"/>
1066 </map>
1067 </div>
1068 </p>
1069
1070 </div>
1071 </div>
1072 <a class="anchor" id="a617d2cc656ab6427388b938597194ebb"></a>
1073 <div class="memitem">
1074 <div class="memproto">
1075 <table class="memname">
1076 <tr>
1077 <td class="memname">zend_bool php_resource_factory_is_persistent </td>
1078 <td>(</td>
1079 <td class="paramtype"><a class="el" href="php__raphf__api_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> *&#160;</td>
1080 <td class="paramname"><em>a</em></td><td>)</td>
1081 <td></td>
1082 </tr>
1083 </table>
1084 </div><div class="memdoc">
1085
1086 <p>Check whether a resource factory is a persistent handle resource factory. </p>
1087 <dl class="params"><dt>Parameters</dt><dd>
1088 <table class="params">
1089 <tr><td class="paramname">a</td><td>the resource factory to check </td></tr>
1090 </table>
1091 </dd>
1092 </dl>
1093
1094 <p><div class="dynheader">
1095 Here is the call graph for this function:</div>
1096 <div class="dyncontent">
1097 <div class="center"><img src="php__raphf__api_8c_a617d2cc656ab6427388b938597194ebb_cgraph.png" border="0" usemap="#php__raphf__api_8c_a617d2cc656ab6427388b938597194ebb_cgraph" alt=""/></div>
1098 <map name="php__raphf__api_8c_a617d2cc656ab6427388b938597194ebb_cgraph" id="php__raphf__api_8c_a617d2cc656ab6427388b938597194ebb_cgraph">
1099 <area shape="rect" id="node2" href="php__raphf__api_8c.html#ab12ec2da7189e16fbed40a3b73bc9ee2" title="Abandon the persistent handle factory. " alt="" coords="200,5,352,47"/>
1100 </map>
1101 </div>
1102 </p>
1103
1104 </div>
1105 </div>
1106 <a class="anchor" id="ad2aba389e88a1e9e11b7dae021bfddfc"></a>
1107 <div class="memitem">
1108 <div class="memproto">
1109 <table class="memname">
1110 <tr>
1111 <td class="memname">STD_PHP_INI_ENTRY </td>
1112 <td>(</td>
1113 <td class="paramtype">&quot;raphf.persistent_handle.limit&quot;&#160;</td>
1114 <td class="paramname">, </td>
1115 </tr>
1116 <tr>
1117 <td class="paramkey"></td>
1118 <td></td>
1119 <td class="paramtype">&quot;-1&quot;&#160;</td>
1120 <td class="paramname">, </td>
1121 </tr>
1122 <tr>
1123 <td class="paramkey"></td>
1124 <td></td>
1125 <td class="paramtype">PHP_INI_SYSTEM&#160;</td>
1126 <td class="paramname">, </td>
1127 </tr>
1128 <tr>
1129 <td class="paramkey"></td>
1130 <td></td>
1131 <td class="paramtype">OnUpdateLong&#160;</td>
1132 <td class="paramname">, </td>
1133 </tr>
1134 <tr>
1135 <td class="paramkey"></td>
1136 <td></td>
1137 <td class="paramtype">persistent_handle.&#160;</td>
1138 <td class="paramname"><em>limit</em>, </td>
1139 </tr>
1140 <tr>
1141 <td class="paramkey"></td>
1142 <td></td>
1143 <td class="paramtype">zend_raphf_globals&#160;</td>
1144 <td class="paramname">, </td>
1145 </tr>
1146 <tr>
1147 <td class="paramkey"></td>
1148 <td></td>
1149 <td class="paramtype">raphf_globals&#160;</td>
1150 <td class="paramname">&#160;</td>
1151 </tr>
1152 <tr>
1153 <td></td>
1154 <td>)</td>
1155 <td></td><td></td>
1156 </tr>
1157 </table>
1158 </div><div class="memdoc">
1159
1160 </div>
1161 </div>
1162 <a class="anchor" id="a9337bda6793399d5917999063e1aa636"></a>
1163 <div class="memitem">
1164 <div class="memproto">
1165 <table class="memname">
1166 <tr>
1167 <td class="memname">ZEND_END_ARG_INFO </td>
1168 <td>(</td>
1169 <td class="paramname"></td><td>)</td>
1170 <td></td>
1171 </tr>
1172 </table>
1173 </div><div class="memdoc">
1174
1175 </div>
1176 </div>
1177 <h2 class="groupheader">Variable Documentation</h2>
1178 <a class="anchor" id="a385b722141c96392a35d8b6dfc29b0d3"></a>
1179 <div class="memitem">
1180 <div class="memproto">
1181 <table class="memname">
1182 <tr>
1183 <td class="memname">struct php_persistent_handle_globals persistent_handle</td>
1184 </tr>
1185 </table>
1186 </div><div class="memdoc">
1187
1188 </div>
1189 </div>
1190 <a class="anchor" id="a42f904573a2c5b1eba6ccd6604269f99"></a>
1191 <div class="memitem">
1192 <div class="memproto">
1193 <table class="memname">
1194 <tr>
1195 <td class="memname">zend_module_entry raphf_module_entry</td>
1196 </tr>
1197 </table>
1198 </div><div class="memdoc">
1199 <b>Initial value:</b><div class="fragment"><div class="line">= {</div>
1200 <div class="line"> STANDARD_MODULE_HEADER,</div>
1201 <div class="line"> <span class="stringliteral">&quot;raphf&quot;</span>,</div>
1202 <div class="line"> raphf_functions,</div>
1203 <div class="line"> PHP_MINIT(raphf),</div>
1204 <div class="line"> PHP_MSHUTDOWN(raphf),</div>
1205 <div class="line"> NULL,</div>
1206 <div class="line"> NULL,</div>
1207 <div class="line"> PHP_MINFO(raphf),</div>
1208 <div class="line"> <span class="stringliteral">&quot;2.0.0dev&quot;</span> ,</div>
1209 <div class="line"> ZEND_MODULE_GLOBALS(raphf),</div>
1210 <div class="line"> PHP_GINIT(raphf),</div>
1211 <div class="line"> PHP_GSHUTDOWN(raphf),</div>
1212 <div class="line"> NULL,</div>
1213 <div class="line"> STANDARD_MODULE_PROPERTIES_EX</div>
1214 <div class="line">}</div>
1215 </div><!-- fragment -->
1216 </div>
1217 </div>
1218 </div><!-- contents -->
1219 </div><!-- doc-content -->
1220 <!-- start footer part -->
1221 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1222 <ul>
1223 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="php__raphf__api_8c.html">php_raphf_api.c</a></li>
1224 <li class="footer">Generated by
1225 <a href="http://www.doxygen.org/index.html">
1226 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
1227 </ul>
1228 </div>
1229 </body>
1230 </html>