Subversion Repositories Applications.papyrus

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2150 mathias 1
-------------------------------------------------------------------------------
2
DojoX Timing
3
-------------------------------------------------------------------------------
4
Version 0.1.0
5
Release date: 08/08/2007
6
-------------------------------------------------------------------------------
7
Project state:
8
expermental
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
-------------------------------------------------------------------------------
16
Project description
17
 
18
DojoX Timing is a project that deals with any kind of advanced use of timing
19
constructs.  The central object, dojox.timing.Timer (included by default), is
20
a simple object that fires a callback on each tick of the timer, as well as
21
when starting or stopping it.  The interval of each tick is settable, but the
22
default is 1 second--useful for driving something such as a clock.
23
 
24
dojox.timing.Streamer is an object designed to facilitate streaming/buffer-type
25
scenarios; it takes an input and an output function, will execute the output
26
function onTick, and run the input function when the internal buffer gets
27
beneath a certain threshold of items.  This can be useful for something timed--
28
such as updating a data plot at every N interval, and getting new data from
29
a source when there's less than X data points in the internal buffer (think
30
real-time data updating).
31
 
32
dojox.timing.Sequencer is an object, similar to Streamer, that will allow you
33
to set up a set of functions to be executed in a specific order, at specific
34
intervals.
35
 
36
The DojoX Timing ThreadPool is a port from the original implementation in the
37
f(m) library.  It allows a user to feed a set of callback functions (wrapped
38
in a Thread constructor) to a pool for background processing.
39
-------------------------------------------------------------------------------
40
Dependencies:
41
 
42
DojoX Timing only relies on the Dojo Base.
43
-------------------------------------------------------------------------------
44
Documentation
45
 
46
TBD.
47
-------------------------------------------------------------------------------
48
Installation instructions
49
 
50
Grab the following from the Dojo SVN Repository:
51
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/timing.js
52
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/timing/*
53
 
54
Install into the following directory structure:
55
/dojox/timing.js
56
/dojox/timing/
57
 
58
...which should be at the same level as your Dojo checkout.