shmop_read

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

shmop_readСчитывает данные из блока разделяемой памяти

Описание

shmop_read(Shmop $shmop, int $offset, int $size): string

Функция shmop_read() возвращает строковые данные, которые хранятся в участке разделяемой памяти.

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

shmop

Ресурс блока памяти, который возвращает функция shmop_open().

offset

Смещение, с которого начинается чтение; параметр принимает значение, которое больше или равно нулю и меньше или равно фактическому размеру сегмента разделяемой памяти.

size

Количество байтов для чтения; параметр принимает только значения, которые больше или равны нулю, а сумма offset и size — меньше или равна фактическому размеру сегмента разделяемой памяти. Со значением 0 функция считывает байты по формуле: shmop_size($shmid) - $start.

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

Функция возвращает данные, которые считала.

Ошибки

Функция выбрасывает ошибку ValueError, если в аргументе offset или size передали значение вне допустимого диапазона.

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

Версия Описание
8.0.0 Параметр shmop теперь ожидает экземпляр класса Shmop; раньше ожидался ресурс (resource).
8.0.0 Функция выбрасывает ошибку ValueError, если в аргументе offset или size передали значение вне допустимого диапазона; раньше выдавалась ошибка уровня E_WARNING и функция возвращала значение false.

Примеры

Пример #1 Пример считывания данных из участка разделяемой памяти

<?php

$shm_data
= shmop_read($shm_id, 0, 50);

?>

В приведённом примере функция считает из блока разделяемой памяти 50 байтов и запишет данные в переменную $shm_data.

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

  • shmop_write() - Запись данных в разделяемую память