msg_receive

(только PHP 4 CVS)

msg_receive - получает сообщение из очереди сообщений.

Описание

bool msg_receive (int queue, int desiredmsgtype, int msgtype, int maxsize, mixed message [, bool unserialize [, int flags [, int errorcode]]])

msg_receive() получает первое сообщение из специфицированной очереди queue типа desiredmsgtype . Тип полученного сообщения будет храниться в msgtype . Максимальный размер принимаемого сообщения специфицируется параметром maxsize ; если сообщение в очереди больше, чем этот размер, функция потерпит неудачу (если вы не установили flags , как описано ниже). Получаемое сообщение будет сохранено в message , если не было ошибок при получении сообщения - тогда в необязательный errorcode будет установлено значение системной переменной errno, что поможет вам идентифицировать причину.

Если desiredmsgtype равен 0, возвращается сообщение из начала очереди. Если desiredmsgtype больше 0, возвращается первое сообщение данного типа. Если desiredmsgtype меньше 0, будет прочитано первое сообщение в очереди с наименьшим типом, меньше и равным абсолютному значению desiredmsgtype . Если нет сообщений, соответствующих этому критерию, ваш скрипт будет ожидать, пока подходящее сообщение не дождётся своей очереди. Вы можете предотвратить блокировку скрипта, специфицировав MSG_IPC_NOWAIT в параметре flags .

unserialize имеет по умолчанию TRUE ; если установлен TRUE , сообщение рассматривается как если бы оно было сериализовано с использованием того же механизма, что и в модуле сессии. Сообщение будет десериализовано и возвращено вашему скрипту. Это даёт возможность легко получать массивы или сложные структуры объектов их других PHP-скриптов или, если вы используете WDDX-сериализатор, из любого WDDX-совместимого источника. Если unserialize равен FALSE , сообщение будет возвращено как binary-safe строка.

Необязательный параметр flags даёт вам возможность передавать флаги низкоуровневому системному вызову msgrcv. По умолчанию равен 0, но вы можете специфицировать одно или более из следующих значений (складывая или OR'ируя их вместе).

Таблица 1. Значения флагов для msg_receive

При успешном выполнении структура данных очереди обновляется так:
msg_lrpid получает process-ID вызывающего процесса,
msg_qnum декрементирует на 1,
а в msg_rtime устанавливается текущее время.

msg_receive() возвращает TRUE при успехе, FALSE при неудаче. Если функция терпит неудачу, необязательный errorcode получит значение системной переменной errno.

См. также msg_remove_queue() , msg_send() , msg_stat_queue() и msg_set_queue() .

Эта функция была введена в PHP 4.3.0.