File: Swoole_Buffer.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 (66 lines) | stat: -rw-r--r-- 3,308 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Swoole\Buffer" namespace="Swoole" name="Buffer">
  <method name="append" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Append the string or binary data at the end of the memory buffer and return the new size of memory allocated."/>
      <return type="integer"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
  </method>
  <method name="clear" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Reset the memory buffer."/>
      <return type="void"/>
    </docblock>
  </method>
  <destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Destruct the Swoole memory buffer."/>
      <return type="void"/>
    </docblock>
  </destructor>
  <method name="expand" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Expand the size of memory buffer."/>
      <return type="integer"/>
    </docblock>
    <parameter name="size" optional="false" byreference="false" type="object" class="integer"/>
  </method>
  <method name="read" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Read data from the memory buffer based on offset and length."/>
      <return type="string"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="object" class="integer"/>
    <parameter name="length" optional="false" byreference="false" type="object" class="integer"/>
  </method>
  <method name="recycle" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Release the memory to OS which is not used by the memory buffer."/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="substr" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Read data from the memory buffer based on offset and length. Or remove data from the memory buffer."/>
      <return type="string"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="object" class="integer"/>
    <parameter name="length" optional="true" byreference="false" type="object" class="integer"/>
    <parameter name="remove" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the string value of the memory buffer."/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="write" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Write data to the memory buffer. The memory allocated for the buffer will not be changed."/>
      <return type="void"/>
    </docblock>
    <parameter name="offset" optional="false" byreference="false" type="object" class="integer"/>
    <parameter name="data" optional="false" byreference="false" type="string"/>
  </method>
</class>