<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sem.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.msg-receive.php',
    1 => 'msg_receive',
    2 => 'Recibe un mensaje desde una cola de mensajes',
  ),
  'up' => 
  array (
    0 => 'ref.sem.php',
    1 => 'Funciones de Sem&aacute;foro',
  ),
  'prev' => 
  array (
    0 => 'function.msg-queue-exists.php',
    1 => 'msg_queue_exists',
  ),
  'next' => 
  array (
    0 => 'function.msg-remove-queue.php',
    1 => 'msg_remove_queue',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/sem/functions/msg-receive.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.msg-receive" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">msg_receive</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.3.0, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">msg_receive</span> &mdash; <span class="dc-title">Recibe un mensaje desde una cola de mensajes</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.msg-receive-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>msg_receive</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.sysvmessagequeue.php" class="type SysvMessageQueue">SysvMessageQueue</a></span> <code class="parameter">$queue</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$desired_message_type</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter reference">&$received_message_type</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$max_message_size</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter reference">&$message</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$unserialize</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter reference">&$error_code</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   <span class="function"><strong>msg_receive()</strong></span> recibe el primer mensaje de la
   cola <code class="parameter">queue</code>, cuyo tipo está especificado por
   <code class="parameter">desired_message_type</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.msg-receive-parameters">
  <h3 class="title">Parámetros</h3>
  <dl>
   
    <dt><code class="parameter">queue</code></dt>
    <dd>
     <span class="simpara">
      Descriptor de recurso de cola de mensajes
     </span>
    </dd>
   
   
    <dt><code class="parameter">desired_message_type</code></dt>
    <dd>
     <span class="simpara">
      Si <code class="parameter">desired_message_type</code> vale 0, se devuelve el primer mensaje
      de la cola. Si <code class="parameter">desired_message_type</code> vale
      más que 0, entonces se devolverá el primer mensaje de ese tipo.
      Si <code class="parameter">desired_message_type</code> vale menos que 0, se devolverá el primer
      mensaje de la cola cuyo tipo sea inferior o igual al valor absoluto
      de <code class="parameter">desired_message_type</code>. Si no hay mensajes
      que cumplan los criterios, el script esperará a que llegue un mensaje
      de ese tipo a la cola. Este bloqueo puede evitarse especificando la opción
      <strong><code><a href="sem.constants.php#constant.msg-ipc-nowait">MSG_IPC_NOWAIT</a></code></strong> en el parámetro
      <code class="parameter">flags</code>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">received_message_type</code></dt>
    <dd>
     <span class="simpara">
      El tipo de mensaje recibido se almacenará en este parámetro.
     </span>
    </dd>
   
   
    <dt><code class="parameter">max_message_size</code></dt>
    <dd>
     <span class="simpara">
      El tamaño máximo de mensaje se establece mediante
      <code class="parameter">max_message_size</code>; si el mensaje de la cola es más grande
      que este tamaño, la función fallará (a menos que se utilice una opción
      <code class="parameter">flags</code>, descrita a continuación).
     </span>
    </dd>
   
   
    <dt><code class="parameter">message</code></dt>
    <dd>
     <span class="simpara">
      El mensaje recibido se almacenará en el parámetro <code class="parameter">message</code>,
      a menos que haya habido errores al recibir el mensaje.
     </span>
    </dd>
   
   
    <dt><code class="parameter">unserialize</code></dt>
    <dd>
     <span class="simpara">
      Cuando esto es cierto, el mensaje se trata como si hubiera sido serializado
      con el mismo mecanismo que el módulo de sesión. El mensaje será entonces
      deserializado y devuelto al script. Esto permitirá recibir fácilmente
      arrays u objetos complejos en su script, enviados por otros scripts PHP,
      o, si se utiliza WDDX, desde cualquier fuente compatible con WDDX.
     </span>
     <span class="simpara">
      Si <code class="parameter">unserialize</code> vale <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>,
      el mensaje se devolverá intacto, sin modificar los valores binarios.
     </span>
    </dd>
   
   
    <dt><code class="parameter">flags</code></dt>
    <dd>
     <p class="para">
      El parámetro <code class="parameter">flags</code> permite pasar opciones
      para configurar las llamadas msgrcv. Por omisión, vale 0, pero se pueden
      especificar una o varias opciones combinándolas con el operador OR.
      <table class="doctable table">
       <caption><strong>Opciones de la función <span class="function"><strong>msg_receive()</strong></span></strong></caption>
       
        <tbody class="tbody">
         <tr>
          <td><strong><code><a href="sem.constants.php#constant.msg-ipc-nowait">MSG_IPC_NOWAIT</a></code></strong></td>
          <td>Si no hay mensajes del tipo
           <code class="parameter">desired_message_type</code>, se devuelve inmediatamente
           y no se espera. La función fallará y devolverá un entero
           correspondiente a <strong><code><a href="sem.constants.php#constant.msg-enomsg">MSG_ENOMSG</a></code></strong>.
          </td>
         </tr>

         <tr>
          <td><strong><code><a href="sem.constants.php#constant.msg-except">MSG_EXCEPT</a></code></strong></td>
          <td>Al utilizar esta opción en combinación con
          un tipo <code class="parameter">desired_message_type</code> superior a 0, la
          función leerá el primer mensaje que no sea
          del tipo solicitado por <code class="parameter">desired_message_type</code>.</td>
         </tr>

         <tr>
          <td><strong><code><a href="sem.constants.php#constant.msg-noerror">MSG_NOERROR</a></code></strong></td>
          <td>
           Si el mensaje es más grande que <code class="parameter">max_message_size</code>,
           esta opción truncará el mensaje al tamaño de
           <code class="parameter">max_message_size</code> y no reportará errores.
          </td>
         </tr>

        </tbody>
       
      </table>

     </p>
    </dd>
   
   
    <dt><code class="parameter">errorcode</code></dt>
    <dd>
     <span class="simpara">
      Si la función falla, el parámetro opcional
      <code class="parameter">error_code</code> se establecerá al valor
      de la variable del sistema errno.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.msg-receive-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="simpara">
   Esta función retorna <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> en caso de éxito o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si ocurre un error.
  </p>
  <p class="simpara">
   Al recibir un mensaje con éxito, la cola se actualiza
   de la siguiente manera: <code class="literal">msg_lrpid</code> toma el valor del identificador
   de proceso del proceso llamante, <code class="literal">msg_qnum</code> se decrementa en
   1 y <code class="literal">msg_rtime</code> toma la fecha y hora actuales.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.msg-receive-changelog">
  <h3 class="title">Historial de cambios</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versión</th>
      <th>Descripción</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">queue</code> ahora espera una <span class="classname"><a href="class.sysvmessagequeue.php" class="classname">SysvMessageQueue</a></span>;
       anteriormente, se esperaba un <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.msg-receive-seealso">
  <h3 class="title">Ver también</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.msg-remove-queue.php" class="function" rel="rdfs-seeAlso">msg_remove_queue()</a> - Destruye una cola de mensajes</span></li>
   <li><span class="function"><a href="function.msg-send.php" class="function" rel="rdfs-seeAlso">msg_send()</a> - Env&iacute;a un mensaje a una cola</span></li>
   <li><span class="function"><a href="function.msg-stat-queue.php" class="function" rel="rdfs-seeAlso">msg_stat_queue()</a> - Devuelve informaci&oacute;n sobre la cola de mensajes</span></li>
   <li><span class="function"><a href="function.msg-set-queue.php" class="function" rel="rdfs-seeAlso">msg_set_queue()</a> - Modifica informaci&oacute;n en la cola de mensajes</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>