mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
b5e5847fa9
Patch provided by mattficken. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344556 c90b9560-bf6c-de11-be94-00142212c4b1
105 lines
2.9 KiB
XML
105 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/network.xml, last change in rev 1.2 -->
|
|
<refentry xml:id="function.stream-set-blocking" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>stream_set_blocking</refname>
|
|
<refpurpose>Set blocking/non-blocking mode on a stream</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>stream_set_blocking</methodname>
|
|
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
|
<methodparam><type>bool</type><parameter>mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets blocking or non-blocking mode on a <parameter>stream</parameter>.
|
|
</para>
|
|
<para>
|
|
This function works for any stream that supports non-blocking mode
|
|
(currently, regular files and socket streams).
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>stream</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The stream.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<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>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<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>
|
|
<note>
|
|
<para>On Windows, this has no affect on local files. Non-blocking IO for local files is not supported on Windows.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>stream_select</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
|
|
-->
|