mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
- add persistent handles API
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@232832 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Michael Wallner
parent
2f21a8d0b4
commit
2e8591032a
6 changed files with 330 additions and 8 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="http.HttpMessage">
|
||||
<refnamediv>
|
||||
|
|
@ -127,6 +127,8 @@
|
|||
&reftitle.methods;
|
||||
<simplelist>
|
||||
<member><link linkend="function.HttpMessage-construct"><classname>HttpMessage</classname>::<function>construct</function></link></member>
|
||||
<member><link linkend="function.HttpMessage-factory"><classname>HttpMessage</classname>::<function>factory</function></link></member>
|
||||
<member><link linkend="function.HttpMessage-fromEnv"><classname>HttpMessage</classname>::<function>fromEnv</function></link></member>
|
||||
<member><link linkend="function.HttpMessage-fromString"><classname>HttpMessage</classname>::<function>fromString</function></link></member>
|
||||
<member><link linkend="function.HttpMessage-toString"><classname>HttpMessage</classname>::<function>toString</function></link></member>
|
||||
<member><link linkend="function.HttpMessage-toMessageTypeObject"><classname>HttpMessage</classname>::<function>toMessageTypeObject</function></link></member>
|
||||
|
|
@ -160,6 +162,8 @@
|
|||
</refentry>
|
||||
|
||||
&reference.http.HttpMessage.construct;
|
||||
&reference.http.HttpMessage.factory;
|
||||
&reference.http.HttpMessage.fromEnv;
|
||||
&reference.http.HttpMessage.fromString;
|
||||
&reference.http.HttpMessage.toString;
|
||||
&reference.http.HttpMessage.toMessageTypeObject;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.HttpMessage-fromString">
|
||||
<refnamediv>
|
||||
|
|
@ -16,8 +16,9 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Create an HttpMessage object from a string. Kind of a static constructor.
|
||||
Create an HttpMessage object from a string.
|
||||
</para>
|
||||
&info.function.alias.deprecated;
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -115,17 +116,14 @@ Use the PEAR Coding Standards
|
|||
-->
|
||||
|
||||
|
||||
<!-- Use when adding See Also links
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function></function></member>
|
||||
<member>Or <link linkend="somethingelse">something else</link></member>
|
||||
<member><function><classname>HttpMessage</classname>::factory</function>.</member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
|
||||
</refentry>
|
||||
|
|
|
|||
3
reference/http/functions/persistenthandles.xml
Normal file
3
reference/http/functions/persistenthandles.xml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
<!-- $Revision: 1.1 $ -->
|
||||
&reference.http.functions.persistenthandles.http-persistent-handles-count;
|
||||
&reference.http.functions.persistenthandles.http-persistent-handles-ident;
|
||||
|
|
@ -0,0 +1,150 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<refentry id="function.http-persistent-handles-count">
|
||||
<refnamediv>
|
||||
<refname>http_persistent_handles_count</refname>
|
||||
<refpurpose>Stat persistent handles</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>object</type><methodname>http_persistent_handles_count</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
List statistics about persistent handles usage.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns persistent handles statistics as stdClass object on success or &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<!-- Use when ERRORS exist
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
When does this function throw E_* level errors, or exceptions?
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
|
||||
<!-- Use when a CHANGELOG exists
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>Enter the PHP version of change here</entry>
|
||||
<entry>Description of change</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>A <function>http_persistent_handles_count</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
print_r(http_persistent_handles_count());
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
stdClass Object
|
||||
(
|
||||
[http_request] => Array
|
||||
(
|
||||
[GLOBAL] => Array
|
||||
(
|
||||
[used] => 0
|
||||
[free] => 1
|
||||
)
|
||||
|
||||
)
|
||||
|
||||
[http_request_datashare] => Array
|
||||
(
|
||||
[GLOBAL] => Array
|
||||
(
|
||||
[used] => 1
|
||||
[free] => 0
|
||||
)
|
||||
|
||||
)
|
||||
|
||||
[http_request_pool] => Array
|
||||
(
|
||||
)
|
||||
|
||||
)
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<!-- Use when adding See Also links
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function></function></member>
|
||||
<member>Or <link linkend="somethingelse">something else</link></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:"../../../../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
|
||||
-->
|
||||
|
|
@ -0,0 +1,160 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<refentry id="function.http-persistent-handles-ident">
|
||||
<refnamediv>
|
||||
<refname>http_persistent_handles_ident</refname>
|
||||
<refpurpose>Get/set ident of persistent handles</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>http_persistent_handles_ident</methodname>
|
||||
<methodparam><type>string</type><parameter>ident</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Query or define the ident of persistent handles.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>ident</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
the identification string
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the prior ident as string on success or &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<!-- Use when ERRORS exist
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
When does this function throw E_* level errors, or exceptions?
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
|
||||
<!-- Use when a CHANGELOG exists
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>Enter the PHP version of change here</entry>
|
||||
<entry>Description of change</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
</refsect1>
|
||||
-->
|
||||
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>A <function>http_persistent_handles_ident</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
print_r(http_persistent_handles_ident());
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
stdClass Object
|
||||
(
|
||||
[http_request] => Array
|
||||
(
|
||||
[GLOBAL] => Array
|
||||
(
|
||||
[used] => 0
|
||||
[free] => 1
|
||||
)
|
||||
|
||||
)
|
||||
|
||||
[http_request_datashare] => Array
|
||||
(
|
||||
[GLOBAL] => Array
|
||||
(
|
||||
[used] => 1
|
||||
[free] => 0
|
||||
)
|
||||
|
||||
)
|
||||
|
||||
[http_request_pool] => Array
|
||||
(
|
||||
)
|
||||
|
||||
)
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<!-- Use when adding See Also links
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function></function></member>
|
||||
<member>Or <link linkend="somethingelse">something else</link></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:"../../../../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
|
||||
-->
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.19 $ -->
|
||||
<!-- $Revision: 1.20 $ -->
|
||||
<!-- Purpose: basic.php -->
|
||||
<!-- Membership: pecl -->
|
||||
|
||||
|
|
@ -157,6 +157,13 @@
|
|||
<member><function>http_build_url</function></member>
|
||||
</simplelist>
|
||||
</section>
|
||||
<section>
|
||||
<title>Persistent Handles</title>
|
||||
<simplelist>
|
||||
<member><function>http_persistent_handles_count</function></member>
|
||||
<member><function>http_persistent_handles_ident</function></member>
|
||||
</simplelist>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</partintro>
|
||||
|
|
|
|||
Loading…
Reference in a new issue