Files
archived-doc-pt-br/reference/sockets/functions/socket-connect.xml
2024-09-17 14:35:37 -03:00

139 lines
4.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e58f2f64751dc0d9e0da953bac8003469f923af0 Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.socket-connect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>socket_connect</refname>
<refpurpose>Inicia uma conexão em um soquete</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>socket_connect</methodname>
<methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
<methodparam><type>string</type><parameter>address</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>port</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Inicia uma conexão ao endereço informado em <parameter>address</parameter> usando a instância de <classname>Socket</classname>
fornecida em <parameter>socket</parameter>, que precisa ser uma instância <classname>Socket</classname>
criada com <function>socket_create</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>socket</parameter></term>
<listitem>
<para>
Uma instância de <classname>Socket</classname> criada com
<function>socket_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>address</parameter></term>
<listitem>
<para>
O parâmetro <parameter>address</parameter> pode ser um endereço IPv4
na notação de quatro inteiros separados por pontos (ex.: <literal>127.0.0.1</literal>) se
<parameter>socket</parameter> for <constant>AF_INET</constant>, um endereço
válido IPv6 (ex.: <literal>::1</literal>) se o suporte a IPv6 estiver habilitado e
<parameter>socket</parameter> for <constant>AF_INET6</constant>
ou o caminho para um soquete de domínio Unix, se a família de soquete for
<constant>AF_UNIX</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
O parâmetro <parameter>port</parameter> é usado somente
na conexão a um soquete <constant>AF_INET</constant> ou
<constant>AF_INET6</constant> (nesses casos é mandatório), e designa
a porta no servidor remoto à qual uma conexão deve ser realizada.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; O código de erro pode ser recuperado com
<function>socket_last_error</function>. Este código pode ser passado a
<function>socket_strerror</function> para obter uma explicação textual do
erro.
</para>
<note>
<para>
Se o soquete for não bloqueante, esta função retorna &false; com um
erro <literal>Operation now in progress</literal> (operação agora em andamento).
</para>
</note>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&sockets.changelog.socket-param;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>port</parameter> agora pode ser nulo.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->