socket-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: seros Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-connect">
 <refnamediv>
  <refname>socket_connect</refname>
  <refpurpose>Inicia una conexión sobre un socket</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <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><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Inicia una conexión hacia <parameter>address</parameter> usando el recurso socket
   <parameter>socket</parameter>, el cual debe ser un recurso socket
   válido creado con <function>socket_create</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       El parámetro <parameter>address</parameter> es una dirección IPv4
       en notación decimal con puntos (p.ej. <literal>127.0.0.1</literal>) si
       <parameter>socket</parameter> es <constant>AF_INET</constant>, una dirección
       IPv6 válida (p.ej. <literal>::1</literal>) si está habilitado el soporte para IPv6 y 
       <parameter>socket</parameter> es <constant>AF_INET6</constant>
       o el nombre de ruta de un socket de dominio Unix, si la familia de sockets es
       <constant>AF_UNIX</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       El parámetro <parameter>port</parameter> sólo se usa y es obligatoria
       al conectarse a un socket <constant>AF_INET</constant> o a un
       socket <constant>AF_INET6</constant>, y desgina
       el puerto del host remoto al que debería de hacerse una conexión.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success; El código de error se puede recurperar con
   <function>socket_last_error</function>. Este código se puede pasar a
   <function>socket_strerror</function> para obtener una explicación textual del
   error.
  </para>
  <note>
   <para>
    Si el socket es de no-bloqueo, esta función devolverá &false; con un
    error <literal>Operation now in progress</literal> (La operación está en progreso).
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_bind</function></member>
    <member><function>socket_listen</function></member>
    <member><function>socket_create</function></member>
    <member><function>socket_last_error</function></member>
    <member><function>socket_strerror</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->