From 711455527c3f9bffb9a8d127fa0b0d0421867abe Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Wed, 2 Jan 2013 12:12:59 -0800 Subject: [PATCH] [JobQueue] Clarified documentation a bit. Change-Id: I065efd6b41a42d2d39b034c3488d2f00c27d7ac5 --- includes/job/JobQueue.php | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/includes/job/JobQueue.php b/includes/job/JobQueue.php index 65c0725c37..ffd5d95f1f 100644 --- a/includes/job/JobQueue.php +++ b/includes/job/JobQueue.php @@ -63,6 +63,8 @@ abstract class JobQueue { * claimTTL : If supported, the queue will recycle jobs that have been popped * but not acknowledged as completed after this many seconds. * + * Queue classes should throw an exception if they do not support the options given. + * * @param $params array * @return JobQueue * @throws MWException @@ -157,7 +159,9 @@ abstract class JobQueue { abstract protected function doPop(); /** - * Acknowledge that a job was completed + * Acknowledge that a job was completed. + * + * This does nothing for certain queue classes or if "claimTTL" is not set. * * @param $job Job * @throws MWException @@ -204,6 +208,8 @@ abstract class JobQueue { * Essentially, the new batch of jobs belong to a new "root job" and the older ones to a * previous "root job" for the same task of "update links of pages that use template X". * + * This does nothing for certain queue classes. + * * @param $job Job * @throws MWException * @return bool @@ -228,7 +234,9 @@ abstract class JobQueue { } /** - * Wait for any slaves or backup servers to catch up + * Wait for any slaves or backup servers to catch up. + * + * This does nothing for certain queue classes. * * @return void */ -- 2.20.1