Changes between Initial Version and Version 1 of DeveloperGuidelines/Scheduler

Timestamp:

09/11/12 03:58:36 (13 years ago)

Author:

James O'Neill

Comment:

Simple page on how to use the scheduler

DeveloperGuidelines/Scheduler

@@ +1 @@
+The scheduler is used for asynchronous tasks (not from a user request to the web server). It is used for daily instance maintenance and for processing and sending messages.
+
+The Eden scheduler is a wrapper to the [http://web2py.com/books/default/chapter/29/4#Scheduler-%28experimental%29 web2py scheduler].
+
+== New Task ==
+To create a new function in `/models/tasks.py` for your new task, and point to it by setting a value in the `tasks` dictionary, e.g.,
+
+{{{
+#!python
+def my_task(*args, **kwargs):
+        return result
+
+tasks["my_task"] = my_task
+}}}
+
+Task schedules are configured by using [http://pub.nursix.org/eden/s3/s3.s3task.S3Task-class.html#schedule_task s3task.schedule_task()] in `/models/zzz_1st_run.py`.
+
+{{{
+#!python
+s3task.schedule_task(
+        "my_task",
+        args=[
+                "foo",
+        ],
+        vars={
+                "bar": "cha",
+        },
+        period=300, # every 5 minutes
+        repeat=0 # run forever
+)
+}}}
+
+Note that tasks are run without credentials.