cvs: phpdoc /en/reference/stream/functions stream-get-contents.xml stream-socket-recvfrom.xml stream-socket-sendto.xml

pollita Sun Nov 30 13:47:42 2003 EDT Added files: /phpdoc/en/reference/stream/functions stream-get-contents.xml stream-socket-sendto.xml stream-socket-recvfrom.xml Log: New Functions

Index: phpdoc/en/reference/stream/functions/stream-get-contents.xml +++ phpdoc/en/reference/stream/functions/stream-get-contents.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-get-contents"> <refnamediv> <refname>stream_get_contents</refname> <refpurpose>Reads remainder of a stream into a string</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>stream_get_contents</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>maxlength</parameter></methodparam> </methodsynopsis> <para> Identical to <function>file_get_contents</function>, except that <function>stream_get_contents</function> operates on an already open file resource and returns the remainiing contents, up to <parameter>maxlength</parameter> bytes, in a string. </para> &note.bin-safe; &tip.fopen-wrapper; <simpara> See also: <function>fgets</function>, <function>fread</function>, and <function>fpassthru</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 --> Index: phpdoc/en/reference/stream/functions/stream-socket-sendto.xml +++ phpdoc/en/reference/stream/functions/stream-socket-sendto.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-sendto"> <refnamediv> <refname>stream_socket_sendto</refname> <refpurpose>Sends a message to a socket, whether it is connected or not </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>stream_socket_sendto</methodname> <methodparam><type>resource</type><parameter>socket</parameter></methodparam> <methodparam><type>string</type><parameter>data</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>address</parameter></methodparam> </methodsynopsis> <para> The function <function>stream_socket_sendto</function> sends the data specified by <parameter>data</parameter> through the socket specified by <parameter>socket</parameter>. The address specified when the socket stream was created will be used unless an alternate address is specifed in <parameter>address</parameter>. </para> <para> The value of <parameter>flags</parameter> can be any combination of the following: <table> <title>possible values for <parameter>flags</parameter></title> <tgroup cols="2"> <tbody> <row> <entry><constant>STREAM_OOB</constant></entry> <entry> Process OOB (out-of-band) data. </entry> </row> </tbody> </tgroup> </table> </para> <example> <title><function>stream_socket_sendto</function> Example</title> <programlisting role="php"> <![CDATA[ <?php /* Open a socket to port 1234 on localhost */ $socket = stream_socket_client('tcp://127.0.0.1:1234'); /* Send ordinary data via ordinary channels. */ fwrite($socket, "Normal data transmit."); /* Send more data out of band. */ stream_socket_sendto($socket, "Out of Band data.", STREAM_OOB); /* Close it up */ fclose($socket); ?> ]]> </programlisting> </example> <para> See also <function>stream_socket_recvfrom</function>, <function>stream_socket_client</function>, and <function>stream_socket_server</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 --> Index: phpdoc/en/reference/stream/functions/stream-socket-recvfrom.xml +++ phpdoc/en/reference/stream/functions/stream-socket-recvfrom.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-recvfrom"> <refnamediv> <refname>stream_socket_recvfrom</refname> <refpurpose>Receives data from a socket, connected or not </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>stream_socket_recvfrom</methodname> <methodparam><type>resource</type><parameter>socket</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>&amp;address</parameter></methodparam> </methodsynopsis> <para> The function <function>stream_socket_recvfrom</function> accepts data from a remote socket up to <parameter>length</parameter> bytes. If <parameter>address</parameter> is provided it will be populated with the addres of the remote socket. </para> <para> The value of <parameter>flags</parameter> can be any combination of the following: <table> <title>possible values for <parameter>flags</parameter></title> <tgroup cols="2"> <tbody> <row> <entry><constant>STREAM_OOB</constant></entry> <entry> Process OOB (out-of-band) data. </entry> </row> <row> <entry><constant>STREAM_PEEK</constant></entry> <entry> Retrieve data from the socket, but do not consume the buffer. Subsequent calls to <function>fread</function> or <function>stream_socket_recvfrom</function> will see the same data. </entry> </row> </tbody> </tgroup> </table> </para> <example> <title><function>stream_socket_sendto</function> Example</title> <programlisting role="php"> <![CDATA[ <?php /* Open a server socket to port 1234 on localhost */ $server = stream_socket_server('tcp://127.0.0.1:1234'); /* Accept a connection */ $socket = stream_socket_accept($server); /* Grab a packet (1500 is a typical MTU size) of OOB data */ echo "Received Out-Of-Band: '" . stream_socket_recvfrom($socket, 1500, STREAM_OOB) . "'\n"; /* Take a peek at the normal in-band data, but don't comsume it. */ echo "Data: '" . stream_socket_recvfrom($socket, 1500, STREAM_PEEK) . "'\n"; /* Get the exact same packet again, but remove it from the buffer this time. */ echo "Data: '" . stream_socket_recvfrom($socket, 1500) . "'\n"; /* Close it up */ fclose($socket); fclose($server); ?> ]]> </programlisting> </example> <para> See also <function>stream_socket_sendto</function>, <function>stream_socket_client</function>, and <function>stream_socket_server</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 -->