29fbff7d3289db156b27164075700a2e94af5964
[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.5"/>
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="navtree.js"></script>
14 <script type="text/javascript">
15 $(document).ready(initResizable);
16 $(window).load(resizeHeight);
17 </script>
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); });
22 </script>
23 <link href="doxygen.css" rel="stylesheet" type="text/css" />
24 </head>
25 <body>
26 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27 <div id="titlearea">
28 <table cellspacing="0" cellpadding="0">
29 <tbody>
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
34 </div>
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>
36 </td>
37 </tr>
38 </tbody>
39 </table>
40 </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');
45 </script>
46 <div id="navrow1" class="tabs">
47 <ul class="tablist">
48 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49 <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
50 <li><a href="files.html"><span>Files</span></a></li>
51 <li>
52 <div id="MSearchBox" class="MSearchBoxInactive">
53 <span class="left">
54 <img id="MSearchSelect" src="search/mag_sel.png"
55 onmouseover="return searchBox.OnSearchSelectShow()"
56 onmouseout="return searchBox.OnSearchSelectHide()"
57 alt=""/>
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>
64 </span>
65 </div>
66 </li>
67 </ul>
68 </div>
69 <div id="navrow2" class="tabs2">
70 <ul class="tablist">
71 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
72 <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
73 <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
74 </ul>
75 </div>
76 </div><!-- top -->
77 <div id="side-nav" class="ui-resizable side-nav-resizable">
78 <div id="nav-tree">
79 <div id="nav-tree-contents">
80 <div id="nav-sync" class="sync"></div>
81 </div>
82 </div>
83 <div id="splitbar" style="-moz-user-select:none;"
84 class="ui-resizable-handle">
85 </div>
86 </div>
87 <script type="text/javascript">
88 $(document).ready(function(){initNavTree('structphp__resource__factory.html','');});
89 </script>
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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a></div>
97
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">
102 </iframe>
103 </div>
104
105 <div class="header">
106 <div class="summary">
107 <a href="#pub-attribs">Data Fields</a> </div>
108 <div class="headertitle">
109 <div class="title">php_resource_factory Struct Reference</div> </div>
110 </div><!--header-->
111 <div class="contents">
112
113 <p>The resource factory.
114 <a href="structphp__resource__factory.html#details">More...</a></p>
115
116 <p><code>#include &lt;<a class="el" href="php__raphf_8h_source.html">php_raphf.h</a>&gt;</code></p>
117 <div class="dynheader">
118 Collaboration diagram for php_resource_factory:</div>
119 <div class="dyncontent">
120 <div class="center"><img src="structphp__resource__factory__coll__graph.png" border="0" usemap="#php__resource__factory_coll__map" alt="Collaboration graph"/></div>
121 <map name="php__resource__factory_coll__map" id="php__resource__factory_coll__map">
122 <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,179,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: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>
128 <tr class="memdesc:af46453098d0078f9015184549b363824"><td class="mdescLeft">&#160;</td><td class="mdescRight">The resource ops. <a href="#af46453098d0078f9015184549b363824">More...</a><br/></td></tr>
129 <tr class="separator:af46453098d0078f9015184549b363824"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <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>
131 <tr class="memdesc:af2be7546c9d94eccc9350df812830d12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opaque user data. <a href="#af2be7546c9d94eccc9350df812830d12">More...</a><br/></td></tr>
132 <tr class="separator:af2be7546c9d94eccc9350df812830d12"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:a7b48ed1c081288e7dd396bdb2f9187f9"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__resource__factory.html#a7b48ed1c081288e7dd396bdb2f9187f9">dtor</a> )(void *<a class="el" href="structphp__resource__factory.html#af2be7546c9d94eccc9350df812830d12">data</a>)</td></tr>
134 <tr class="memdesc:a7b48ed1c081288e7dd396bdb2f9187f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data destructor. <a href="#a7b48ed1c081288e7dd396bdb2f9187f9">More...</a><br/></td></tr>
135 <tr class="separator:a7b48ed1c081288e7dd396bdb2f9187f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <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>
137 <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>
138 <tr class="separator:a00ebf2bd2227f5d4826751b3b475769f"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 </table>
140 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
141 <div class="textblock"><p>The resource factory. </p>
142 </div><h2 class="groupheader">Field Documentation</h2>
143 <a class="anchor" id="af2be7546c9d94eccc9350df812830d12"></a>
144 <div class="memitem">
145 <div class="memproto">
146 <table class="memname">
147 <tr>
148 <td class="memname">void* php_resource_factory::data</td>
149 </tr>
150 </table>
151 </div><div class="memdoc">
152
153 <p>Opaque user data. </p>
154
155 </div>
156 </div>
157 <a class="anchor" id="a7b48ed1c081288e7dd396bdb2f9187f9"></a>
158 <div class="memitem">
159 <div class="memproto">
160 <table class="memname">
161 <tr>
162 <td class="memname">void(* php_resource_factory::dtor)(void *<a class="el" href="structphp__resource__factory.html#af2be7546c9d94eccc9350df812830d12">data</a>)</td>
163 </tr>
164 </table>
165 </div><div class="memdoc">
166
167 <p>User data destructor. </p>
168
169 </div>
170 </div>
171 <a class="anchor" id="af46453098d0078f9015184549b363824"></a>
172 <div class="memitem">
173 <div class="memproto">
174 <table class="memname">
175 <tr>
176 <td class="memname"><a class="el" href="php__raphf_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a> php_resource_factory::fops</td>
177 </tr>
178 </table>
179 </div><div class="memdoc">
180
181 <p>The resource ops. </p>
182
183 </div>
184 </div>
185 <a class="anchor" id="a00ebf2bd2227f5d4826751b3b475769f"></a>
186 <div class="memitem">
187 <div class="memproto">
188 <table class="memname">
189 <tr>
190 <td class="memname">unsigned php_resource_factory::refcount</td>
191 </tr>
192 </table>
193 </div><div class="memdoc">
194
195 <p>How often this factory is referenced. </p>
196
197 </div>
198 </div>
199 <hr/>The documentation for this struct was generated from the following file:<ul>
200 <li><a class="el" href="php__raphf_8h_source.html">php_raphf.h</a></li>
201 </ul>
202 </div><!-- contents -->
203 </div><!-- doc-content -->
204 <!-- start footer part -->
205 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
206 <ul>
207 <li class="navelem"><a class="el" href="structphp__resource__factory.html">php_resource_factory</a></li>
208 <li class="footer">Generated by
209 <a href="http://www.doxygen.org/index.html">
210 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
211 </ul>
212 </div>
213 </body>
214 </html>