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() - Запись данных в разделяемую память

Добавить

Примечания пользователей 4 notes

up
6
Craig Manley
20 years ago
shmop_read() reads and returns the whole memory segment's data. This is not useful if you're just working with strings. If you need to read a string from shared memory, call str_from_mem() on the result of shmop_read(). Similarly when writing strings to memory (instead of binary data), null terminate your strings with str_to_nts() before passing the value on to shmop_write().

function str_to_nts($value) {
return "$value\0";
}

function str_from_mem(&$value) {
$i = strpos($value, "\0");
if ($i === false) {
return $value;
}
$result = substr($value, 0, $i);
return $result;
}
up
3
macmaster at pobox dot com
23 years ago
When i need to read the whole string at that shm pointer, setting the count parameter to zero (0) seems work for me.
up
1
michael dot wuertz at six dot de
3 years ago
With shmop_read, you probably get a "\0" - padded string.

$zero_padded = shmop_read($shm_seg, 0, 128);

$usable_string = rtrim($zero_padded, "\0");
up
-2
slavapl at mailandnews dot com
23 years ago
Also you can use the shmop_size() function to determine the block size.
To Top