socket-recvfrom.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: de9c65c91ff1710d8b2d2ec955caea0162679305 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.socket-recvfrom" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_recvfrom</refname>
  <refpurpose>Получает данные из сокета, независимо от того, подсоединён он или нет</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>socket_recvfrom</methodname>
   <methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">data</parameter></methodparam>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">address</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">port</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>socket_recvfrom</function> получает <parameter>length</parameter> байт
   данных в <parameter>data</parameter> из адреса <parameter>address</parameter> на порту
   <parameter>port</parameter> (если сокет не типа <constant>AF_UNIX</constant>)
   используя сокет <parameter>socket</parameter>. Функция
   <function>socket_recvfrom</function> может быть использована для извлечения данных
   как из подключённых, так и из не подключённых сокетов. Дополнительно, один или более флагов
   могут быть указаны для того, чтобы изменить поведение функции.
  </para>
  <para>
   Параметры <parameter>address</parameter> и <parameter>port</parameter> должны быть
   переданы по ссылке. Если сокет не ориентирован на соединение,
   <parameter>address</parameter> должен быть установлен как адрес интернет-протокола  удалённого
   хоста, либо как путь к сокету UNIX. Если сокет не ориентирован на соединение,
   <parameter>address</parameter> должен быть &null;. Дополнительно,
   <parameter>port</parameter> должен содержать порт удалённого хоста для не
   подключённых сокетов типа <constant>AF_INET</constant> и
   <constant>AF_INET6</constant>.
  </para>
  &note.bin-safe;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>socket</parameter> должен быть экземпляром <classname>Socket</classname>,
       предварительно созданным при помощи функции socket_create().
      </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> байт.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Значение параметра <parameter>flags</parameter> может быть любой комбинацией
       следующих флагов, объединённых при помощи двоичного оператора OR (<literal>|</literal>)
       operator.
      </para>

      <table>
       <title>Возможные значения для параметра <parameter>flags</parameter></title>
       <tgroup cols="2">
        <thead>
         <row>
          <entry>Флаг</entry>
          <entry>Описание</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry><constant>MSG_OOB</constant></entry>
          <entry>
           Обрабатывать внеполосные (out-of-band) данные.
          </entry>
         </row>
         <row>
          <entry><constant>MSG_PEEK</constant></entry>
          <entry>
           Получать данные из начала очереди, не удаляя их.
          </entry>
         </row>
         <row>
          <entry><constant>MSG_WAITALL</constant></entry>
          <entry>
           Блокировать выполнение скрипта до тех пор, пока как минимум <parameter>length</parameter>
           не будет получено.
           Однако, если будет получен сигнал или удалённый хост отсоединится, функция
           может возвратить меньше данных.
          </entry>
         </row>
         <row>
          <entry><constant>MSG_DONTWAIT</constant></entry>
          <entry>
           Если этот флаг установлен, функция возвратится даже если обычно она будет
           блокировать выполнение скрипта.
          </entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>address</parameter></term>
     <listitem>
      <para>
       Если сокет типа <constant>AF_UNIX</constant>,
       <parameter>address</parameter> - это путь к файлу. В ином случае, для
       неподсоединённых сокетов, параметр <parameter>address</parameter> - это IP-адрес,
       удалённого хоста, или &null;, если сокет ориентирован по соединение.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       Этот аргумент применим только к сокетам <constant>AF_INET</constant> и
       <constant>AF_INET6</constant>, и указывает удалённый порт,
       из которого будут получены данные. Если сокет ориентирован по соединение,
       <parameter>port</parameter> будет &null;.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>socket_recvfrom</function> возвращает количество полученных байт
   или &false;, если произошла ошибка. Фактический код ошибки может быть получен при помощи
   вызова функции <function>socket_last_error</function>. Этот код ошибки может быть
   передан функции <function>socket_strerror</function> для получения текстового описания
   ошибки.
  </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="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>socket_recvfrom</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
socket_bind($socket, '127.0.0.1', 1223);

$from = '';
$port = 0;
socket_recvfrom($socket, $buf, 12, 0, $from, $port);

echo "Получено $buf с удалённого адреса $from и удалённого порта $port" . PHP_EOL;
?>
]]>
    </programlisting>
    <para>
     Этот пример откроет UDP-сокет на порту 1223 по адресу 127.0.0.1
     и выведет максимум 12 символов, полученных с удалённого хоста.
    </para>
   </example>
  </para>
 </refsect1>

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