From: Alex Rousskov Date: Mon, 19 Jul 2010 16:10:25 +0000 (-0600) Subject: More AsyncJob rules based on squid-dev reviews: X-Git-Tag: SQUID_3_2_0_1~49 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3071d963281d966097d467ae249ebbe85620e2e8;p=thirdparty%2Fsquid.git More AsyncJob rules based on squid-dev reviews: - You must implement start() and doneAll() methods. - In doneAll(), always call doneAll() of the parent. --- diff --git a/src/base/AsyncJobs.dox b/src/base/AsyncJobs.dox index 9cf5c3d508..296ed81f4d 100644 --- a/src/base/AsyncJobs.dox +++ b/src/base/AsyncJobs.dox @@ -84,6 +84,12 @@ one parameter ("data") or two simple parameters. cleaning up your job. It does not matter whether the [current] parent swanSong() does nothing. +- You must implement start() and doneAll() methods. These methods may be +marked as pure virtual in future releases. + +- In doneAll(), always call doneAll() of the parent. If the parent is not +done, you are not done. It does not matter whether the [current] parent +doneAll() always returns true. - If a job does not have a doneAll() method implemented, it is probably buggy. Any job must know what it wants to accomplish. Please note that