streams function name changes.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@97308 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Wez Furlong 2002-09-28 23:07:24 +00:00
parent 402a021a40
commit 059168665c
4 changed files with 89 additions and 51 deletions

View file

@ -1,54 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.set-file-buffer">
<refnamediv>
<refname>set_file_buffer</refname>
<refpurpose>Sets file buffering on the given file pointer</refpurpose>
<refpurpose>Alias of <function>stream_set_write_buffer</function></refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>set_file_buffer</methodname>
<methodparam><type>int</type><parameter>fp</parameter></methodparam>
<methodparam><type>int</type><parameter>buffer</parameter></methodparam>
</methodsynopsis>
<simpara>
Output using <function>fwrite</function> is normally buffered at
8K. This means that if there are two processes wanting to write
to the same output stream (a file), each is paused after 8K of
data to allow the other to write. <function>set_file_buffer</function>
sets the buffering for write operations on the given filepointer
<parameter>fp</parameter> to <parameter>buffer</parameter> bytes.
If <parameter>buffer</parameter> is 0 then write operations are
unbuffered. This ensures that all writes with
<function>fwrite</function> are completed before other processes
are allowed to write to that output stream.
</simpara>
<simpara>
The function returns 0 on success, or EOF if the request cannot
be honored.
</simpara>
<para>
The following example demonstrates how to use
<function>set_file_buffer</function> to create an unbuffered stream.
<example>
<title><function>set_file_buffer</function> example</title>
<programlisting role="php">
<![CDATA[
$fp=fopen($file, "w");
if($fp){
set_file_buffer($fp, 0);
fputs($fp, $output);
fclose($fp);
}
]]>
</programlisting>
</example>
</para>
<simpara>
See also <function>fopen</function>, <function>fwrite</function>.
This function is an alias of
<function>stream_set_write_buffer</function>.
</simpara>
</refsect1>
</refentry>

View file

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.file-get-meta-data">
<refentry id="function.stream-get-meta-data">
<refnamediv>
<refname>file_get_meta_data</refname>
<refname>stream_get_meta_data</refname>
<refpurpose>Retrieves header/meta data from streams/file pointers</refpurpose>
</refnamediv>
<refsect1>

View file

@ -1,20 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.141 -->
<refentry id="function.file-register-wrapper">
<refentry id="function.stream-register-wrapper">
<refnamediv>
<refname>file_register_wrapper</refname>
<refname>stream_register_wrapper</refname>
<refpurpose>Register a URL wrapper implemented as a PHP class</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>boolean</type><methodname>file_register_wrapper</methodname>
<type>boolean</type><methodname>stream_register_wrapper</methodname>
<methodparam><type>string</type><parameter>protocol</parameter></methodparam>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
</methodsynopsis>
<para>
<function>file_register_wrapper</function> allows you to implement
<function>stream_register_wrapper</function> allows you to implement
your own protocol handlers and streams for use with all the other
filesystem functions (such as <function>fopen</function>,
<function>fread</function> etc.).
@ -28,7 +28,7 @@
behaviour.
</para>
<para>
<function>file_register_wrapper</function> will return &false; if the
<function>stream_register_wrapper</function> will return &false; if the
<parameter>protocol</parameter> already has a handler.
</para>
@ -271,7 +271,7 @@ class VariableStream {
}
}
file_register_wrapper("var", "VariableStream")
stream_register_wrapper("var", "VariableStream")
or die("Failed to register protocol");
$myvar = "";

View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.stream-set-write-buffer">
<refnamediv>
<refname>stream_set_write_buffer</refname>
<refpurpose>Sets file buffering on the given stream</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>stream_set_write_buffer</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>int</type><parameter>buffer</parameter></methodparam>
</methodsynopsis>
<simpara>
Output using <function>fwrite</function> is normally buffered at
8K. This means that if there are two processes wanting to write
to the same output stream (a file), each is paused after 8K of
data to allow the other to write.
<function>stream_set_write_buffer</function>
sets the buffering for write operations on the given filepointer
<parameter>stream</parameter> to <parameter>buffer</parameter> bytes.
If <parameter>buffer</parameter> is 0 then write operations are
unbuffered. This ensures that all writes with
<function>fwrite</function> are completed before other processes
are allowed to write to that output stream.
</simpara>
<simpara>
The function returns 0 on success, or EOF if the request cannot
be honored.
</simpara>
<para>
The following example demonstrates how to use
<function>stream_set_write_buffer</function> to create an unbuffered stream.
<example>
<title><function>stream_set_write_buffer</function> example</title>
<programlisting role="php">
<![CDATA[
$fp = fopen($file, "w");
if ($fp) {
stream_set_write_buffer($fp, 0);
fputs($fp, $output);
fclose($fp);
}
]]>
</programlisting>
</example>
</para>
<simpara>
See also <function>fopen</function> and <function>fwrite</function>.
</simpara>
</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
-->