wincache-ocache-meminfo.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wincache-ocache-meminfo" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wincache_ocache_meminfo</refname>
  <refpurpose>
   Retrieves information about opcode cache memory usage
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>wincache_ocache_meminfo</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Retrieves information about memory usage by opcode cache.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Array of meta data about opcode cache memory usage &return.falseforfailure;
  </para>
  <para>
   The array returned by this function contains the following elements:
   <itemizedlist spacing="compact">
    <listitem>
     <simpara>
      <literal>memory_total</literal> - amount of memory in bytes allocated for the opcode cache
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>memory_free</literal> - amount of free memory in bytes available for the opcode cache
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>num_used_blks</literal> - number of memory blocks used by the opcode cache
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>num_free_blks</literal> - number of free memory blocks available for the opcode cache
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>memory_overhead</literal> - amount of memory in bytes used for the opcode cache internal structures
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
  &warn.removed.function-7-0-0;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>wincache_ocache_meminfo</function> example</title>
    <programlisting role="php">
<![CDATA[
<pre>
<?php
print_r(wincache_ocache_meminfo());
?>
</pre>

]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [memory_total] => 134217728
    [memory_free] => 112106972
    [num_used_blks] => 15469
    [num_free_blks] => 4
    [memory_overhead] => 247600
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>wincache_fcache_fileinfo</function></member>
    <member><function>wincache_fcache_meminfo</function></member>
    <member><function>wincache_ocache_fileinfo</function></member>
    <member><function>wincache_rplist_fileinfo</function></member>
    <member><function>wincache_rplist_meminfo</function></member>
    <member><function>wincache_refresh_if_changed</function></member>
    <member><function>wincache_ucache_meminfo</function></member>
    <member><function>wincache_ucache_info</function></member>
    <member><function>wincache_scache_info</function></member>
    <member><function>wincache_scache_meminfo</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->