PHP 5.6.29 Released

shmop_read

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

shmop_readRead data from shared memory block

Description

string shmop_read ( resource $shmid , int $start , int $count )

shmop_read() will read a string from shared memory block.

Parameters

shmid

The shared memory block identifier created by shmop_open()

start

Offset from which to start reading

count

The number of bytes to read

Return Values

Returns the data or FALSE on failure.

Changelog

Version Description
7.0.0 The type of shmid has been changed from int to resource.

Examples

Example #1 Reading shared memory block

<?php
$shm_data 
shmop_read($shm_id050);
?>

This example will read 50 bytes from shared memory block and place the data inside $shm_data.

See Also

add a note add a note

User Contributed Notes 4 notes

up
7
Craig Manley
11 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
15 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
slavapl at mailandnews dot com
15 years ago
Also you can use the shmop_size() function to determine the block size.
up
-13
Milan Cvejic
7 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