msg-get-queue.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f7e33278a909d7f7bf491f77cb10c93581091736 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.msg-get-queue" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>msg_get_queue</refname>
  <refpurpose>Создаёт или подключает к очереди сообщений</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>SysvMessageQueue</type><type>false</type></type><methodname>msg_get_queue</methodname>
   <methodparam><type>int</type><parameter>key</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>permissions</parameter><initializer>0666</initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>msg_get_queue</function> возвращает идентификатор, который используется для
   доступа к очереди сообщений System V с указанным ключом <parameter>key</parameter>.
   Первый вызов создаёт очередь сообщений с необязательными правами <parameter>permissions</parameter>.
   Второй и последующие вызовы функции <function>msg_get_queue</function> для того же <parameter>key</parameter>
   будут возвращать другие идентификаторы, однако все они будут ссылаться на одну и ту же
   очередь сообщений.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Числовой идентификатор очереди сообщений.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>permissions</parameter></term>
     <listitem>
      <para>
       Права доступа к очереди. По умолчанию 0666. Если очередь сообщений уже существует,
       параметр <parameter>permissions</parameter> игнорируется.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает экземпляр класса <classname>SysvMessageQueue</classname>,
   который может быть использован для доступа к очереди
   сообщений System V&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        В случае успешного выполнения функция теперь возвращает экземпляр класса <classname>SysvMessageQueue</classname>;
        раньше возвращался ресурс (<type>resource</type>).
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>msg_remove_queue</function></member>
    <member><function>msg_receive</function></member>
    <member><function>msg_send</function></member>
    <member><function>msg_stat_queue</function></member>
    <member><function>msg_set_queue</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
-->