shmop_read

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

shmop_readLiest Daten aus einem gemeinsamen Speicherbereich

Beschreibung

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

shmop_read() liest einen String aus einem gemeinsam genutzten Speicherbereich.

Parameter-Liste

shmop

Der Bezeichner für den gemeinsamen Speicherbereich, der von shmop_open() erzeugt wurde.

offset

Offset, bei dem der Lesevorgang beginnen soll; muss größer oder gleich Null und kleiner oder gleich der tatsächlichen Größe des gemeinsamen Speicherbereichs sein.

size

Die Anzahl der zu lesenden Bytes; muss größer oder gleich Null sein und die Summe von offset und size muss kleiner oder gleich der tatsächlichen Größe des gemeinsamen Speicherbereichs sein. 0 liest shmop_size($shmid) - $start Bytes.

Rückgabewerte

Gibt die gelesenen Daten zurück. Bei einem Fehler wird false zurückgegeben.

Fehler/Exceptions

Wenn offset oder size außerhalb des zulässigen Bereichs liegen, wird ein ValueError ausgelöst.

Changelog

Version Beschreibung
8.0.0 shmop erwartet nun eine Shmop-Instanz; vorher wurde eine resource erwartet.
8.0.0 Wenn offset oder size außerhalb des zulässigen Bereichs liegen, wird ein ValueError ausgelöst; vorher wurde ein E_WARNING ausgegeben und false zurückgegeben,

Beispiele

Beispiel #1 Aus dem gemeinsamen Speicherbereich lesen

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

In diesem Beispiel werden 50 Bytes aus dem gemeinsamen Speicherbereich in die Variable $shm_data eingelesen.

Siehe auch

  • shmop_write() - Schreibt Daten in einen gemeinsamen Speicherbereich

add a note add a note

User Contributed Notes 5 notes

up
6
Craig Manley
19 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
2
macmaster at pobox dot com
22 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
0
michael dot wuertz at six dot de
2 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
-1
slavapl at mailandnews dot com
22 years ago
Also you can use the shmop_size() function to determine the block size.
up
-22
Milan Cvejic
15 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