mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 02:18:56 +00:00
af6fdf16ab
This includes changelogs but also some paragraphs and notes which mention PHP 4. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347043 c90b9560-bf6c-de11-be94-00142212c4b1
146 lines
3.7 KiB
XML
146 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/network.xml, last change in rev 1.18 -->
|
|
<refentry xml:id="function.stream-set-timeout" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>stream_set_timeout</refname>
|
|
<refpurpose>Set timeout period on a stream</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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 choice="opt"><type>int</type><parameter>microseconds</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the timeout value on <parameter>stream</parameter>,
|
|
expressed in the sum of <parameter>seconds</parameter> and
|
|
<parameter>microseconds</parameter>.
|
|
</para>
|
|
<para>
|
|
When the stream times out, the 'timed_out' key of the array returned by
|
|
<function>stream_get_meta_data</function> is set to &true;, although no
|
|
error/warning is generated.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>stream</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The target stream.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>seconds</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The seconds part of the timeout to be set.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>microseconds</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The microseconds part of the timeout to be set.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<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 {
|
|
|
|
fwrite($fp, "GET / HTTP/1.0\r\n\r\n");
|
|
stream_set_timeout($fp, 2);
|
|
$res = fread($fp, 2000);
|
|
|
|
$info = stream_get_meta_data($fp);
|
|
fclose($fp);
|
|
|
|
if ($info['timed_out']) {
|
|
echo 'Connection timed out!';
|
|
} else {
|
|
echo $res;
|
|
}
|
|
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
This function doesn't work with advanced operations like
|
|
<function>stream_socket_recvfrom</function>, use
|
|
<function>stream_select</function> with timeout parameter instead.
|
|
</para>
|
|
</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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>fsockopen</function></member>
|
|
<member><function>fopen</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|