<!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>Constructs a new SyncSharedMemory object</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="class.syncsharedmemory.html">SyncSharedMemory</a></div> <div class="next" style="text-align: right; float: right;"><a href="syncsharedmemory.first.html">SyncSharedMemory::first</a></div> <div class="up"><a href="class.syncsharedmemory.html">SyncSharedMemory</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="syncsharedmemory.construct" class="refentry"> <div class="refnamediv"> <h1 class="refname">SyncSharedMemory::__construct</h1> <p class="verinfo">(PECL sync >= 1.1.0)</p><p class="refpurpose"><span class="refname">SyncSharedMemory::__construct</span> — <span class="dc-title">Constructs a new SyncSharedMemory object</span></p> </div> <div class="refsect1 description" id="refsect1-syncsharedmemory.construct-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><strong>SyncSharedMemory::__construct</strong></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> <p class="para rdfs-comment"> Constructs a named shared memory object. </p> </div> <div class="refsect1 parameters" id="refsect1-syncsharedmemory.construct-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">name</code></dt> <dd> <p class="para"> The name of the shared memory object. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> If the name already exists, it must be able to be opened by the current user that the process is running as or an exception will be thrown with a meaningless error message. </p> </p></blockquote> </dd> <dt> <code class="parameter">size</code></dt> <dd> <p class="para"> The size, in bytes, of shared memory to reserve. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> The amount of memory cannot be resized later. Request sufficient storage up front. </p> </p></blockquote> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-syncsharedmemory.construct-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> The new SyncSharedMemory object. An exception is thrown if the shared memory object cannot be created or opened. </p> </div> <div class="refsect1 examples" id="refsect1-syncsharedmemory.construct-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-4606"> <p><strong>Example #1 <span class="function"><strong>SyncSharedMemory::__construct()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// You will probably need to protect shared memory with other synchronization objects.<br />// Shared memory goes away when the last reference to it disappears.<br /></span><span style="color: #0000BB">$mem </span><span style="color: #007700">= new </span><span style="color: #0000BB">SyncSharedMemory</span><span style="color: #007700">(</span><span style="color: #DD0000">"AppReportName"</span><span style="color: #007700">, </span><span style="color: #0000BB">1024</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$mem</span><span style="color: #007700">-></span><span style="color: #0000BB">first</span><span style="color: #007700">())<br />{<br /> </span><span style="color: #FF8000">// Do first time initialization work here.<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$mem</span><span style="color: #007700">-></span><span style="color: #0000BB">write</span><span style="color: #007700">(</span><span style="color: #0000BB">json_encode</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"name" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"my_report.txt"</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-syncsharedmemory.construct-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="methodname"><a href="syncsharedmemory.first.html" class="methodname" rel="rdfs-seeAlso">SyncSharedMemory::first()</a> - Check to see if the object is the first instance system-wide of named shared memory</span></li> <li class="member"><span class="methodname"><a href="syncsharedmemory.size.html" class="methodname" rel="rdfs-seeAlso">SyncSharedMemory::size()</a> - Returns the size of the named shared memory</span></li> <li class="member"><span class="methodname"><a href="syncsharedmemory.write.html" class="methodname" rel="rdfs-seeAlso">SyncSharedMemory::write()</a> - Copy data to named shared memory</span></li> <li class="member"><span class="methodname"><a href="syncsharedmemory.read.html" class="methodname" rel="rdfs-seeAlso">SyncSharedMemory::read()</a> - Copy data from named shared memory</span></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="class.syncsharedmemory.html">SyncSharedMemory</a></div> <div class="next" style="text-align: right; float: right;"><a href="syncsharedmemory.first.html">SyncSharedMemory::first</a></div> <div class="up"><a href="class.syncsharedmemory.html">SyncSharedMemory</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>