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">
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.5"/>
7 <title>Resource and persistent handle factory API: php_persistent_handle_factory Struct 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=
"navtree.js"></script>
14 <script type=
"text/javascript">
15 $(document).ready(initResizable);
16 $(window).load(resizeHeight);
18 <link href=
"search/search.css" rel=
"stylesheet" type=
"text/css"/>
19 <script type=
"text/javascript" src=
"search/search.js"></script>
20 <script type=
"text/javascript">
21 $(document).ready(function() { searchBox.OnSelectItem(
0); });
23 <link href=
"doxygen.css" rel=
"stylesheet" type=
"text/css" />
26 <div id=
"top"><!-- do not remove this div, it is closed by doxygen! -->
28 <table cellspacing=
"0" cellpadding=
"0">
30 <tr style=
"height: 56px;">
31 <td id=
"projectlogo"><img alt=
"Logo" src=
"raphf.png"/></td>
32 <td style=
"padding-left: 0.5em;">
33 <div id=
"projectname">Resource and persistent handle factory API
35 <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>
41 <!-- end header part -->
42 <!-- Generated by Doxygen 1.8.5 -->
43 <script type=
"text/javascript">
44 var searchBox = new SearchBox(
"searchBox",
"search",false,'Search');
46 <div id=
"navrow1" class=
"tabs">
48 <li><a href=
"index.html"><span>Main
 Page
</span></a></li>
49 <li class=
"current"><a href=
"annotated.html"><span>Data
 Structures
</span></a></li>
50 <li><a href=
"files.html"><span>Files
</span></a></li>
52 <div id=
"MSearchBox" class=
"MSearchBoxInactive">
54 <img id=
"MSearchSelect" src=
"search/mag_sel.png"
55 onmouseover=
"return searchBox.OnSearchSelectShow()"
56 onmouseout=
"return searchBox.OnSearchSelectHide()"
58 <input type=
"text" id=
"MSearchField" value=
"Search" accesskey=
"S"
59 onfocus=
"searchBox.OnSearchFieldFocus(true)"
60 onblur=
"searchBox.OnSearchFieldFocus(false)"
61 onkeyup=
"searchBox.OnSearchFieldChange(event)"/>
62 </span><span class=
"right">
63 <a id=
"MSearchClose" href=
"javascript:searchBox.CloseResultsWindow()"><img id=
"MSearchCloseImg" border=
"0" src=
"search/close.png" alt=
""/></a>
69 <div id=
"navrow2" class=
"tabs2">
71 <li><a href=
"annotated.html"><span>Data
 Structures
</span></a></li>
72 <li><a href=
"classes.html"><span>Data
 Structure
 Index
</span></a></li>
73 <li><a href=
"functions.html"><span>Data
 Fields
</span></a></li>
77 <div id=
"side-nav" class=
"ui-resizable side-nav-resizable">
79 <div id=
"nav-tree-contents">
80 <div id=
"nav-sync" class=
"sync"></div>
83 <div id=
"splitbar" style=
"-moz-user-select:none;"
84 class=
"ui-resizable-handle">
87 <script type=
"text/javascript">
88 $(document).ready(function(){initNavTree('structphp__persistent__handle__factory.html','');});
90 <div id=
"doc-content">
91 <!-- window showing the filter options -->
92 <div id=
"MSearchSelectWindow"
93 onmouseover=
"return searchBox.OnSearchSelectShow()"
94 onmouseout=
"return searchBox.OnSearchSelectHide()"
95 onkeydown=
"return searchBox.OnSearchSelectKey(event)">
96 <a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(0)"><span class=
"SelectionMark"> </span>All
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(1)"><span class=
"SelectionMark"> </span>Data Structures
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(2)"><span class=
"SelectionMark"> </span>Files
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(3)"><span class=
"SelectionMark"> </span>Functions
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(4)"><span class=
"SelectionMark"> </span>Variables
</a><a class=
"SelectItem" href=
"javascript:void(0)" onclick=
"searchBox.OnSelectItem(5)"><span class=
"SelectionMark"> </span>Typedefs
</a></div>
98 <!-- iframe showing the search results (closed by default) -->
99 <div id=
"MSearchResultsWindow">
100 <iframe src=
"javascript:void(0)" frameborder=
"0"
101 name=
"MSearchResults" id=
"MSearchResults">
106 <div class=
"summary">
107 <a href=
"#pub-attribs">Data Fields
</a> </div>
108 <div class=
"headertitle">
109 <div class=
"title">php_persistent_handle_factory Struct Reference
</div> </div>
111 <div class=
"contents">
113 <p>Definition of a persistent handle factory.
114 <a href=
"structphp__persistent__handle__factory.html#details">More...
</a></p>
116 <p><code>#include
<<a class=
"el" href=
"php__raphf_8h_source.html">php_raphf.h
</a>></code></p>
117 <div class=
"dynheader">
118 Collaboration diagram for php_persistent_handle_factory:
</div>
119 <div class=
"dyncontent">
120 <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>
121 <map name=
"php__persistent__handle__factory_coll__map" id=
"php__persistent__handle__factory_coll__map">
122 <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>
123 <center><span class=
"legend">[
<a target=
"top" href=
"graph_legend.html">legend
</a>]
</span></center></div>
124 <table class=
"memberdecls">
125 <tr class=
"heading"><td colspan=
"2"><h2 class=
"groupheader"><a name=
"pub-attribs"></a>
126 Data Fields
</h2></td></tr>
127 <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> *
 </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"structphp__persistent__handle__factory.html#a43aabcbe7ec4b5ff463f74cfcf788f51">provider
