<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The SyncSharedMemory class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="syncreaderwriter.writeunlock.html">SyncReaderWriter::writeunlock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncsharedmemory.construct.html">SyncSharedMemory::__construct</a></div>
<div class="up"><a href="book.sync.html">Sync</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.syncsharedmemory" class="reference">
<h1 class="title">The SyncSharedMemory class</h1>
<div class="partintro"><p class="verinfo">(PECL sync >= 1.1.0)</p>
<div class="section" id="syncsharedmemory.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A cross-platform, native, consistent implementation of named shared memory
objects.
</p>
<p class="para">
Shared memory lets two separate processes communicate without the need for
complex pipes or sockets. There are several integer-based shared memory
implementations for PHP. Named shared memory is an alternative.
</p>
<p class="para">
Synchronization objects (e.g. SyncMutex) are still required to protect most
uses of shared memory.
</p>
</div>
<div class="section" id="syncsharedmemory.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">SyncSharedMemory</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="syncsharedmemory.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$size</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="syncsharedmemory.first.html" class="methodname">first</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="syncsharedmemory.read.html" class="methodname">read</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$start</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="syncsharedmemory.size.html" class="methodname">size</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="syncsharedmemory.write.html" class="methodname">write</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$string</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$start</code><span class="initializer"> = 0</span></span>
]] )</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="syncsharedmemory.construct.html">SyncSharedMemory::__construct</a> — Constructs a new SyncSharedMemory object</li><li><a href="syncsharedmemory.first.html">SyncSharedMemory::first</a> — Check to see if the object is the first instance system-wide of named shared memory</li><li><a href="syncsharedmemory.read.html">SyncSharedMemory::read</a> — Copy data from named shared memory</li><li><a href="syncsharedmemory.size.html">SyncSharedMemory::size</a> — Returns the size of the named shared memory</li><li><a href="syncsharedmemory.write.html">SyncSharedMemory::write</a> — Copy data to named shared memory</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="syncreaderwriter.writeunlock.html">SyncReaderWriter::writeunlock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="syncsharedmemory.construct.html">SyncSharedMemory::__construct</a></div>
<div class="up"><a href="book.sync.html">Sync</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
