archived-doc-pt-br/reference/sockets/functions/socket-write.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2ca1058473429d338de6eb773f268fc18a71d2f9 Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.socket-write" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_write</refname>
  <refpurpose>Escreve em um soquete</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>socket_write</methodname>
   <methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   A função <function>socket_write</function> escreve no soquete
   <parameter>socket</parameter> os dados informados em
   <parameter>data</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       O buffer para escrita.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       O parâmetro opcional <parameter>length</parameter> pode especificar um
       comprimento alternativo de bytes escritos no soquete. Se esse comprimento for
       maior que o comprimento de <parameter>data</parameter>,
       ele será truncado silenciosamente para o comprimento de <parameter>data</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retorna o número de bytes escritos com sucesso no soquete&return.falseforfailure;.
   O código de erro pode ser recuperado com
   <function>socket_last_error</function>. Este código pode ser passado para
   <function>socket_strerror</function> para obter uma explicação textual do
   erro.
  </para>
  <note>
   <para>
    É perfeitamente válido que <function>socket_write</function> retorne
    zero, o que significa que nenhum byte foi escrito. Certifique-se de usar o
    operador <literal>===</literal> para verificar &false; em caso de
    erro.
   </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>length</parameter> agora pode ser nulo.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>socket_write</function> não escreve necessariamente todos os bytes
    do parâmetro <parameter>data</parameter> fornecido. É válido que, dependendo dos buffers
    de rede etc., apenas uma certa quantidade de dados, mesmo que um byte, seja escrita,
    embora <parameter>data</parameter> seja maior.
    Um laço precisa ser usado para assegurar que o resto de <parameter>data</parameter>
    seja transmitido.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_accept</function></member>
    <member><function>socket_bind</function></member>
    <member><function>socket_connect</function></member>
    <member><function>socket_listen</function></member>
    <member><function>socket_read</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
-->