php-doc-en/reference/apache/functions/apache-child-terminate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/apache.xml, last change in rev 1.20 -->
<refentry xml:id="function.apache-child-terminate" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>apache_child_terminate</refname>
  <refpurpose>Terminate apache process after this request</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>apache_child_terminate</methodname>
   <void/>
  </methodsynopsis>
  <para>
   <function>apache_child_terminate</function> will register the
   Apache process executing the current PHP request for termination
   once execution of PHP code is completed. It may be used to
   terminate a process after a script with high memory consumption has
   been run as memory will usually only be freed internally but not
   given back to the operating system. 
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; if PHP is running as an Apache 1 module, the Apache version
   is non-multithreaded, and the 
   <link linkend="ini.child-terminate">child_terminate</link> PHP directive is 
   enabled (disabled by default). If these conditions are not met, &false; is 
   returned and an error of level <constant>E_WARNING</constant> is generated.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.4.0</entry>
       <entry>
        This function became available under FastCGI. Previously, it was
        supported only when PHP was installed as an Apache module.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.no-windows;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>exit</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
-->