summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2016-04-02 11:44:04 +0300
committerAlex Grönholm <alex.gronholm@nextday.fi>2016-04-02 11:44:04 +0300
commitbb67d0899d235479b32450315a683b42af435f73 (patch)
tree152ee77666a1135dcf898123788169bac8463978 /docs
parentbc8ae633568ca87befcf4e7b0b8cf71c22e5c3cb (diff)
downloadapscheduler-bb67d0899d235479b32450315a683b42af435f73.tar.gz
Added EVENT_JOB_SUBMITTED and EVENT_JOB_MAX_INSTANCES events
Diffstat (limited to 'docs')
-rw-r--r--docs/modules/events.rst11
-rw-r--r--docs/versionhistory.rst5
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/modules/events.rst b/docs/modules/events.rst
index e4680d9..3a85350 100644
--- a/docs/modules/events.rst
+++ b/docs/modules/events.rst
@@ -13,6 +13,10 @@ API
:members:
:show-inheritance:
+.. autoclass:: JobSubmissionEvent
+ :members:
+ :show-inheritance:
+
.. autoclass:: JobExecutionEvent
:members:
:show-inheritance:
@@ -59,6 +63,13 @@ The following event codes are numeric constants importable from :mod:`apschedule
* - EVENT_JOB_MODIFIED
- A job was modified from outside the scheduler
- :class:`JobEvent`
+ * - EVENT_JOB_SUBMITTED
+ - A job was submitted to its executor to be run
+ - :class:`JobSubmissionEvent`
+ * - EVENT_JOB_MAX_INSTANCES
+ - A job being submitted to its executor was not accepted by the executor because the job has
+ already reached its maximum concurrently executing instances
+ - :class:`JobSubmissionEvent`
* - EVENT_JOB_EXECUTED
- A job was executed successfully
- :class:`JobExecutionEvent`
diff --git a/docs/versionhistory.rst b/docs/versionhistory.rst
index 4507708..6525dd7 100644
--- a/docs/versionhistory.rst
+++ b/docs/versionhistory.rst
@@ -18,6 +18,11 @@ APScheduler, see the :doc:`migration section <migration>`.
* Added method chaining to the ``modify_job()``, ``reschedule_job()``, ``pause_job()`` and
``resume_job()`` methods in ``BaseScheduler`` and the corresponding methods in the ``Job`` class
+* Added the EVENT_JOB_SUBMITTED event that indicates a job has been submitted to its executor.
+
+* Added the EVENT_JOB_MAX_INSTANCES event that indicates a job's execution was skipped due to its
+ maximum number of concurrently running instances being reached
+
3.0.6
-----