php-doc-en/reference/stream/functions/stream-set-blocking.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- 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>
  <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 0, the given stream
   will be switched to non-blocking mode, and if 1, 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>
   &return.success;
  </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>
  <para>
   See also
   <function>stream_select</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
-->