cvs: phpdoc /en/reference/sockets/functions socket-sendto.xml

pollita Wed May 28 17:56:04 2003 EDT Modified files: /phpdoc/en/reference/sockets/functions socket-sendto.xml Log: Document socket_sendto() Patch by Dave Shafik (davey@php.net) Index: phpdoc/en/reference/sockets/functions/socket-sendto.xml diff -u phpdoc/en/reference/sockets/functions/socket-sendto.xml:1.2 phpdoc/en/reference/sockets/functions/socket-sendto.xml:1.3 --- phpdoc/en/reference/sockets/functions/socket-sendto.xml:1.2 Wed Apr 17 02:44:10 2002 +++ phpdoc/en/reference/sockets/functions/socket-sendto.xml Wed May 28 17:56:04 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/sockets.xml, last change in rev 1.27 --> <refentry id="function.socket-sendto"> <refnamediv> @@ -19,7 +19,75 @@ </methodsynopsis> &warn.experimental.func; <para> - &warn.undocumented.func; + The function <function>socket_sendto</function> sends + <parameter>len</parameter> bytes from <parameter>buf</parameter> + through the socket <parameter>socket</parameter> to the + <parameter>port</parameter> at the address <parameter>addr</parameter> + </para> + <para> + The value of <parameter>flags</parameter> can be one of the + following: + <table> + <title>possible values for <parameter>flags</parameter></title> + <tgroup cols="2"> + <tbody> + <row> + <entry><literal>0x1</literal></entry> + <entry> + Process OOB (out-of-band) data. + </entry> + </row> + <row> + <entry><literal>0x2</literal></entry> + <entry> + Peek at incoming message. + </entry> + </row> + <row> + <entry><literal>0x4</literal></entry> + <entry> + Bypass routing, use direct interface. + </entry> + </row> + <row> + <entry><literal>0x8</literal></entry> + <entry> + Data completes record. + </entry> + </row> + <row> + <entry><literal>0x100</literal></entry> + <entry> + Data completes transaction. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <example> + <title><function>socket_sendto</function> Example</title> + <programlisting role="php"> +<![CDATA[ +<?php + $sh = socket_create(AF_INET,SOCK_STREAM,SOL_TCP); + if (socket_bind($sh, '127.0.0.1', 4242)) { + echo "Socket bound correctly"; + } + $buf = 'Test Message'; + $len = strlen($buf); + if (socket_sendto($sh, $buf, $len, 0x100, '192.168.0.2', 4242) !== FALSE) { + echo "Message sent correctly"; + } + socket_close($sh); +?> +]]> + </programlisting> + </example> + <para> + See also + <function>socket_send</function> and + <function>socket_sendmsg</function>. </para> </refsect1> </refentry>