vendor/illuminate/contracts/Queue/Job.php

   1 <?php
   2
   3 namespace Illuminate\Contracts\Queue;
   4
   5 interface Job
   6 {
   7     /**
   8      * Fire the job.
   9      *
  10      * @return void
  11      */
  12     public function fire();
  13
  14     /**
  15      * Release the job back into the queue.
  16      *
  17      * @param  int   $delay
  18      * @return mixed
  19      */
  20     public function release($delay = 0);
  21
  22     /**
  23      * Delete the job from the queue.
  24      *
  25      * @return void
  26      */
  27     public function delete();
  28
  29     /**
  30      * Determine if the job has been deleted.
  31      *
  32      * @return bool
  33      */
  34     public function isDeleted();
  35
  36     /**
  37      * Determine if the job has been deleted or released.
  38      *
  39      * @return bool
  40      */
  41     public function isDeletedOrReleased();
  42
  43     /**
  44      * Get the number of times the job has been attempted.
  45      *
  46      * @return int
  47      */
  48     public function attempts();
  49
  50     /**
  51      * Process an exception that caused the job to fail.
  52      *
  53      * @param  \Throwable  $e
  54      * @return void
  55      */
  56     public function failed($e);
  57
  58     /**
  59      * Get the number of times to attempt a job.
  60      *
  61      * @return int|null
  62      */
  63     public function maxTries();
  64
  65     /**
  66      * Get the number of seconds the job can run.
  67      *
  68      * @return int|null
  69      */
  70     public function timeout();
  71
  72     /**
  73      * Get the timestamp indicating when the job should timeout.
  74      *
  75      * @return int|null
  76      */
  77     public function timeoutAt();
  78
  79     /**
  80      * Get the name of the queued job class.
  81      *
  82      * @return string
  83      */
  84     public function getName();
  85
  86     /**
  87      * Get the resolved name of the queued job class.
  88      *
  89      * Resolves the name of "wrapped" jobs such as class-based handlers.
  90      *
  91      * @return string
  92      */
  93     public function resolveName();
  94
  95     /**
  96      * Get the name of the connection the job belongs to.
  97      *
  98      * @return string
  99      */
 100     public function getConnectionName();
 101
 102     /**
 103      * Get the name of the queue the job belongs to.
 104      *
 105      * @return string
 106      */
 107     public function getQueue();
 108
 109     /**
 110      * Get the raw body string for the job.
 111      *
 112      * @return string
 113      */
 114     public function getRawBody();
 115 }