php-doc-en/reference/sockets/functions/socket-connect.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.1 -->
  <refentry id="function.socket-connect">
   <refnamediv>
    <refname>socket_connect</refname>
    <refpurpose>Initiates a connection on a socket</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>socket_connect</methodname>
      <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
      <methodparam><type>string</type><parameter>address</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam>
     </methodsynopsis>
     &warn.experimental.func;
    <para>
     Initiates a connection using the socket resource
     <parameter>socket</parameter>, which must be a valid socket
     resource created with <function>socket_create</function>.
    </para>
    <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
     <constant>AF_UNIX</constant>.
    </para>
    <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.
    </para>
    <para>
     &return.success; The error code can be retrieved with
     <function>socket_last_error</function>. This code may be passed to
     <function>socket_strerror</function> to get a textual explanation of the
     error.
    </para>
    <para>
     See also 
     <function>socket_bind</function>,
     <function>socket_listen</function>,
     <function>socket_create</function>,
     <function>socket_last_error</function> and
     <function>socket_strerror</function>.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->