PHP Conference Nagoya 2025

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

読み取りを始めるオフセット。 この値は 0 以上、かつ共有メモリセグメントの実際のサイズ以下でなければいけません。

size

読み取るバイト数。 この値は 0 以上、かつ offsetsize の合計値が、共有メモリセグメントの実際のサイズ以下でなければいけません。 0 を指定すると、shmop_size($shmid) - $start バイトを読み取ります。

戻り値

読み取ったデータを返します。 失敗した場合に false を返します

エラー / 例外

offsetsize が範囲外の値の場合、 ValueError がスローされます。

変更履歴

バージョン 説明
8.0.0 引数 shmop は、 Shmop クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソースを期待していました。
8.0.0 offsetsize が範囲外の値の場合、 ValueError がスローされるようになりました。 これより前のバージョンでは、E_WARNING が発生し、false を返していました。

例1 共有メモリブロックを読み取る

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

この例は、共有メモリブロックから50バイトを読み取り、 データを $shm_data に格納します。

参考

  • shmop_write() - 共有メモリブロックにデータを書き込む

add a note

User Contributed Notes 4 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
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