archived-doc-es/reference/sam/SAMConnection/receive.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0d604bbc9d3b741d53e7fac26f5b24c306751e9a Maintainer: regiemix Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id='samconnection.receive' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SAMConnection::receive</refname>
  <refpurpose>
   Recibir un mensaje de una cola o de una suscripción.
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>SAMMessage</type><methodname>SAMConnection::receive</methodname>
   <methodparam><type>string</type><parameter>target</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>properties</parameter></methodparam>
  </methodsynopsis>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>target</parameter></term>
     <listitem>
      <para>
       La identidad de la cola, asunto o suscripción de la que se recibe
       el mensaje.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>properties</parameter></term>
     <listitem>
      <para>
       Un array asociativo opcional de propiedades, que describen otros
       parámetros para controlar la operación de recepción.
       <informaltable>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Nombre de la propiedad</entry>
           <entry>Valores posibles</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>SAM_CORRELID</entry>
           <entry>
            Utilizado para solicitar la recepción de un mensaje, basado en
            el identificador de correlación del mensaje.
           </entry>
          </row>
          <row>
           <entry>SAM_MESSAGEID</entry>
           <entry>
            Utilizado para solicitar la recepción de un mensaje, basado en
            el identificador del mensaje.
           </entry>
          </row>
          <row>
           <entry>SAM_WAIT</entry>
           <entry>
            Tiempo límite en milisegundos para controlar el tiempo de espera
            de recepción del mensaje, antes de devolver un error
            si no hay ningún mensaje disponible en la cola o asunto. El
            valor por defecto es 0, que significa esperar indefinidamente y debe ser usado
            con precaución puesto que la petición esperará hasta el tiempo límite de ejecución del script PHP
            si ningún mensaje está disponible.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Este método devuelve un objeto SAMMessage o &false; en caso de error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Recepción de un mensaje de una cola</title>
    <programlisting role="php">
<![CDATA[
<?php
$msg = $conn->receive('queue://receive/test');

if (!$msg) {
  // The receive failed!
  echo "Receive failed ($conn->errno) $conn->error";
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Recepción de un mensaje de una cola con opciones</title>
    <para>
     En este ejemplo, la opción SAM_CORRELID se utiliza para especificar un
     identificador de correlación, que se utilizará para identificar el mensaje a recibir. También se especifica un tiempo límite de espera
     de 10 segundos.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$msg = $conn->receive('queue://receive/test', array(SAM_CORRELID => $token, SAM_WAIT => 10000));

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Recepción de un mensaje de una suscripción</title>
    <para>
     En este ejemplo se muestra cómo recibir un mensaje desde un identificador de suscripción.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$msg = $conn->receive($subscriptionName);

if (!$msg) {
  // La recepción falló!
  echo "Recepción fallida ($conn->errno) $conn->error";
}
?>
]]>
    </programlisting>
    <para>
     Observe que $subscriptionName es un identificador de suscripción devuelto desde una llamada  
     anterior a una suscripción.
    </para>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="samconnection.send" /></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
-->