mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
58e026c057
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@301119 c90b9560-bf6c-de11-be94-00142212c4b1
121 lines
2.8 KiB
XML
121 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.feof">
|
|
<refnamediv>
|
|
<refname>feof</refname>
|
|
<refpurpose>Tests for end-of-file on a file pointer</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>feof</methodname>
|
|
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Tests for end-of-file on a file pointer.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>handle</parameter></term>
|
|
<listitem>
|
|
&fs.validfp.all;
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &true; if the file pointer is at EOF or an error occurs
|
|
(including socket timeout); otherwise returns &false;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<warning>
|
|
<para>
|
|
If a connection opened by <function>fsockopen</function> wasn't closed
|
|
by the server, <function>feof</function> will hang. To workaround this, see
|
|
below example:
|
|
<example>
|
|
<title>Handling timeouts with <function>feof</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
function safe_feof($fp, &$start = NULL) {
|
|
$start = microtime(true);
|
|
|
|
return feof($fp);
|
|
}
|
|
|
|
/* Assuming $fp is previously opened by fsockopen() */
|
|
|
|
$start = NULL;
|
|
$timeout = ini_get('default_socket_timeout');
|
|
|
|
while(!safe_feof($fp, $start) && (microtime(true) - $start) < $timeout)
|
|
{
|
|
/* Handle */
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</warning>
|
|
<warning>
|
|
<para>
|
|
If the passed file pointer is not valid you may get an infinite loop, because
|
|
<function>feof</function> fails to return &true;.
|
|
<example>
|
|
<title><function>feof</function> example with an invalid file pointer</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// if file can not be read or doesn't exist fopen function returns FALSE
|
|
$file = @fopen("no_such_file", "r");
|
|
|
|
// FALSE from fopen will issue warning and result in infinite loop here
|
|
while (!feof($file)) {
|
|
}
|
|
|
|
fclose($file);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</warning>
|
|
</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
|
|
-->
|