File: SyncSharedMemory.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (39 lines) | stat: -rw-r--r-- 1,832 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SyncSharedMemory" namespace="" name="SyncSharedMemory">
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs a new SyncSharedMemory object"/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="size" optional="false" byreference="false" type="int"/>
  </constructor>
  <method name="first" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check to see if the object is the first instance system-wide of named shared memory"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="read" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Copy data from named shared memory"/>
      <return type="void"/>
    </docblock>
    <parameter name="start" optional="true" byreference="false" type="int"/>
    <parameter name="length" optional="true" byreference="false" type="int"/>
  </method>
  <method name="size" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the size of the named shared memory"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="write" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Copy data to named shared memory"/>
      <return type="void"/>
    </docblock>
    <parameter name="string" optional="true" byreference="false" type="string"/>
    <parameter name="start" optional="true" byreference="false" type="int"/>
  </method>
</class>