pollita Wed May 28 15:27:34 2003 EDT
Modified files:
/phpdoc/en/reference/sockets/functions socket-shutdown.xml
Log:
Document socket_shutdown().
Patch Submitted by Davey Shafik ([EMAIL PROTECTED]).
Index: phpdoc/en/reference/sockets/functions/socket-shutdown.xml
diff -u phpdoc/en/reference/sockets/functions/socket-shutdown.xml:1.2
phpdoc/en/reference/sockets/functions/socket-shutdown.xml:1.3
--- phpdoc/en/reference/sockets/functions/socket-shutdown.xml:1.2 Wed Apr 17
02:44:11 2002
+++ phpdoc/en/reference/sockets/functions/socket-shutdown.xml Wed May 28 15:27:34
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-shutdown">
<refnamediv>
@@ -15,7 +15,37 @@
</methodsynopsis>
&warn.experimental.func;
<para>
- &warn.undocumented.func;
+ The <function>socket_shutdown</function> function allows you to stop
+ incoming, outgoing or all data (the default) from being sent through the
+ <parameter>socket</parameter>
+ </para>
+ <para>
+ The value of <parameter>how</parameter> can be one of the following:
+ <table>
+ <title>possible values for <parameter>how</parameter></title>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry><literal>0</literal></entry>
+ <entry>
+ Shutdown socket reading
+ </entry>
+ </row>
+ <row>
+ <entry><literal>1</literal></entry>
+ <entry>
+ Shutdown socket writing
+ </entry>
+ </row>
+ <row>
+ <entry><literal>2</literal></entry>
+ <entry>
+ Shutdown socket reading and writing
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</para>
</refsect1>
</refentry>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
