| 1 | ------------------------------------------------------------------------------- |
|---|
| 2 | DojoX Timing |
|---|
| 3 | ------------------------------------------------------------------------------- |
|---|
| 4 | Version 0.1.0 |
|---|
| 5 | Release date: 08/08/2007 |
|---|
| 6 | ------------------------------------------------------------------------------- |
|---|
| 7 | Project state: |
|---|
| 8 | experimental |
|---|
| 9 | ------------------------------------------------------------------------------- |
|---|
| 10 | Credits |
|---|
| 11 | Tom Trenka (ttrenka AT gmail.com): original Timer, Streamer, Thread and ThreadPool |
|---|
| 12 | Wolfram Kriesing (http://wolfram.kriesing.de/blog/): Sequence |
|---|
| 13 | Jonathan Bond-Caron (jbondc AT gmail.com): port of Timer and Streamer |
|---|
| 14 | Pete Higgins (phiggins AT gmail.com): port of Sequence |
|---|
| 15 | Mike Wilcox (anm8tr AT yahoo.com): dojo.doLater |
|---|
| 16 | ------------------------------------------------------------------------------- |
|---|
| 17 | Project description |
|---|
| 18 | |
|---|
| 19 | DojoX Timing is a project that deals with any kind of advanced use of timing |
|---|
| 20 | constructs. The central object, dojox.timing.Timer (included by default), is |
|---|
| 21 | a simple object that fires a callback on each tick of the timer, as well as |
|---|
| 22 | when starting or stopping it. The interval of each tick is settable, but the |
|---|
| 23 | default is 1 second--useful for driving something such as a clock. |
|---|
| 24 | |
|---|
| 25 | dojox.timing.Streamer is an object designed to facilitate streaming/buffer-type |
|---|
| 26 | scenarios; it takes an input and an output function, will execute the output |
|---|
| 27 | function onTick, and run the input function when the internal buffer gets |
|---|
| 28 | beneath a certain threshold of items. This can be useful for something timed-- |
|---|
| 29 | such as updating a data plot at every N interval, and getting new data from |
|---|
| 30 | a source when there's less than X data points in the internal buffer (think |
|---|
| 31 | real-time data updating). |
|---|
| 32 | |
|---|
| 33 | dojox.timing.Sequencer is an object, similar to Streamer, that will allow you |
|---|
| 34 | to set up a set of functions to be executed in a specific order, at specific |
|---|
| 35 | intervals. |
|---|
| 36 | |
|---|
| 37 | The DojoX Timing ThreadPool is a port from the original implementation in the |
|---|
| 38 | f(m) library. It allows a user to feed a set of callback functions (wrapped |
|---|
| 39 | in a Thread constructor) to a pool for background processing. |
|---|
| 40 | |
|---|
| 41 | dojo.doLater() provides a simple mechanism that checks a conditional before allowing |
|---|
| 42 | your function to continue. If the conditional is false, the function is blocked and continually |
|---|
| 43 | re-called, with arguments, until the conditional passes. |
|---|
| 44 | ------------------------------------------------------------------------------- |
|---|
| 45 | Dependencies: |
|---|
| 46 | |
|---|
| 47 | DojoX Timing only relies on the Dojo Base. |
|---|
| 48 | ------------------------------------------------------------------------------- |
|---|
| 49 | Documentation |
|---|
| 50 | |
|---|
| 51 | TBD. |
|---|
| 52 | ------------------------------------------------------------------------------- |
|---|
| 53 | Installation instructions |
|---|
| 54 | |
|---|
| 55 | Grab the following from the Dojo SVN Repository: |
|---|
| 56 | http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/timing.js |
|---|
| 57 | http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/timing/* |
|---|
| 58 | |
|---|
| 59 | Install into the following directory structure: |
|---|
| 60 | /dojox/timing.js |
|---|
| 61 | /dojox/timing/ |
|---|
| 62 | |
|---|
| 63 | ...which should be at the same level as your Dojo checkout. |
|---|
