heres a small diff for the socket_send documentation for someone to commit.

Pollita already commited by socket_shutdown docs, I'm working on quite a few others, will have socket_sendmsg and socket_sendto done pretty quickly, they're pretty much the same as this.

Will consider asking for phpdoc karma if my DocBook skills are upto scratch (thats upto you to judge!) - do I ask here of do I need to ask from the php website as with my pear karma?

- Davey

Index: socket-send.xml
===================================================================
RCS file: /repository/phpdoc/en/reference/sockets/functions/socket-send.xml,v
retrieving revision 1.2
diff -u -r1.2 socket-send.xml
--- socket-send.xml 17 Apr 2002 06:44:10 -0000 1.2
+++ socket-send.xml 28 May 2003 20:34:03 -0000
@@ -10,14 +10,74 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>socket_send</methodname>
- <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
- <methodparam><type>string</type><parameter>buf</parameter></methodparam>
- <methodparam><type>int</type><parameter>len</parameter></methodparam>
- <methodparam><type>int</type><parameter>flags</parameter></methodparam>
+ <methodparam>
+ <type>resource</type>
+ <parameter>socket</parameter>
+ </methodparam>
+ <methodparam>
+ <type>string</type>
+ <parameter>buf</parameter>
+ </methodparam>
+ <methodparam>
+ <type>int</type>
+ <parameter>len</parameter>
+ </methodparam>
+ <methodparam>
+ <type>int</type>
+ <parameter>flags</parameter>
+ </methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
- &warn.undocumented.func;
+ The function <function>socket_send</function> sends to
+ <parameter>len</parameter> bytes to the socket
+ <parameter>socket</parameter> from <parameter>buf</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 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>
+ <para>
+ See also
+ <function>socket_sendmsg</function> and
+ <function>socket_sendto</function>.
</para>
</refsect1>
</refentry>



-- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php



Reply via email to