socket-write.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2ca1058473429d338de6eb773f268fc18a71d2f9 Maintainer: countzero Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.socket-write" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_write</refname>
  <refpurpose>Записывает в сокет</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>
   Функция <function>socket_write</function> записывает в сокет
   <parameter>socket</parameter> данные буфера
   <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>
       Буфер, который требуется записать.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Необязательный параметр <parameter>length</parameter> указывает
       альтернативное количество байтов, которое функция запишет в сокет.
       Функция без уведомления обрежет значение параметра до размера буфера <parameter>data</parameter>,
       если размер параметра окажется больше, чем длина данных в аргументе <parameter>data</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает количество байтов, которое успешно записала в сокет,&return.falseforfailure;.
   Код ошибки получают функцией <function>socket_last_error</function>.
   Код ошибки передают в функцию <function>socket_strerror</function>,
   чтобы получить текстовое описание ошибки.
  </para>
  <note>
   <para>
    Допускается возврат функцией <function>socket_write</function> нулевого значения,
    когда функция не записала ни одного байта. Значение, которое вернула функция,
    проверяют на равенство значению &false; оператором <literal>===</literal>.
   </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> теперь принимает значение null.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Функция <function>socket_write</function> не обязана записывать каждый байт
    буфера <parameter>data</parameter>.
    Это нормально, когда функция записывает только конкретное количество байтов,
    или даже один байт, хотя размер буфера <parameter>data</parameter> больше.
    На поведение функции влияют сетевые буферы и другие настройки.
    Передачу остальных данных аргумента <parameter>data</parameter> выполняют в цикле.
   </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
-->