archived-doc-pt-br/reference/sem/functions/msg-send.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-send">
 <refnamediv>
  <refname>msg_send</refname>
  <refpurpose>Envia uma mensagem para uma fila de mensagens</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>msg_send</methodname>
   <methodparam><type>SysvMessageQueue</type><parameter>queue</parameter></methodparam>
   <methodparam><type>int</type><parameter>message_type</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>int</type><type>float</type><type>bool</type></type><parameter>message</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>serialize</parameter><initializer>&true;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>blocking</parameter><initializer>&true;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter role="reference">error_code</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   <function>msg_send</function> envia a mensagem <parameter>message</parameter> do tipo
   <parameter>message_type</parameter> (que PRECISA ser maior que 0) para
   a fila de mensagens especificada por <parameter>queue</parameter>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>queue</parameter></term>
    <listitem>
     <simpara>
      A fila de mensagens.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>message_type</parameter></term>
    <listitem>
     <simpara>
      O tipo da mensagem (PRECISA ser maior que 0).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>message</parameter></term>
    <listitem>
     <simpara>
      O corpo da mensagem.
     </simpara>
     <note>
      <simpara>
       Se <parameter>serialize</parameter> definido como &false; for fornecido,
       PRECISA ser do tipo: <type>string</type>, <type>int</type>, <type>float</type>
       ou <type>bool</type>. Caso contrário, um aviso será emitido.
      </simpara>
     </note>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>serialize</parameter></term>
    <listitem>
     <simpara>
      O parâmetro opcional <parameter>serialize</parameter> controla como a
      mensagem do parâmetro <parameter>message</parameter> é enviada. <parameter>serialize</parameter>
      tem como padrão &true;, o que significa que a mensagem em <parameter>message</parameter> é
      serializada usando o mesmo mecanismo do módulo de sessão antes de ser
      enviada para a fila. Isso permite que arrays e objetos complexos sejam enviados para
      outros scripts PHP ou, se estiver sendo usado o serializador WDDX, para qualquer cliente
      compatível com WDDX.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>blocking</parameter></term>
    <listitem>
     <simpara>
      Se a mensagem for muito grande para caber na fila, o script aguardará
      até que outro processo leia as mensagens da fila e libere espaço
      suficiente para que a mensagem seja enviada.
      Isso é chamado de bloqueio; pode-se evitar o bloqueio definindo o
      parâmetro opcional <parameter>blocking</parameter> como &false;, nesse
      caso, <function>msg_send</function> retornará imediatamente &false; se a
      mensagem for muito grande para a fila, e definirá o
      <parameter>error_code</parameter> opcional como <constant>MSG_EAGAIN</constant>,
      indicando que deve-se tentar enviar a mensagem novamente um pouco
      mais tarde.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>error_code</parameter></term>
    <listitem>
     <simpara>
      Se a função falhar, o código de erro opcional será definido como o valor da variável errno do sistema.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   &return.success;
  </simpara>
  <simpara>
   Após a conclusão bem-sucedida, a estrutura de dados da fila de mensagens é atualizada da
   seguinte forma: <parameter>msg_lspid</parameter> é definido como o ID do
   processo do processo chamador, <parameter>msg_qnum</parameter> é incrementado em 1 e
   <parameter>msg_stime</parameter> é definido como a hora atual.
  </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_stat_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
-->