</a></td></tr>
128 <tr class=
"memdesc:a43aabcbe7ec4b5ff463f74cfcf788f51"><td class=
"mdescLeft"> </td><td class=
"mdescRight">The persistent handle provider.
<a href=
"#a43aabcbe7ec4b5ff463f74cfcf788f51">More...
</a><br/></td></tr>
129 <tr class=
"separator:a43aabcbe7ec4b5ff463f74cfcf788f51"><td class=
"memSeparator" colspan=
"2"> </td></tr>
130 <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> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"structphp__persistent__handle__factory.html#a6633b7c860e4538942e0367d64ed5af7">wakeup
</a></td></tr>
131 <tr class=
"memdesc:a6633b7c860e4538942e0367d64ed5af7"><td class=
"mdescLeft"> </td><td class=
"mdescRight">The persistent handle wakeup routine; may be NULL.
<a href=
"#a6633b7c860e4538942e0367d64ed5af7">More...
</a><br/></td></tr>
132 <tr class=
"separator:a6633b7c860e4538942e0367d64ed5af7"><td class=
"memSeparator" colspan=
"2"> </td></tr>
133 <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> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"structphp__persistent__handle__factory.html#a9299f3f0821061ad93d15c10cf735b6b">retire
</a></td></tr>
134 <tr class=
"memdesc:a9299f3f0821061ad93d15c10cf735b6b"><td class=
"mdescLeft"> </td><td class=
"mdescRight">The persistent handle retire routine; may be NULL.
<a href=
"#a9299f3f0821061ad93d15c10cf735b6b">More...
</a><br/></td></tr>
135 <tr class=
"separator:a9299f3f0821061ad93d15c10cf735b6b"><td class=
"memSeparator" colspan=
"2"> </td></tr>
136 <tr class=
"memitem:ae874c03caffa8eaa265dd52ebf593c02"><td class=
"memItemLeft" >struct {
</td></tr>
137 <tr class=
"memitem:a3bfa871ff526fa80a3e5ccc5c163f9ab"><td class=
"memItemLeft" >   char *
   <a class=
"el" href=
"structphp__persistent__handle__factory.html#a71be5a461851c6d3b93fa88126a2feae">str
</a></td></tr>
138 <tr class=
"memdesc:a3bfa871ff526fa80a3e5ccc5c163f9ab"><td class=
"mdescLeft"> </td><td class=
"mdescRight">ident string
<a href=
"#a3bfa871ff526fa80a3e5ccc5c163f9ab">More...
</a><br/></td></tr>
139 <tr class=
"separator:a3bfa871ff526fa80a3e5ccc5c163f9ab"><td class=
"memSeparator" colspan=
"2"> </td></tr>
140 <tr class=
"memitem:ac2c77473ee2989bc86a02f4bcc69977e"><td class=
"memItemLeft" >   size_t
   <a class=
"el" href=
"structphp__persistent__handle__factory.html#ab26e72bac3190bd8cd4dadc6a39d86c4">len
</a></td></tr>
141 <tr class=
"memdesc:ac2c77473ee2989bc86a02f4bcc69977e"><td class=
"mdescLeft"> </td><td class=
"mdescRight">ident length
<a href=
"#ac2c77473ee2989bc86a02f4bcc69977e">More...
</a><br/></td></tr>
142 <tr class=
"separator:ac2c77473ee2989bc86a02f4bcc69977e"><td class=
"memSeparator" colspan=
"2"> </td></tr>
143 <tr class=
"memitem:ae874c03caffa8eaa265dd52ebf593c02"><td class=
"memItemLeft" valign=
"top">}
 </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"structphp__persistent__handle__factory.html#ae874c03caffa8eaa265dd52ebf593c02">ident
