[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/infrastructure/daemon/workers/ -> PhabricatorWorker.php (summary)

(no description)

File Size: 255 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 13 functions

  getRequiredLeaseTime()
  getMaximumRetryCount()
  getWaitBeforeRetry()
  __construct()
  getTaskData()
  executeTask()
  scheduleTask()
  waitForTasks()
  renderForDisplay()
  setRunAllTasksInProcess()
  log()
  queueTask()
  getQueuedTasks()

Functions
Functions that are not part of a class:

getRequiredLeaseTime()   X-Ref
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).

For tasks which may take a very long time to complete, you should return
an upper bound on the amount of time the task may require.

return: int|null  Number of seconds this task needs to remain leased for,

getMaximumRetryCount()   X-Ref
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.

return: int|null  Number of times the task will retry before permanent

getWaitBeforeRetry(PhabricatorWorkerTask $task)   X-Ref
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).

param: PhabricatorWorkerTask  The task itself. This object is probably
return: int|null               Number of seconds to wait between retries,

__construct($data)   X-Ref
No description

getTaskData()   X-Ref
No description

executeTask()   X-Ref
No description

scheduleTask($task_class,$data,$priority = null)   X-Ref
No description

waitForTasks(array $task_ids)   X-Ref
Wait for tasks to complete. If tasks are not leased by other workers, they
will be executed in this process while waiting.

param: list<int>   List of queued task IDs to wait for.
return: void

renderForDisplay(PhabricatorUser $viewer)   X-Ref
No description

setRunAllTasksInProcess($all)   X-Ref
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.


log($pattern )   X-Ref
No description

queueTask($class, array $data, $priority = null)   X-Ref
Queue a task to be executed after this one succeeds.

The followup task will be queued only if this task completes cleanly.

param: string    Task class to queue.
param: array     Data for the followup task.
param: int|null  Priority for the followup task.
return: this

getQueuedTasks()   X-Ref
Get tasks queued as followups by @{method:queueTask}.

return: list<tuple<string, wild, int|null>> Queued task specifications.



Generated: Sun Nov 30 09:20:46 2014 Cross-referenced by PHPXref 0.7.1