publish docs as gh-pages
[m6w6/ext-raphf] / structphp__persistent__handle__provider.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_persistent_handle_provider 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__persistent__handle__provider.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_persistent_handle_provider Struct Reference</div> </div>
110 </div><!--header-->
111 <div class="contents">
112
113 <p>Definition of a persistent handle provider.
114 <a href="structphp__persistent__handle__provider.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_persistent_handle_provider:</div>
119 <div class="dyncontent">
120 <div class="center"><img src="structphp__persistent__handle__provider__coll__graph.png" border="0" usemap="#php__persistent__handle__provider_coll__map" alt="Collaboration graph"/></div>
121 <map name="php__persistent__handle__provider_coll__map" id="php__persistent__handle__provider_coll__map">
122 <area shape="rect" id="node2" href="structphp__persistent__handle__list.html" title="Persistent handles storage. " alt="" coords="5,96,181,123"/><area shape="rect" id="node3" href="structphp__resource__factory.html" title="The resource factory. " alt="" coords="205,96,352,123"/><area shape="rect" id="node4" 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:a4935f6446b1d4a2feb7a22dfc4e5d6d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf_8h.html#a07f599598d2b87b188f39871d026c177">php_persistent_handle_list_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__persistent__handle__provider.html#a4935f6446b1d4a2feb7a22dfc4e5d6d0">list</a></td></tr>
128 <tr class="memdesc:a4935f6446b1d4a2feb7a22dfc4e5d6d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of free handles. <a href="#a4935f6446b1d4a2feb7a22dfc4e5d6d0">More...</a><br/></td></tr>
129 <tr class="separator:a4935f6446b1d4a2feb7a22dfc4e5d6d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <tr class="memitem:a8204714f100b74b028652951ca40abd3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="php__raphf_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structphp__persistent__handle__provider.html#a8204714f100b74b028652951ca40abd3">rf</a></td></tr>
131 <tr class="memdesc:a8204714f100b74b028652951ca40abd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The resource factory. <a href="#a8204714f100b74b028652951ca40abd3">More...</a><br/></td></tr>
132 <tr class="separator:a8204714f100b74b028652951ca40abd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 </table>
134 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
135 <div class="textblock"><p>Definition of a persistent handle provider. </p>
136 <p>Holds a resource factory an a persistent handle list. </p>
137 </div><h2 class="groupheader">Field Documentation</h2>
138 <a class="anchor" id="a4935f6446b1d4a2feb7a22dfc4e5d6d0"></a>
139 <div class="memitem">
140 <div class="memproto">
141 <table class="memname">
142 <tr>
143 <td class="memname"><a class="el" href="php__raphf_8h.html#a07f599598d2b87b188f39871d026c177">php_persistent_handle_list_t</a> php_persistent_handle_provider::list</td>
144 </tr>
145 </table>
146 </div><div class="memdoc">
147
148 <p>The list of free handles. </p>
149 <p>Hash of "ident" =&gt; array(handles) entries. Persistent handles are acquired out of this list. </p>
150
151 </div>
152 </div>
153 <a class="anchor" id="a8204714f100b74b028652951ca40abd3"></a>
154 <div class="memitem">
155 <div class="memproto">
156 <table class="memname">
157 <tr>
158 <td class="memname"><a class="el" href="php__raphf_8h.html#a4817c4b3d4077c48dff36376487ba8d4">php_resource_factory_t</a> php_persistent_handle_provider::rf</td>
159 </tr>
160 </table>
161 </div><div class="memdoc">
162
163 <p>The resource factory. </p>
164 <p>New handles are created by this factory. </p>
165
166 </div>
167 </div>
168 <hr/>The documentation for this struct was generated from the following file:<ul>
169 <li><a class="el" href="php__raphf_8h_source.html">php_raphf.h</a></li>
170 </ul>
171 </div><!-- contents -->
172 </div><!-- doc-content -->
173 <!-- start footer part -->
174 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
175 <ul>
176 <li class="navelem"><a class="el" href="structphp__persistent__handle__provider.html">php_persistent_handle_provider</a></li>
177 <li class="footer">Generated on Wed Dec 4 2013 12:20:29 for Resource and persistent handle factory API by
178 <a href="http://www.doxygen.org/index.html">
179 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
180 </ul>
181 </div>
182 </body>
183 </html>