</a></td></tr>
144 <tr class=
"memdesc:ae874c03caffa8eaa265dd52ebf593c02"><td class=
"mdescLeft"> </td><td class=
"mdescRight">The ident for which this factory manages resources.
<a href=
"#ae874c03caffa8eaa265dd52ebf593c02">More...
</a><br/></td></tr>
145 <tr class=
"separator:ae874c03caffa8eaa265dd52ebf593c02"><td class=
"memSeparator" colspan=
"2"> </td></tr>
146 <tr class=
"memitem:a84ffa94401b9869e14c190be4bb1b6be"><td class=
"memItemLeft" align=
"right" valign=
"top">unsigned
 </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"structphp__persistent__handle__factory.html#a84ffa94401b9869e14c190be4bb1b6be">free_on_abandon
</a>:
1</td></tr>
147 <tr class=
"memdesc:a84ffa94401b9869e14c190be4bb1b6be"><td class=
"mdescLeft"> </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>
148 <tr class=
"separator:a84ffa94401b9869e14c190be4bb1b6be"><td class=
"memSeparator" colspan=
"2"> </td></tr>
150 <a name=
"details" id=
"details"></a><h2 class=
"groupheader">Detailed Description
</h2>
151 <div class=
"textblock"><p>Definition of a persistent handle factory.
</p>
152 <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>
153 </div><h2 class=
"groupheader">Field Documentation
</h2>
154 <a class=
"anchor" id=
"a84ffa94401b9869e14c190be4bb1b6be"></a>
155 <div class=
"memitem">
156 <div class=
"memproto">
157 <table class=
"memname">
159 <td class=
"memname">unsigned php_persistent_handle_factory::free_on_abandon
</td>
162 </div><div class=
"memdoc">
164 <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>
168 <a class=
"anchor" id=
"ae874c03caffa8eaa265dd52ebf593c02"></a>
169 <div class=
"memitem">
170 <div class=
"memproto">
171 <table class=
"memname">
173 <td class=
"memname">struct { ... } php_persistent_handle_factory::ident
</td>
176 </div><div class=
"memdoc">
178 <p>The ident for which this factory manages resources.
</p>
182 <a class=
"anchor" id=
"ab26e72bac3190bd8cd4dadc6a39d86c4"></a>
183 <div class=
"memitem">
184 <div class=
"memproto">
185 <table class=
"memname">
187 <td class=
"memname">size_t php_persistent_handle_factory::len
</td>
190 </div><div class=
"memdoc">
196 <a class=
"anchor" id=
"a43aabcbe7ec4b5ff463f74cfcf788f51"></a>
197 <div class=
"memitem">
198 <div class=
"memproto">
199 <table class=
"memname">
201 <td class=
"memname"><a class=
"el" href=
"php__raphf_8h.html#a31f0595f4f726f762790cef844568fc4">php_persistent_handle_provider_t
</a>* php_persistent_handle_factory::provider
</td>
204 </div><div class=
"memdoc">
206 <p>The persistent handle provider.
</p>
210 <a class=
"anchor" id=
"a9299f3f0821061ad93d15c10cf735b6b"></a>
211 <div class=
"memitem">
212 <div class=
"memproto">
213 <table class=
"memname">
215 <td class=
"memname"><a class=
"el" href=
"php__raphf_8h.html#a8f7d6389c67478ca0b99729a5dd3d305">php_persistent_handle_retire_t
</a> php_persistent_handle_factory::retire
</td>
218 </div><div class=
"memdoc">
220 <p>The persistent handle retire routine; may be NULL.
</p>
224 <a class=
"anchor" id=
"a71be5a461851c6d3b93fa88126a2feae"></a>
225 <div class=
"memitem">
226 <div class=
"memproto">
227 <table class=
"memname">
229 <td class=
"memname">char* php_persistent_handle_factory::str
</td>
232 </div><div class=
"memdoc">
238 <a class=
"anchor" id=
"a6633b7c860e4538942e0367d64ed5af7"></a>
239 <div class=
"memitem">
240 <div class=
"memproto">
241 <table class=
"memname">
243 <td class=
"memname"><a class=
"el" href=
"php__raphf_8h.html#a681ca1f7c1249199b45270be60c721c6">php_persistent_handle_wakeup_t
</a> php_persistent_handle_factory::wakeup
</td>
246 </div><div class=
"memdoc">
248 <p>The persistent handle wakeup routine; may be NULL.
</p>
252 <hr/>The documentation for this struct was generated from the following file:
<ul>
253 <li><a class=
"el" href=
"php__raphf_8h_source.html">php_raphf.h
</a></li>
255 </div><!-- contents -->
256 </div><!-- doc-content -->
257 <!-- start footer part -->
258 <div id=
"nav-path" class=
"navpath"><!-- id is needed for treeview function! -->
260 <li class=
"navelem"><a class=
"el" href=
"structphp__persistent__handle__factory.html">php_persistent_handle_factory
</a></li>
261 <li class=
"footer">Generated on Wed Dec
4 2013 12:
20:
29 for Resource and persistent handle factory API by
262 <a href=
"http://www.doxygen.org/index.html">
263 <img class=
"footer" src=
"doxygen.png" alt=
"doxygen"/></a> 1.8.5 </li>