archived-doc-pt-br/reference/sem/functions/msg-stat-queue.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: fd2f14b2e44fbda6dd3f94a1d07f2bc9a7567aff Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.msg-stat-queue">
 <refnamediv>
  <refname>msg_stat_queue</refname>
  <refpurpose>Retorna informações da estrutura de dados da fila de mensagens</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>msg_stat_queue</methodname>
   <methodparam><type>SysvMessageQueue</type><parameter>queue</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   <function>msg_stat_queue</function> retorna os metadados da fila de mensagens
   para a fila de mensagens especificada por <parameter>queue</parameter>.
   Isso é útil, por exemplo, para determinar qual processo enviou a mensagem
   que acabou de receber.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>queue</parameter></term>
    <listitem>
     <simpara>
      A fila de mensagens.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Em caso de sucesso, o valor de retorno é um array cujas chaves e valores têm os seguintes
   significados:
   <table>
    <title>Array structure for msg_stat_queue</title>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry><literal>msg_perm.uid</literal></entry>
       <entry>
        O uid do proprietário da fila.
       </entry>
      </row>
      <row>
       <entry><literal>msg_perm.gid</literal></entry>
       <entry>
        O gid do proprietário da fila.
       </entry>
      </row>
      <row>
       <entry><literal>msg_perm.mode</literal></entry>
       <entry>
        O modo de acesso ao arquivo da fila.
       </entry>
      </row>
      <row>
       <entry><literal>msg_stime</literal></entry>
       <entry>
        O horário em que a última mensagem foi enviada para a fila.
       </entry>
      </row>
      <row>
       <entry><literal>msg_rtime</literal></entry>
       <entry>
        O horário em que a última mensagem foi recebida da fila.
       </entry>
      </row>
      <row>
       <entry><literal>msg_ctime</literal></entry>
       <entry>
        O horário em que a fila foi alterada pela última vez.
       </entry>
      </row>
      <row>
       <entry><literal>msg_qnum</literal></entry>
       <entry>
        O número de mensagens aguardando para serem lidas na fila.
       </entry>
      </row>
      <row>
       <entry><literal>msg_qbytes</literal></entry>
       <entry>
        O número máximo de bytes permitidos em uma fila de mensagens.
        No Linux, este valor pode ser lido e modificado via
        <filename>/proc/sys/kernel/msgmnb</filename>.
       </entry>
      </row>
      <row>
       <entry><literal>msg_lspid</literal></entry>
       <entry>
        O pid do processo que enviou a última mensagem para a fila.
       </entry>
      </row>
      <row>
       <entry><literal>msg_lrpid</literal></entry>
       <entry>
        O pid do processo que recebeu a última mensagem da fila.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
  <simpara>
   Retorna &false; em caso de falha.
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>queue</parameter> espera uma instância de <classname>SysvMessageQueue</classname>
       agora; anteriormente, um <type>resource</type> era esperado.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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