File: Swoole_Channel.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 (28 lines) | stat: -rw-r--r-- 1,252 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Swoole\Channel" namespace="Swoole" name="Channel">
  <destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Destruct a Swoole channel."/>
      <return type="void"/>
    </docblock>
  </destructor>
  <method name="pop" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Read and pop data from swoole channel."/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="push" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Write and push data into Swoole channel.">Data can be any non-empty PHP variable, the variable will be serialized if it is not string type.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
  </method>
  <method name="stats" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get stats of swoole channel."/>
      <return type="array"/>
    </docblock>
  </method>
</class>