git.m6w6.name Git - m6w6/ext-raphf/blob - v1.1.x/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.10"/>
   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 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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  53       <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
  75       <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  76       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  77     </ul>
  78   </div>
  79 </div><!-- top -->
  80 <div id="side-nav" class="ui-resizable side-nav-resizable">
  81   <div id="nav-tree">
  82     <div id="nav-tree-contents">
  83       <div id="nav-sync" class="sync"></div>
  84     </div>
  85   </div>
  86   <div id="splitbar" style="-moz-user-select:none;"
  87        class="ui-resizable-handle">
  88   </div>
  89 </div>
  90 <script type="text/javascript">
  91 $(document).ready(function(){initNavTree('structphp__resource__factory.html','');});
  92 </script>
  93 <div id="doc-content">
  94 <!-- window showing the filter options -->
  95 <div id="MSearchSelectWindow"
  96      onmouseover="return searchBox.OnSearchSelectShow()"
  97      onmouseout="return searchBox.OnSearchSelectHide()"
  98      onkeydown="return searchBox.OnSearchSelectKey(event)">
  99 </div>
 100
 101 <!-- iframe showing the search results (closed by default) -->
 102 <div id="MSearchResultsWindow">
 103 <iframe src="javascript:void(0)" frameborder="0"
 104         name="MSearchResults" id="MSearchResults">
 105 </iframe>
 106 </div>
 107
 108 <div class="header">
 109   <div class="summary">
 110 <a href="#pub-attribs">Data Fields</a>  </div>
 111   <div class="headertitle">
 112 <div class="title">php_resource_factory Struct Reference</div>  </div>
 113 </div><!--header-->
 114 <div class="contents">
 115
 116 <p>The resource factory.
 117  <a href="structphp__resource__factory.html#details">More...</a></p>
 118
 119 <p><code>#include &lt;<a class="el" href="php__raphf__api_8h_source.html">php_raphf_api.h</a>&gt;</code></p>
 120 <div class="dynheader">
 121 Collaboration diagram for php_resource_factory:</div>
 122 <div class="dyncontent">
 123 <div class="center"><img src="structphp__resource__factory__coll__graph.png" border="0" usemap="#php__resource__factory_coll__map" alt="Collaboration graph"/></div>
 124 <map name="php__resource__factory_coll__map" id="php__resource__factory_coll__map">
 125 <area shape="rect" id="node2" href="php__raphf__api_8h.html#structphp__resource__factory__ops" title="The resource ops consisting of a ctor, a copy ctor and a dtor. " alt="" coords="5,5,180,32"/>
 126 </map>
 127 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
 128 <table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 130 Data Fields</h2></td></tr>
 131 <tr class="memitem:af46453098d0078f9015184549b363824"><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="structphp__resource__factory.html#af46453098d0078f9015184549b363824">fops</a></td></tr>
 132 <tr class="memdesc:af46453098d0078f9015184549b363824"><td class="mdescLeft">&#160;</td><td class="mdescRight">The resource ops.  <a href="#af46453098d0078f9015184549b363824">More...</a><br /></td></tr>
 133 <tr class="separator:af46453098d0078f9015184549b363824"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <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>
 135 <tr class="memdesc:af2be7546c9d94eccc9350df812830d12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opaque user data.  <a href="#af2be7546c9d94eccc9350df812830d12">More...</a><br /></td></tr>
 136 <tr class="separator:af2be7546c9d94eccc9350df812830d12"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <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>
 138 <tr class="memdesc:a7d6c89f9c6035be8a5e166a6a86cd1c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data destructor.  <a href="#a7d6c89f9c6035be8a5e166a6a86cd1c7">More...</a><br /></td></tr>
 139 <tr class="separator:a7d6c89f9c6035be8a5e166a6a86cd1c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <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>
 141 <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>
 142 <tr class="separator:a00ebf2bd2227f5d4826751b3b475769f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 </table>
 144 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 145 <div class="textblock"><p>The resource factory. </p>
 146 </div><h2 class="groupheader">Field Documentation</h2>
 147 <a class="anchor" id="af2be7546c9d94eccc9350df812830d12"></a>
 148 <div class="memitem">
 149 <div class="memproto">
 150       <table class="memname">
 151         <tr>
 152           <td class="memname">void* php_resource_factory::data</td>
 153         </tr>
 154       </table>
 155 </div><div class="memdoc">
 156
 157 <p>Opaque user data. </p>
 158
 159 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#a016b8a4159e698f915ab967711696847">php_resource_factory_dtor()</a>, <a class="el" href="php__raphf__api_8h.html#a08db5f3698f2d0bf3d2f20dcf4e7b2b4">php_resource_factory_handle_copy()</a>, <a class="el" href="php__raphf__api_8h.html#a98d02dc80dd83095b8f901954350840c">php_resource_factory_handle_ctor()</a>, <a class="el" href="php__raphf__api_8h.html#a97dbb9d342f33205b92374c586676bc6">php_resource_factory_handle_dtor()</a>, and <a class="el" href="php__raphf__api_8h.html#ad20f10c53e3f33756638da98819367f0">php_resource_factory_init()</a>.</p>
 160
 161 </div>
 162 </div>
 163 <a class="anchor" id="a7d6c89f9c6035be8a5e166a6a86cd1c7"></a>
 164 <div class="memitem">
 165 <div class="memproto">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname">void(* php_resource_factory::dtor) (void *<a class="el" href="structphp__resource__factory.html#af2be7546c9d94eccc9350df812830d12">data</a>)</td>
 169         </tr>
 170       </table>
 171 </div><div class="memdoc">
 172
 173 <p>User data destructor. </p>
 174
 175 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#a016b8a4159e698f915ab967711696847">php_resource_factory_dtor()</a>, <a class="el" href="php__raphf__api_8h.html#ad20f10c53e3f33756638da98819367f0">php_resource_factory_init()</a>, and <a class="el" href="php__raphf__api_8h.html#a617d2cc656ab6427388b938597194ebb">php_resource_factory_is_persistent()</a>.</p>
 176
 177 </div>
 178 </div>
 179 <a class="anchor" id="af46453098d0078f9015184549b363824"></a>
 180 <div class="memitem">
 181 <div class="memproto">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname"><a class="el" href="php__raphf__api_8h.html#a29e0d7a66e441a5265ddf2f0adbbb3af">php_resource_factory_ops_t</a> php_resource_factory::fops</td>
 185         </tr>
 186       </table>
 187 </div><div class="memdoc">
 188
 189 <p>The resource ops. </p>
 190
 191 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#a08db5f3698f2d0bf3d2f20dcf4e7b2b4">php_resource_factory_handle_copy()</a>, <a class="el" href="php__raphf__api_8h.html#a98d02dc80dd83095b8f901954350840c">php_resource_factory_handle_ctor()</a>, <a class="el" href="php__raphf__api_8h.html#a97dbb9d342f33205b92374c586676bc6">php_resource_factory_handle_dtor()</a>, and <a class="el" href="php__raphf__api_8h.html#ad20f10c53e3f33756638da98819367f0">php_resource_factory_init()</a>.</p>
 192
 193 </div>
 194 </div>
 195 <a class="anchor" id="a00ebf2bd2227f5d4826751b3b475769f"></a>
 196 <div class="memitem">
 197 <div class="memproto">
 198       <table class="memname">
 199         <tr>
 200           <td class="memname">unsigned php_resource_factory::refcount</td>
 201         </tr>
 202       </table>
 203 </div><div class="memdoc">
 204
 205 <p>How often this factory is referenced. </p>
 206
 207 <p>Referenced by <a class="el" href="php__raphf__api_8h.html#ae8be369197905047ffbd05c0ca80f245">php_resource_factory_addref()</a>, <a class="el" href="php__raphf__api_8h.html#a016b8a4159e698f915ab967711696847">php_resource_factory_dtor()</a>, and <a class="el" href="php__raphf__api_8h.html#ad20f10c53e3f33756638da98819367f0">php_resource_factory_init()</a>.</p>
 208
 209 </div>
 210 </div>
 211 <hr/>The documentation for this struct was generated from the following file:<ul>
 212 <li>src/<a class="el" href="php__raphf__api_8h_source.html">php_raphf_api.h</a></li>
 213 </ul>
 214 </div><!-- contents -->
 215 </div><!-- doc-content -->
 216 <!-- start footer part -->
 217 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 218   <ul>
 219     <li class="navelem"><a class="el" href="structphp__resource__factory.html">php_resource_factory</a></li>
 220     <li class="footer">Generated by
 221     <a href="http://www.doxygen.org/index.html">
 222     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
 223   </ul>
 224 </div>
 225 </body>
 226 </html>