Files
leonardolara 4f8b0072ed update rev tag
2024-09-17 14:35:37 -03:00

156 lines
4.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9 Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.socket-send" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>socket_send</refname>
<refpurpose>Envia dados para um soquete conectado</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>socket_send</methodname>
<methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
A função <function>socket_send</function> envia o número
de bytes definido em <parameter>length</parameter> para o soquete
<parameter>socket</parameter> a partir dos dados em <parameter>data</parameter>.
</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>
ou <function>socket_accept</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Um buffer contendo os dados que serão enviados ao servidor remoto.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
O número de bytes que serão enviados ao servidor remoto a partir de
<parameter>data</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
O valor de <parameter>flags</parameter> pode ser qualquer combinação das
opções a seguir, combinadas com o operador binário OR
(<literal>|</literal>).
<table>
<title>Valores possíveis para <parameter>flags</parameter></title>
<tgroup cols="2">
<tbody>
<row>
<entry><constant>MSG_OOB</constant></entry>
<entry>
Envia dados OOB (fora-de-banda).
</entry>
</row>
<row>
<entry><constant>MSG_EOR</constant></entry>
<entry>
Indica uma marca de registro. Os dados enviados completam o registro.
</entry>
</row>
<row>
<entry><constant>MSG_EOF</constant></entry>
<entry>
Fecha o lado do remetente do soquete e inclui uma notificação
apropriada no final dos dados enviados. Os dados enviados
completam a transação.
</entry>
</row>
<row>
<entry><constant>MSG_DONTROUTE</constant></entry>
<entry>
Ignora o roteamento, usa interface direta.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>socket_send</function> retorna o número de bytes enviados ou &false; em caso de erro.
</para>
</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;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>socket_sendto</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
-->