From d64960f494aa37710f086e43861aa042468b0426 Mon Sep 17 00:00:00 2001
From: Wez Furlong <wez@php.net>
Date: Sat, 13 Apr 2002 02:10:24 +0000
Subject: [PATCH] Correct documentation of socket_get_status.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78010 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/network.xml | 21 ++++++++++-----------
 functions/sockets.xml | 35 +++++++++++++----------------------
 2 files changed, 23 insertions(+), 33 deletions(-)

diff --git a/functions/network.xml b/functions/network.xml
index b35973b54a..70304e406c 100644
--- a/functions/network.xml
+++ b/functions/network.xml
@@ -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 @@ echo $out;
    <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 @@ echo $out;
      </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>
diff --git a/functions/sockets.xml b/functions/sockets.xml
index 2e6c36f82b..42d01af2b1 100644
--- a/functions/sockets.xml
+++ b/functions/sockets.xml
@@ -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 @@ echo "OK.\n\n";
      <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 @@ echo "OK.\n\n";
      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 @@ echo "OK.\n\n";
     </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 @@ echo "OK.\n\n";
      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 @@ echo "OK.\n\n";
      <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 @@ echo "OK.\n\n";
      <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 @@ echo "OK.\n\n";
      <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 @@ if (($ret = socket_bind ($socket, '127.0.0.1', 80)) < 0) {
      <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 @@ if (($ret = socket_bind ($socket, '127.0.0.1', 80)) < 0) {
      <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>