File: Swoole_Timer.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 (34 lines) | stat: -rw-r--r-- 1,748 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Swoole\Timer" namespace="Swoole" name="Timer">
  <method name="after" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Trigger a callback function after a period of time."/>
      <return type="void"/>
    </docblock>
    <parameter name="after_time_ms" optional="false" byreference="false" type="int"/>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="clear" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Delete a timer by timer ID."/>
      <return type="void"/>
    </docblock>
    <parameter name="timer_id" optional="false" byreference="false" type="object" class="integer"/>
  </method>
  <method name="exists" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if a timer is existed."/>
      <return type="boolean"/>
    </docblock>
    <parameter name="timer_id" optional="false" byreference="false" type="object" class="integer"/>
  </method>
  <method name="tick" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Repeats a given function at every given time-interval."/>
      <return type="void"/>
    </docblock>
    <parameter name="interval_ms" optional="false" byreference="false" type="object" class="integer"/>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
    <parameter name="param" optional="true" byreference="false" type="string"/>
  </method>
</class>