wez Fri Apr 12 22:10:24 2002 EDT
Modified files:
/phpdoc/en/functions network.xml sockets.xml
Log:
Correct documentation of socket_get_status.
Index: phpdoc/en/functions/network.xml
diff -u phpdoc/en/functions/network.xml:1.61 phpdoc/en/functions/network.xml:1.62
--- phpdoc/en/functions/network.xml:1.61 Wed Apr 10 03:33:17 2002
+++ phpdoc/en/functions/network.xml Fri Apr 12 22:10:24 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.61 $ -->
+<!-- $Revision: 1.62 $ -->
<reference id="ref.network">
<title>Network Functions</title>
<titleabbrev>Network</titleabbrev>
@@ -728,18 +728,22 @@
<refnamediv>
<refname>socket_get_status</refname>
<refpurpose>
- Returns information about existing socket resource
+ Returns information about an existing socket stream
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>socket_get_status</methodname>
-
<methodparam><type>resource</type><parameter>socket_get_status</parameter></methodparam>
+
+<methodparam><type>resource</type><parameter>socketstream</parameter></methodparam>
</methodsynopsis>
<para>
- Returns information about an existing socket resource. Currently
- returns four entries in the result array:
+ Returns information about an existing socket stream. This function only
+ works on sockets created by <function>fsockopen</function>,
+ <function>pfsockopen</function> or network sockets returned by
+ <function>fopen</function> when opening URLs. It does NOT work
+ with sockets from the <link linkend="ref.sockets">Socket extension</link>.
+ Currently returns four entries in the result array:
</para>
<itemizedlist>
<listitem>
@@ -766,12 +770,7 @@
</listitem>
</itemizedlist>
<para>
- See also: <function>socket_accept</function>,
- <function>socket_bind</function>,
- <function>socket_connect</function>,
- <function>socket_listen</function>,
- <function>socket_strerror</function>, and the
- <link linkend="ref.sockets">Socket extension</link>.
+ See also: <link linkend="ref.sockets">Socket extension</link>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/functions/sockets.xml
diff -u phpdoc/en/functions/sockets.xml:1.36 phpdoc/en/functions/sockets.xml:1.37
--- phpdoc/en/functions/sockets.xml:1.36 Wed Apr 10 03:41:41 2002
+++ phpdoc/en/functions/sockets.xml Fri Apr 12 22:10:24 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.36 $ -->
+<!-- $Revision: 1.37 $ -->
<reference id="ref.sockets">
<title>Socket functions</title>
<titleabbrev>Sockets</titleabbrev>
@@ -218,8 +218,7 @@
<function>socket_bind</function>,
<function>socket_connect</function>,
<function>socket_listen</function>,
- <function>socket_create</function>,
- <function>socket_get_status</function>, and
+ <function>socket_create</function>, and
<function>socket_strerror</function>.
</para>
</refsect1>
@@ -268,8 +267,7 @@
See also
<function>socket_connect</function>,
<function>socket_listen</function>,
- <function>socket_create</function>,
- <function>socket_get_status</function>, and
+ <function>socket_create</function>, and
<function>socket_strerror</function>.
</para>
</refsect1>
@@ -305,8 +303,7 @@
</para>
<para>
See also <function>socket_bind</function>, <function>socket_listen</function>,
- <function>socket_create</function>,
- <function>socket_get_status</function>, and
+ <function>socket_create</function>, and
<function>socket_strerror</function>.
</para>
</refsect1>
@@ -354,8 +351,7 @@
See also
<function>socket_bind</function>,
<function>socket_listen</function>,
- <function>socket_create</function>,
- <function>socket_get_status</function>, and
+ <function>socket_create</function>, and
<function>socket_strerror</function>.
</para>
</refsect1>
@@ -397,8 +393,7 @@
<function>socket_accept</function>,
<function>socket_bind</function>,
<function>socket_connect</function>,
- <function>socket_create</function>,
- <function>socket_get_status</function>, and
+ <function>socket_create</function>, and
<function>socket_strerror</function>.
</para>
</refsect1>
@@ -448,8 +443,7 @@
<function>socket_bind</function>,
<function>socket_connect</function>,
<function>socket_listen</function>,
- <function>socket_strerror</function>,
- <function>socket_get_status</function> and
+ <function>socket_strerror</function>, and
<function>socket_write</function>.
</para>
</refsect1>
@@ -505,9 +499,8 @@
<function>socket_accept</function>,
<function>socket_bind</function>,
<function>socket_connect</function>,
- <function>socket_listen</function>,
- <function>socket_strerror</function>, and
- <function>socket_get_status</function>.
+ <function>socket_listen</function>, and
+ <function>socket_strerror</function>.
</para>
</refsect1>
</refentry>
@@ -564,9 +557,8 @@
<function>socket_accept</function>,
<function>socket_bind</function>,
<function>socket_connect</function>,
- <function>socket_listen</function>,
- <function>socket_create</function>, and
- <function>socket_get_status</function>.
+ <function>socket_listen</function>, and
+ <function>socket_create</function>.
</para>
</refsect1>
</refentry>
@@ -597,9 +589,8 @@
<function>socket_bind</function>,
<function>socket_connect</function>,
<function>socket_listen</function>,
- <function>socket_read</function>,
- <function>socket_strerror</function>, and
- <function>socket_get_status</function>.
+ <function>socket_read</function>, and
+ <function>socket_strerror</function>.
</para>
</refsect1>
</refentry>
