|
1 | 1 | <?xml version="1.0" encoding="utf-8"?> |
2 | 2 | <!-- $Revision$ --> |
3 | | - |
4 | | -<refentry xml:id="function.eio-busy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> |
| 3 | +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.eio-busy"> |
5 | 4 | <refnamediv> |
6 | 5 | <refname>eio_busy</refname> |
7 | 6 | <refpurpose>Artificially increase load. Could be useful in tests, |
|
13 | 12 | <methodsynopsis> |
14 | 13 | <type>resource</type><methodname>eio_busy</methodname> |
15 | 14 | <methodparam><type>int</type><parameter>delay</parameter></methodparam> |
16 | | - <methodparam |
17 | | - choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam> |
18 | | - <methodparam |
19 | | - choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam> |
20 | | - <methodparam |
21 | | - choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam> |
| 15 | + <methodparam choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam> |
| 16 | + <methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam> |
| 17 | + <methodparam choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam> |
22 | 18 | </methodsynopsis> |
23 | | - <para> |
| 19 | + <simpara> |
24 | 20 | <function>eio_busy</function> artificially increases load taking |
25 | 21 | <parameter>delay</parameter> seconds to execute. May be used for debugging, |
26 | 22 | or benchmarking. |
27 | | - </para> |
| 23 | + </simpara> |
28 | 24 | </refsect1> |
29 | 25 |
|
30 | 26 | <refsect1 role="parameters"> |
|
33 | 29 | <varlistentry> |
34 | 30 | <term><parameter>delay</parameter></term> |
35 | 31 | <listitem> |
36 | | - <para> |
| 32 | + <simpara> |
37 | 33 | Delay in seconds |
38 | | - </para> |
| 34 | + </simpara> |
39 | 35 | </listitem> |
40 | 36 | </varlistentry> |
41 | 37 | <varlistentry> |
|
47 | 43 | <varlistentry> |
48 | 44 | <term><parameter>callback</parameter></term> |
49 | 45 | <listitem> |
50 | | - <para> |
| 46 | + <simpara> |
51 | 47 | This callback is called when all the group requests are done. |
52 | | - </para> |
| 48 | + </simpara> |
53 | 49 | </listitem> |
54 | 50 | </varlistentry> |
55 | 51 | <varlistentry> |
56 | 52 | <term><parameter>data</parameter></term> |
57 | 53 | <listitem> |
58 | | - <para> |
| 54 | + <simpara> |
59 | 55 | Arbitrary variable passed to <parameter>callback</parameter>. |
60 | | - </para> |
| 56 | + </simpara> |
61 | 57 | </listitem> |
62 | 58 | </varlistentry> |
63 | 59 | </variablelist> |
64 | 60 | </refsect1> |
65 | 61 |
|
66 | 62 | <refsect1 role="returnvalues"> |
67 | 63 | &reftitle.returnvalues; |
68 | | - <para> |
| 64 | + <simpara> |
69 | 65 | <function>eio_busy</function> returns request resource on success,&return.falseforfailure;. |
70 | | - </para> |
| 66 | + </simpara> |
71 | 67 | </refsect1> |
72 | 68 |
|
73 | 69 | <refsect1 role="seealso"> &reftitle.seealso; |
|
77 | 73 | </refsect1> |
78 | 74 |
|
79 | 75 | </refentry> |
80 | | - |
81 | 76 | <!-- Keep this comment at the end of the file |
82 | 77 | Local variables: |
83 | 78 | mode: sgml |
|
0 commit comments