Configuring Retries and Failures
Configuring Retries and Failures
- public function getRequiredLeaseTime() — Return the number of seconds this worker needs hold a lease on the task for while it performs work. For most tasks you can leave this at `null`, which will give you a default lease (currently 2 hours).
- public function getMaximumRetryCount() — Return the maximum number of times this task may be retried before it is considered permanently failed. By default, tasks retry indefinitely. You can throw a @{class:PhabricatorWorkerPermanentFailureException} to cause an immediate permanent failure.
- public function getWaitBeforeRetry($task) — Return the number of seconds a task should wait after a failure before retrying. For most tasks you can leave this at `null`, which will give you a short default retry period (currently 60 seconds).
Updating Leases
Updating Leases
- private function handleUpdate($lease)
- private function updateLease($lease)
- private function yieldLease($lease, $ex)
Processing Commands
Processing Commands
- private function processLeaseCommands($lease)
- private function processLeaseCommand($lease, $command)
Drydock Allocator
Drydock Allocator
- private function executeAllocator($lease) — Find or build a resource which can satisfy a given lease request, then acquire the lease.
- private function loadBlueprintImplementationsForAllocatingLease($lease) — Get all the @{class:DrydockBlueprintImplementation}s which can possibly build a resource to satisfy a lease.
- private function loadBlueprintsForAllocatingLease($lease) — Get all the concrete @{class:DrydockBlueprint}s which can possibly build a resource to satisfy a lease.
- private function loadResourcesForAllocatingLease($blueprints, $lease) — Load a list of all resources which a given lease can possibly be allocated against.
- private function removeUnacquirableResources($resources, $lease) — Remove resources which can not be acquired by a given lease from a list.
- private function removeOverallocatedBlueprints($blueprints, $lease) — Remove blueprints which are too heavily allocated to build a resource for a lease from a list of blueprints.
- private function rankBlueprints($blueprints, $lease) — Rank blueprints by suitability for building a new resource for a particular lease.
- private function rankResources($resources, $lease) — Rank resources by suitability for allocating a particular lease.
- private function allocateResource($blueprint, $lease) — Perform an actual resource allocation with a particular blueprint.
- private function validateAllocatedResource($blueprint, $resource, $lease) — Check that the resource a blueprint allocated is roughly the sort of object we expect.
Acquiring Leases
Acquiring Leases
- private function acquireLease($resource, $lease) — Perform an actual lease acquisition on a particular resource.
- private function validateAcquiredLease($blueprint, $resource, $lease) — Make sure that a lease was really acquired properly.
Activating Leases
Activating Leases
- private function activateLease($lease)
- private function validateActivatedLease($blueprint, $resource, $lease)
Releasing Leases
Releasing Leases
- private function releaseLease($lease)
Breaking Leases
Breaking Leases
- protected function breakLease($lease, $ex)
Destroying Leases
Destroying Leases
- private function destroyLease($lease)
Other Methods
Other Methods
- public function setCurrentWorkerTask($task)
- public function getCurrentWorkerTask()
- public function getCurrentWorkerTaskID()
- protected function doWork()
- final public function __construct($data)
- final protected function getTaskData()
- final protected function getTaskDataValue($key, $default)
- final public function executeTask()
- final public static function scheduleTask($task_class, $data, $options)
- public function renderForDisplay($viewer)
- public static function setRunAllTasksInProcess($all) — Set this flag to execute scheduled tasks synchronously, in the same process. This is useful for debugging, and otherwise dramatically worse in every way imaginable.
- final protected function log($pattern)
- final protected function queueTask($class, $data, $options) — Queue a task to be executed after this one succeeds.
- final protected function getQueuedTasks() — Get tasks queued as followups by @{method:queueTask}.
- final public function flushTaskQueue($defaults) — Schedule any queued tasks, then empty the task queue.
- final public static function awakenTaskIDs($ids) — Awaken tasks that have yielded.
- protected function newContentSource()
- protected function getViewer()
- protected function loadLease($lease_phid)
- protected function loadResource($resource_phid)
- protected function loadOperation($operation_phid)
- protected function loadCommands($target_phid)
- protected function checkLeaseExpiration($lease)
- protected function checkResourceExpiration($resource)
- private function checkObjectExpiration($object)
- protected function yieldIfExpiringLease($lease)
- protected function yieldIfExpiringResource($resource)
- private function yieldIfExpiring($expires)
- protected function isTemporaryException($ex)
- protected function getYieldDurationFromException($ex)
- protected function flushDrydockTaskQueue()
- protected function canReclaimResource($resource)
- protected function reclaimResource($resource, $lease)
- private function reclaimResources($blueprint, $lease)
- private function newResourceForAcquisition($resource, $lease)