diff options
| author | David Thompson <dthompson2@worcester.edu> | 2017-04-27 22:26:06 -0400 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2017-04-27 22:26:06 -0400 |
| commit | 5e8aab990b355ed51b409fb1916afd6b8848c8b8 (patch) | |
| tree | 8edad47385de41cdc6c731560c94e69d95a1d92c /doc/api.texi | |
| parent | 2c3d74bc23947a998fa1f330c5ab025804866c99 (diff) | |
scripting: agenda: Add 'every' scheduling option.
* chickadee/scripting/agenda.scm (schedule-every): New procedure.
(every): New syntax.
* doc/api.texi (Agendas): Document it.
Diffstat (limited to 'doc/api.texi')
| -rw-r--r-- | doc/api.texi | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api.texi b/doc/api.texi index e1f6acc..1a56039 100644 --- a/doc/api.texi +++ b/doc/api.texi @@ -955,6 +955,12 @@ Schedule @var{thunk}, a procedure of zero arguments, to be run after @var{delay}. @end deffn +@deffn {Scheme Procedure} schedule-every @var{interval} @var{thunk} [@var{n}] +Schedule @var{thunk}, a procedure of zero arguments, to be run every +@var{interval} amount of time. Repeat this @var{n} times, or +indefinitely if not specified. +@end deffn + @deffn {Scheme Syntax} at @var{time} @var{body} @dots{} Schedule @var{body} to be evaluated at @var{time}. @end deffn @@ -963,6 +969,12 @@ Schedule @var{body} to be evaluated at @var{time}. Schedule @var{body} to be evaluated after @var{delay}. @end deffn +@deffn {Scheme Syntax} every @var{interval} @var{body} @dots{} +@deffnx {Scheme Syntax} every (@var{interval} @var{n}) @var{body} @dots{} +Schedule @var{body} to be evaluated every @var{interval} amount of +time. Repeat this @var{n} times, or indefinitely if not specified. +@end deffn + @node Coroutines @subsection Coroutines |