update docs
[m6w6/ext-raphf] / structphp__resource__factory.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.9.1"/>
7 <title>Resource and persistent handle factory API: php_resource_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="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 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.9.1 -->
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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
52 <li><a href="files.html"><span>Files</span></a></li>
53 <li>
54 <div id="MSearchBox" class="MSearchBoxInactive">
55 <span class="left">
56 <img id="MSearchSelect" src="search/mag_sel.png"
57 onmouseover="return searchBox.OnSearchSelectShow()"
58 onmouseout="return searchBox.OnSearchSelectHide()"
59 alt=""/>
60 <input type="text" id="MSearchField" value="Search" accesskey="S"
61 onfocus="searchBox.OnSearchFieldFocus(true)"
62 onblur="searchBox.OnSearchFieldFocus(false)"
63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
64 </span><span class="right">
65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
66 </span>
67 </div>
68 </li>
69 </ul>
70 </div>
71 <div id="navrow2" class="tabs2">
72 <ul class="tablist">
73 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
74 <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
75 <li><a href="functions.html"><span>Data&#160;Fields</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('structphp__resource__factory.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="#pub-attribs">Data Fields</a> </div>
110 <div class="headertitle">
111 <div class="title">php_resource_factory Struct Reference</div> </div>
112 </div><!--header-->
113 <div class="contents">
114
115 <p>The resource factory.
116 <a href="structphp__resource__factory.html#details">More...</a></p>
117
118 <p><code>#include &lt;<a class="el" href="php__raphf_8h_source.html">php_raphf.h</a>&gt;</code></p>
119 <div class="dynheader">
120 Collaboration diagram for php_resource_factory:</div>
121 <div class="dyncontent">
122 <div class="center"><img src="structphp__resource__factory__coll__graph.png" border="0" usemap="#php__resource__factory_coll__map" alt="Collaboration graph"/></div>
123 <map name="php__resource__factory_coll__map" id="php__resource__factory_coll__map">
124 <area shape="rect" id="node2" href="php__raphf_8h.html#structphp__resource__factory__ops" title="The resource ops consisting of a ctor, a copy ctor and a dtor. " alt="" coords="5,5,196,32"/></map>
125 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
126 <table class="memberdecls">
127 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
128 Data Fields</h2></td></tr>
129 <tr class="memitem:af46453098d0078f9015184549b363824"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__resource__factory.html#af46453098d0078f9015184549b363824">fops</a></td></tr>
130 <tr class="memdesc:af46453098d0078f9015184549b363824"><td class="mdescLeft">&#160;</td><td class="mdescRight">The resource ops. <a href="#af46453098d0078f9015184549b363824">More...</a><br /></td></tr>
131 <tr class="separator:af46453098d0078f9015184549b363824"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 <tr class="memitem:af2be7546c9d94eccc9350df812830d12"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__resource__factory.html#af2be7546c9d94eccc9350df812830d12">data</a></td></tr>
133 <tr class="memdesc:af2be7546c9d94eccc9350df812830d12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opaque user data. <a href="#af2be7546c9d94eccc9350df812830d12">More...</a><br /></td></tr>
134 <tr class="separator:af2be7546c9d94eccc9350df812830d12"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:a7d6c89f9c6035be8a5e166a6a86cd1c7"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__resource__factory.html#a7d6c89f9c6035be8a5e166a6a86cd1c7">dtor</a> )(void *<a class="el" href="structphp__resource__factory.html#af2be7546c9d94eccc9350df812830d12">data</a>)</td></tr>
136 <tr class="memdesc:a7d6c89f9c6035be8a5e166a6a86cd1c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data destructor. <a href="#a7d6c89f9c6035be8a5e166a6a86cd1c7">More...</a><br /></td></tr>
137 <tr class="separator:a7d6c89f9c6035be8a5e166a6a86cd1c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:a00ebf2bd2227f5d4826751b3b475769f"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__resource__factory.html#a00ebf2bd2227f5d4826751b3b475769f">refcount</a></td></tr>
139 <tr class="memdesc:a00ebf2bd2227f5d4826751b3b475769f"><td class="mdescLeft">&#160;</td><td class="mdescRight">How often this factory is referenced. <a href="#a00ebf2bd2227f5d4826751b3b475769f">More...</a><br /></td></tr>
140 <tr class="separator:a00ebf2bd2227f5d4826751b3b475769f"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 </table>
142 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
143 <div class="textblock"><p>The resource factory. </p>
144 </div><h2 class="groupheader">Field Documentation</h2>
145 <a class="anchor" id="af2be7546c9d94eccc9350df812830d12"></a>
146 <div class="memitem">
147 <div class="memproto">
148 <table class="memname">
149 <tr>
150 <td class="memname">void* php_resource_factory::data</td>
151 </tr>
152 </table>
153 </div><div class="memdoc">
154
155 <p>Opaque user data. </p>
156
157 </div>
158 </div>
159 <a class="anchor" id="a7d6c89f9c6035be8a5e166a6a86cd1c7"></a>
160 <div class="memitem">
161 <div class="memproto">
162 <table class="memname">
163 <tr>
164 <td class="memname">void(* php_resource_factory::dtor) (void *<a class="el" href="structphp__resource__factory.html#af2be7546c9d94eccc9350df812830d12">data</a>)</td>
165 </tr>
166 </table>
167 </div><div class="memdoc">
168
169 <p>User data destructor. </p>
170
171 </div>
172 </div>
173 <a class="anchor" id="af46453098d0078f9015184549b363824"></a>
174 <div class="memitem">
175 <div class="memproto">
176 <table class="memname">
177 <tr>
178 <td class="memname"><a class="el" href="php__raphf_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a> php_resource_factory::fops</td>
179 </tr>
180 </table>
181 </div><div class="memdoc">
182
183 <p>The resource ops. </p>
184
185 </div>
186 </div>
187 <a class="anchor" id="a00ebf2bd2227f5d4826751b3b475769f"></a>
188 <div class="memitem">
189 <div class="memproto">
190 <table class="memname">
191 <tr>
192 <td class="memname">unsigned php_resource_factory::refcount</td>
193 </tr>
194 </table>
195 </div><div class="memdoc">
196
197 <p>How often this factory is referenced. </p>
198
199 </div>
200 </div>
201 <hr/>The documentation for this struct was generated from the following file:<ul>
202 <li><a class="el" href="php__raphf_8h_source.html">php_raphf.h</a></li>
203 </ul>
204 </div><!-- contents -->
205 </div><!-- doc-content -->
206 <!-- start footer part -->
207 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
208 <ul>
209 <li class="navelem"><a class="el" href="structphp__resource__factory.html">php_resource_factory</a></li>
210 <li class="footer">Generated by
211 <a href="http://www.doxygen.org/index.html">
212 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
213 </ul>
214 </div>
215 </body>
216 </html>