(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
msg_receive — Recibir un mensaje de la cola de mensajes
$queue
,$desiredmsgtype
,&$msgtype
,$maxsize
,&$message
,$unserialize
= true,$flags
= 0,&$errorcode
= ?msg_receive() recibirá el primer mensaje de la cola especificada por queue
del tipo especificado por desiredmsgtype
.
queue
desiredmsgtype
Si desiredmsgtype
es 0, se devolverá el mensaje al frente de la cola. Si desiredmsgtype
es mayor que 0, se devolverá el primer mensaje de ese tipo. Si desiredmsgtype
es menor que 0, se leerá el primer mensaje de la cola con el tipo más bajo menor o igual que el valor absoluto de desiredmsgtype
. Si ningún mensaje concuerda con el criterio, el script esperará hasta que un mensaje apropiado llegue a la cola. Se puede prevenir que se bloquee el script especificando MSG_IPC_NOWAIT
en el parámetro flags
.
msgtype
El tipo de mensaje que fue recibido se almacenará en este parámetro.
maxsize
El tamaño máximo del mensaje aceptado se especifica mediante maxsize
; si el mensaje de la cola es mayor que este tamaño la función fallará (a menos que se establezca flags
como está descrito abajo).
message
El mensaje recibido será almacenado en message
, a menos que hubiera errores al recibir dicho mensaje.
unserialize
Si está establecido a true
, el mensaje es tratado como si fuera serializado usando el mismo mecanismo que el del módulo de sesión. El mensaje será deserializado y después devuelto al script. Esto permite recibir de forma sencilla matrices y objetos complejos desde otros scripts de PHP, o si se está usando el serializador WDDX, desde cualquier fuente compatible con WDDX.
Si unserialize
es false
, el mensaje será devuelto como cadena segura a nivel binario.
flags
El parámetro opcional flags
permite pasar banderas a la llamada a bajo nivel de msgrcv. Por defecto es 0, pero se puede especificar uno o más de los siguientes valores (añadiéndolos o usando OR).
MSG_IPC_NOWAIT | Si no hay mensajes del tipo deseado dado por desiredmsgtype , devuelve inmediatamente y no espera. La función fallará y devolverá un valor de tipo integer correspondiente a MSG_ENOMSG . |
MSG_EXCEPT | Usar esta bandera en combinación con un desiredmsgtype mayor que 0 causará que la función reciba el primer mensaje que no sea igual a desiredmsgtype . |
MSG_NOERROR | Si el mensaje es mayor que maxsize , establecer esta bandera truncará el mensaje a maxsize y no enviará un error. |
errorcode
Si la función falla, el parámetro opcional errorcode
será establecido al valor de la variable errno del sistema.
Devuelve true
en caso de éxito o false
en caso de error.
Si se finalizó con éxito, la estructura de datos de la cola de mensajes se actualiza como sigue: msg_lrpid
se establece al ID del proceso de llamada, msg_qnum
se disminuye en 1 y msg_rtime
se establece al momento actual.