msg_send

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

msg_send — Отправляет сообщение в очередь сообщений

Описание

msg_send(
    SysvMessageQueue $queue,
    int $message_type,
    string|int|float|bool $message,
    bool $serialize = true,
    bool $blocking = true,
    int &$error_code = null
): bool

Функция msg_send() отправляет сообщение message с типом message_type (должно быть больше 0) в очередь сообщений, которую указали в параметре queue.

Список параметров

queue: Очередь сообщений.
message_type: Тип сообщения. Значение должно быть больше 0.
message: Тело сообщения.
Замечание: Если для параметра serialize установили значение false, он ДОЛЖЕН принадлежать типу: string, int, float или bool. Иначе функция выведет предупреждение.
serialize: Необязательный параметр serialize управляет тем, как будет отправлено сообщение message. По умолчанию serialize имеет значение true, что означает сериализацию message перед отправкой тем же механизмом, который используется модулем обработки сессий. Это позволяет отправлять сложные массивы и объекты в другие PHP-скрипты, или, если вы используете сериализацию WDDX, в другие совместимые с WDDX клиенты.
blocking: Если помещаемое в очередь сообщение слишком велико, ваш скрипт будет ожидать прочтения сообщений другим процессом и освобождения места под отправляемое вами сообщение. Это называется блокировкой; вы можете отключить эту возможность, установив для blocking значение false, в этом случае msg_send() будет немедленно возвращать false если сообщение слишком велико, и устанавливать необязательный параметр error_code в значение MSG_EAGAIN, что будет указывать вам на необходимость попробовать отправить сообщение несколько позже.
error_code: Если функция отработает неудачно, то этот код будет записан в системную переменную errno.

Возвращаемые значения

Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

При успешном завершении структура данных очереди сообщений обновится следующим образом: элемент msg_lspid будет содержать идентификатор вызвавшего процесса, msg_qnum увеличится на 1, а msg_stime будет содержать текущее время.

Список изменений

Версия	Описание
8.0.0	Параметр `queue` теперь ожидает экземпляр класса SysvMessageQueue; раньше ожидался ресурс (resource).

Смотрите также

msg_remove_queue() - Удаляет очередь сообщений
msg_receive() - Получает сообщение из очереди сообщений
msg_stat_queue() - Получает информацию из структуры данных очереди сообщений
msg_set_queue() - Устанавливает информацию в структуре данных очереди сообщений