PHP 8.1.15 Released!

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.

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

Возвращает строковые данные или false в случае возникновения ошибки.

Ошибки

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

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

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

Примеры

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

<?php
$shm_data
= shmop_read($shm_id, 0, 50);
?>

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

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

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

add a note

User Contributed Notes 5 notes

up
6
Craig Manley
18 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
21 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
1 year 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
-1
slavapl at mailandnews dot com
21 years ago
Also you can use the shmop_size() function to determine the block size.
up
-22
Milan Cvejic
13 years ago
You should always serialize data written in shared memory.
And when you are reading data you should always unserialize.

<?php

$data
= 'test';
$shm_bytes_written = shmop_write($shm_id, serialize($data), 0);
$shm_data = unserialize(shmop_read($shm_id, 0, $shm_bytes_written));
?>
To Top