mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
More streams related changes.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@97309 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Wez Furlong
parent
059168665c
commit
f1242944c3
5 changed files with 150 additions and 60 deletions
60
reference/filesystem/functions/stream-set-blocking.xml
Normal file
60
reference/filesystem/functions/stream-set-blocking.xml
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/network.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.stream-set-blocking">
|
||||
<refnamediv>
|
||||
<refname>stream_set_blocking</refname>
|
||||
<refpurpose>Set blocking/non-blocking mode on a stream</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>stream_set_blocking</methodname>
|
||||
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
If <parameter>mode</parameter> is &false;, the given stream
|
||||
will be switched to non-blocking mode, and if &true;, it
|
||||
will be switched to blocking mode. This affects calls like
|
||||
<function>fgets</function> and <function>fread</function>
|
||||
that read from the stream. In non-blocking mode an
|
||||
<function>fgets</function> call will always return right away
|
||||
while in blocking mode it will wait for data to become available
|
||||
on the stream.
|
||||
</para>
|
||||
<para>
|
||||
This function was previously called as
|
||||
<function>set_socket_blocking</function> and later
|
||||
<function>socket_set_blocking</function> but this usage is deprecated.
|
||||
</para>
|
||||
<note>
|
||||
<simpara>
|
||||
Prior to PHP 4.3, this function only worked on socket based streams.
|
||||
Since PHP 4.3, this function works for any stream that supports
|
||||
non-blocking mode (currently, regular files and socket streams).
|
||||
</simpara>
|
||||
</note>
|
||||
</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
|
||||
-->
|
||||
81
reference/filesystem/functions/stream-set-timeout.xml
Normal file
81
reference/filesystem/functions/stream-set-timeout.xml
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/network.xml, last change in rev 1.18 -->
|
||||
<refentry id="function.stream-set-timeout">
|
||||
<refnamediv>
|
||||
<refname>stream_set_timeout</refname>
|
||||
<refpurpose>Set timeout period on a stream</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>stream_set_timeout</methodname>
|
||||
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>microseconds</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Sets the timeout value on <parameter>stream</parameter>,
|
||||
expressed in the sum of <parameter>seconds</parameter> and
|
||||
<parameter>microseconds</parameter>.
|
||||
<example>
|
||||
<title><function>stream_set_timeout</function> Example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$fp = fsockopen("www.example.com", 80);
|
||||
if(!$fp) {
|
||||
echo "Unable to open\n";
|
||||
} else {
|
||||
fputs($fp, "GET / HTTP/1.0\n\n");
|
||||
$start = time();
|
||||
socket_set_timeout($fp, 2);
|
||||
$res = fread($fp, 2000);
|
||||
var_dump(stream_get_meta_data($fp));
|
||||
fclose($fp);
|
||||
print $res;
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<note>
|
||||
<simpara>
|
||||
As of PHP 4.3, this function can (potentially) work on any kind of
|
||||
stream. In PHP 4.3, socket based streams are still the only kind
|
||||
supported in the PHP core, although streams from other extensions
|
||||
may support this function.
|
||||
</simpara>
|
||||
</note>
|
||||
<para>
|
||||
This function was previously called as
|
||||
<function>set_socket_timeout</function> and later
|
||||
<function>socket_set_timeout</function> but this usage is deprecated.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>fsockopen</function> and <function>fopen</function>.
|
||||
</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,17 +1,17 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/network.xml, last change in rev 1.24 -->
|
||||
<refentry id="function.socket-get-status">
|
||||
<refnamediv>
|
||||
<refname>socket_get_status</refname>
|
||||
<refpurpose>
|
||||
Alias of <function>file_get_meta_data</function>.
|
||||
Alias of <function>stream_get_meta_data</function>.
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
This function is an alias of <function>file_get_meta_data</function>.
|
||||
This function is an alias of <function>stream_get_meta_data</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,30 +1,15 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/network.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.socket-set-blocking">
|
||||
<refnamediv>
|
||||
<refname>socket_set_blocking</refname>
|
||||
<refpurpose>Set blocking/non-blocking mode on a socket</refpurpose>
|
||||
<refpurpose>Alias for <function>stream_set_blocking</function></refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>socket_set_blocking</methodname>
|
||||
<methodparam><type>resource</type><parameter>socket descriptor</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
If <parameter>mode</parameter> is &false;, the given socket
|
||||
descriptor will be switched to non-blocking mode, and if &true;, it
|
||||
will be switched to blocking mode. This affects calls like
|
||||
<function>fgets</function> that read from the socket. In
|
||||
non-blocking mode an <function>fgets</function> call will always
|
||||
return right away while in blocking mode it will wait for data to
|
||||
become available on the socket.
|
||||
</para>
|
||||
<para>
|
||||
This function was previously called as
|
||||
<function>set_socket_blocking</function> but this usage is deprecated.
|
||||
This function is an alias for <function>stream_set_blocking</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,51 +1,15 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/network.xml, last change in rev 1.18 -->
|
||||
<refentry id="function.socket-set-timeout">
|
||||
<refnamediv>
|
||||
<refname>socket_set_timeout</refname>
|
||||
<refpurpose>Set timeout period on a socket</refpurpose>
|
||||
<refpurpose>Alias for <function>stream_set_timeout</function></refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>socket_set_timeout</methodname>
|
||||
<methodparam><type>resource</type><parameter>socket descriptor</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>seconds</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>microseconds</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Sets the timeout value on <parameter>socket descriptor</parameter>,
|
||||
expressed in the sum of <parameter>seconds</parameter> and
|
||||
<parameter>microseconds</parameter>.
|
||||
<example>
|
||||
<title><function>socket_set_timeout</function> Example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$fp = fsockopen("www.example.com", 80);
|
||||
if(!$fp) {
|
||||
echo "Unable to open\n";
|
||||
} else {
|
||||
fputs($fp,"GET / HTTP/1.0\n\n");
|
||||
$start = time();
|
||||
socket_set_timeout($fp, 2);
|
||||
$res = fread($fp, 2000);
|
||||
var_dump(socket_get_status($fp));
|
||||
fclose($fp);
|
||||
print $res;
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
This function was previously called as
|
||||
<function>set_socket_timeout</function> but this usage is deprecated.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>fsockopen</function> and <function>fopen</function>.
|
||||
This is an alias for <function>stream_set_timeout</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
Loading…
Reference in a new issue