- * Given a key (any string) and the number of lots, returns a slot number (an integer from the [0..($slots-1)] range).
- * This is used for a global limit on the number of instances of a given type that can acquire a lock.
- * The hashing is deterministic so that PoolCounter::$workers is always an upper limit of how many instances with
- * the same key can acquire a lock.
+ * Checks that the lock request is sane.
+ * @return Status - good for sane requests fatal for insane
+ * @since 1.25
+ */
+ final protected function precheckAcquire() {
+ if ( $this->isMightWaitKey ) {
+ if ( self::$acquiredMightWaitKey ) {
+ /*
+ * The poolcounter itself is quite happy to allow you to wait
+ * on another lock while you have a lock you waited on already
+ * but we think that it is unlikely to be a good idea. So we
+ * made it an error. If you are _really_ _really_ sure it is a
+ * good idea then feel free to implement an unsafe flag or
+ * something.
+ */
+ return Status::newFatal( 'poolcounter-usage-error',
+ 'You may only aquire a single non-nowait lock.' );
+ }
+ } elseif ( $this->timeout !== 0 ) {
+ return Status::newFatal( 'poolcounter-usage-error',
+ 'Locks starting in nowait: must have 0 timeout.' );
+ }
+ return Status::newGood();
+ }
+
+ /**
+ * Update any lock tracking information when the lock is acquired
+ * @since 1.25
+ */
+ final protected function onAcquire() {
+ self::$acquiredMightWaitKey |= $this->isMightWaitKey;
+ }
+
+ /**
+ * Update any lock tracking information when the lock is released
+ * @since 1.25
+ */
+ final protected function onRelease() {
+ self::$acquiredMightWaitKey &= !$this->isMightWaitKey;
+ }
+
+ /**
+ * Given a key (any string) and the number of lots, returns a slot number (an integer from
+ * the [0..($slots-1)] range). This is used for a global limit on the number of instances of
+ * a given type that can acquire a lock. The hashing is deterministic so that
+ * PoolCounter::$workers is always an upper limit of how many instances with the same key
+ * can acquire a lock.