autodoc.git/ autodoc.xml

1996-08-06

1996-08-06 11:47:58 by Fredrik Hübinette (Hubbe) <hubbe@hubbe.net>

• c1a1250635155f90d265f7f33c4be7212dc0b305 (43 lines) (+38/-5) ^{[ Show | Annotate ]}
  Branch: ulpc

call outs now has ids

Rev: src/modules/call_out/call_out.c:1.4
Rev: src/modules/call_out/doc/call_out:1.2
Rev: src/modules/call_out/doc/find_call_out:1.2
Rev: src/modules/call_out/doc/remove_call_out:1.2

1152:   <text>   <p><tt>call_out</tt> - make a delayed call to a function</p>    - <tt><p>void call_out(function <i>f</i>, int <i>delay</i>, mixed ... <i>args</i>);<br/> + <tt><p>mixed call_out(function <i>f</i>, int <i>delay</i>, mixed ... <i>args</i>);<br/>   </p>   </tt>   <p>Call_out places a call to the function f with the argument args - in a queue to be called in about delay seconds.</p> + in a queue to be called in about delay seconds. The return value + identifies this call out. The return value can be sent to + find_call_out or remove_call_out to remove the call out again.</p>   </text>      <group><seealso/><text>
1944:   <p><tt>find_call_out</tt> - find a call out in the queue</p>      <tt><p>int find_call_out(function <i>f</i>);<br/> + or<br/> + int find_call_out(mixed <i>id</i>);<br/>   </p>   </tt> - <p>This function searches the call out queue, and returns the time left - to this call out will be done in seconds. If no call is found, + <p>This function searches the call out queue. If given a function as + argument, it looks for the first call out scheduled to that function. + The argument can also be a call out id as returned by call_out, in + which case that call_out will be found. (Unless it has already been + called.) find_call_out will then return how many seconds remains + before that call will be executed. If no call is found,   zero_type(find_call_out(f)) will return 1.</p>   </text>   
2291:      </doc>   </docgroup> + <docgroup homogen-name='gauge' homogen-type='method'> + <method name='gauge'/><doc placeholder='true'> + <text> + <p><tt>gauge</tt> - measure system time</p> +  + <tt><p>gauge { commands }<br/> + or<br/> + gauge ( expression )<br/> + </p> + </tt> + <p>Gauge measure how much cpu time is used to execute the commands + given as arguments. The number of milliseconds used is returned + as an integer.</p> + </text> +  + <group><seealso/><text> + <p><ref resolved='predef::catch' to='catch'>catch</ref> and <ref resolved='predef::rusage' to='predef::rusage'>builtin/rusage</ref></p> + </text></group> +  + </doc> + </docgroup>   <docgroup homogen-name='gc' homogen-type='method'>   <method name='gc'/><doc placeholder='true'>   <text>
3822:   <p><tt>remove_call_out</tt> - remove a call out from the call out queue</p>      <tt><p>int remove_call_out(function <i>f</i>);<br/> + or<br/> + int remove_call_out(function <i>id</i>);<br/>   </p>   </tt>   <p>This function finds the first call to the function f in the call   out queue and removes it. The time left to that call out will be   returned. If no call out was found, zero_type(remove_call_out(f)) - will return 1.</p> + will return 1. You can also give a call out id as argument. (as + returned by call_out)</p>   </text>      <group><seealso/><text>