nicobn Thu Aug 16 18:24:24 2007 UTC
Modified files:
/phpdoc/en/reference/sockets/functions socket-connect.xml
Log:
- Clarified method synopsis
- Port needs to be specified in socket is AF_INET or AF_INET6
- IP is quad-dot notation if AF_INET or IPV6 notation if AF_INET6
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-connect.xml?r1=1.10&r2=1.11&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-connect.xml
diff -u phpdoc/en/reference/sockets/functions/socket-connect.xml:1.10
phpdoc/en/reference/sockets/functions/socket-connect.xml:1.11
--- phpdoc/en/reference/sockets/functions/socket-connect.xml:1.10 Wed Jun
20 22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-connect.xml Thu Aug 16
18:24:24 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
<refentry xmlns="http://docbook.org/ns/docbook";
xml:id="function.socket-connect">
<refnamediv>
<refname>socket_connect</refname>
@@ -15,7 +15,7 @@
<methodparam
choice="opt"><type>int</type><parameter>port</parameter></methodparam>
</methodsynopsis>
<para>
- Initiates a connection using the socket resource
+ Initiate a connection to <parameter>address</parameter> using the socket
resource
<parameter>socket</parameter>, which must be a valid socket
resource created with <function>socket_create</function>.
</para>
@@ -36,10 +36,12 @@
<term><parameter>address</parameter></term>
<listitem>
<para>
- The <parameter>address</parameter> parameter is either an IP address
- in dotted-quad notation (e.g. <literal>127.0.0.1</literal>), if the
- socket is of the <constant>AF_INET</constant> family; or the pathname
- of a Unix domain socket, if the socket family is
+ The <parameter>address</parameter> parameter is either an IPv4 address
+ in dotted-quad notation (e.g. <literal>127.0.0.1</literal>) if
+ <parameter>socket</parameter> is <constant>AF_INET</constant>, a valid
+ IPv6 address (e.g. <literal>::1</literal>) if IPv6 support is enabled
and
+ <parameter>socket</parameter> is <constant>AF_INET6</constant>
+ or the pathname of a Unix domain socket, if the socket family is
<constant>AF_UNIX</constant>.
</para>
</listitem>
@@ -48,9 +50,10 @@
<term><parameter>port</parameter></term>
<listitem>
<para>
- The <parameter>port</parameter> parameter is only used when connecting
- to an <constant>AF_INET</constant> socket, and designates the port on
- the remote host to which a connection should be made.
+ The <parameter>port</parameter> parameter is only used and is mandatory
+ when connecting to an <constant>AF_INET</constant> or an
+ <constant>AF_INET6</constant> socket, and designates
+ the port on the remote host to which a connection should be made.
</para>
</listitem>
</varlistentry>
