socket-sendto.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9 Maintainer: countzero Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.socket-sendto" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_sendto</refname>
  <refpurpose>Отправляет сообщение в сокет, независимо от того, подсоединён он или нет</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>socket_sendto</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>
   <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>
   Функция <function>socket_sendto</function> отправляет
   <parameter>length</parameter> байт из буфера <parameter>buf</parameter>
   через сокет <parameter>socket</parameter> к порту
   <parameter>port</parameter> на адресе <parameter>address</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Экземпляр <classname>Socket</classname>, созданный при помощи <function>socket_create</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       Отправляемые данные будут взяты из буфера <parameter>data</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       <parameter>length</parameter> байт из буфера <parameter>data</parameter> будет
       отправлено.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Значение параметра <parameter>flags</parameter> может быть любой комбинацией
       следующих флагов, соединённых при помощи двоичного оператора OR
       (<literal>|</literal>).
       <table>
        <title>Возможные значения флагов <parameter>flags</parameter></title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>MSG_OOB</constant></entry>
           <entry>
            Отправить данные OOB (out-of-band, внеполосные).
           </entry>
          </row>
          <row>
           <entry><constant>MSG_EOR</constant></entry>
           <entry>
            Указывает на метку записи. Отправленные данные завершают запись.
           </entry>
          </row>
          <row>
           <entry><constant>MSG_EOF</constant></entry>
           <entry>
            Закрывает отправляющую сторону сокета и добавляет соответствующее
            оповещение об этом в конец отправляемых данных. Отправленные данные
            завершают транзакцию.
           </entry>
          </row>
          <row>
           <entry><constant>MSG_DONTROUTE</constant></entry>
           <entry>
             Не использовать маршрутизацию, использовать прямой интерфейс.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       IP-адрес удалённого хоста.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       <parameter>port</parameter> - это номер удалённого порта, по которому будут
       отправлены данные.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция <function>socket_sendto</function> возвращает количество байт, отправленных на
   удалённый хост, или &false;, если произошла ошибка.
  </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;
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>port</parameter> теперь допускает значение null.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>socket_sendto</function></title>
    <programlisting role="php">
<![CDATA[
<?php
    $sock = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);

    $msg = "Пинг !";
    $len = strlen($msg);

    socket_sendto($sock, $msg, $len, 0, '127.0.0.1', 1223);
    socket_close($sock);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_send</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
-->