Changeset 15074


Ignore:
Timestamp:
03/15/13 12:20:21 (9 years ago)
Author:
tbretz
Message:
Added the new function v8.timeout
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/FACT++/scripts/doc/v8.js

    r14699 r15074  
    2727
    2828/**
     29 * This function implements a simple timeout functionality.
     30 * back to the operating system to produce less CPU load if the
     31 * main purpose of a loop is, e.g., to wait for something to happen.
     32 *
     33 * @param {Integer} [milliseconds]
     34 *     Number of millliseconds until the timeout. Note that even 0
     35 *     will execute the function at least once. If the timeout
     36 *     is negative no exception will be thrown by undefined will
     37 *     be returned in case of a timeout.
     38 *
     39 * @param {Function} [func]
     40 *     A function. The function defines when the conditional to end
     41 *     the timeout will be fullfilled. As soon as the function returns
     42 *     a defined value, i.e. something else than undefined, the
     43 *     timeout is stopped and its return value is returned.
     44 *
     45 * @param [. . .]
     46 *     Any further argument will be passed to the function.
     47 *
     48 * @returns
     49 *     Whatever is returned by the function. undefined in case of timeout
     50 *     and a negative timeout value.
     51 *
     52 * @throws
     53 *     <li> When the number or type of argument is wrong
     54 *     <li> In case the timeout is positive and the timeout condition occurs
     55 *
     56 */
     57v8.timeout = function() { /* [native code] */ }
     58
     59/**
    2960 * Version number of the V8 JavaScript engine.
    3061 *
Note: See TracChangeset for help on using the changeset viewer.