1 | 1 |
deleted file mode 100644 |
... | ... |
@@ -1,152 +0,0 @@ |
1 |
-<?php |
|
2 |
- |
|
3 |
-namespace Illuminate\Contracts\Queue; |
|
4 |
- |
|
5 |
-interface Job |
|
6 |
-{ |
|
7 |
- /** |
|
8 |
- * Get the job identifier. |
|
9 |
- * |
|
10 |
- * @return string |
|
11 |
- */ |
|
12 |
- public function getJobId(); |
|
13 |
- |
|
14 |
- /** |
|
15 |
- * Get the decoded body of the job. |
|
16 |
- * |
|
17 |
- * @return array |
|
18 |
- */ |
|
19 |
- public function payload(); |
|
20 |
- |
|
21 |
- /** |
|
22 |
- * Fire the job. |
|
23 |
- * |
|
24 |
- * @return void |
|
25 |
- */ |
|
26 |
- public function fire(); |
|
27 |
- |
|
28 |
- /** |
|
29 |
- * Release the job back into the queue. |
|
30 |
- * |
|
31 |
- * Accepts a delay specified in seconds. |
|
32 |
- * |
|
33 |
- * @param int $delay |
|
34 |
- * @return void |
|
35 |
- */ |
|
36 |
- public function release($delay = 0); |
|
37 |
- |
|
38 |
- /** |
|
39 |
- * Determine if the job was released back into the queue. |
|
40 |
- * |
|
41 |
- * @return bool |
|
42 |
- */ |
|
43 |
- public function isReleased(); |
|
44 |
- |
|
45 |
- /** |
|
46 |
- * Delete the job from the queue. |
|
47 |
- * |
|
48 |
- * @return void |
|
49 |
- */ |
|
50 |
- public function delete(); |
|
51 |
- |
|
52 |
- /** |
|
53 |
- * Determine if the job has been deleted. |
|
54 |
- * |
|
55 |
- * @return bool |
|
56 |
- */ |
|
57 |
- public function isDeleted(); |
|
58 |
- |
|
59 |
- /** |
|
60 |
- * Determine if the job has been deleted or released. |
|
61 |
- * |
|
62 |
- * @return bool |
|
63 |
- */ |
|
64 |
- public function isDeletedOrReleased(); |
|
65 |
- |
|
66 |
- /** |
|
67 |
- * Get the number of times the job has been attempted. |
|
68 |
- * |
|
69 |
- * @return int |
|
70 |
- */ |
|
71 |
- public function attempts(); |
|
72 |
- |
|
73 |
- /** |
|
74 |
- * Determine if the job has been marked as a failure. |
|
75 |
- * |
|
76 |
- * @return bool |
|
77 |
- */ |
|
78 |
- public function hasFailed(); |
|
79 |
- |
|
80 |
- /** |
|
81 |
- * Mark the job as "failed". |
|
82 |
- * |
|
83 |
- * @return void |
|
84 |
- */ |
|
85 |
- public function markAsFailed(); |
|
86 |
- |
|
87 |
- /** |
|
88 |
- * Delete the job, call the "failed" method, and raise the failed job event. |
|
89 |
- * |
|
90 |
- * @param \Throwable|null $e |
|
91 |
- * @return void |
|
92 |
- */ |
|
93 |
- public function fail($e = null); |
|
94 |
- |
|
95 |
- /** |
|
96 |
- * Get the number of times to attempt a job. |
|
97 |
- * |
|
98 |
- * @return int|null |
|
99 |
- */ |
|
100 |
- public function maxTries(); |
|
101 |
- |
|
102 |
- /** |
|
103 |
- * Get the number of seconds the job can run. |
|
104 |
- * |
|
105 |
- * @return int|null |
|
106 |
- */ |
|
107 |
- public function timeout(); |
|
108 |
- |
|
109 |
- /** |
|
110 |
- * Get the timestamp indicating when the job should timeout. |
|
111 |
- * |
|
112 |
- * @return int|null |
|
113 |
- */ |
|
114 |
- public function timeoutAt(); |
|
115 |
- |
|
116 |
- /** |
|
117 |
- * Get the name of the queued job class. |
|
118 |
- * |
|
119 |
- * @return string |
|
120 |
- */ |
|
121 |
- public function getName(); |
|
122 |
- |
|
123 |
- /** |
|
124 |
- * Get the resolved name of the queued job class. |
|
125 |
- * |
|
126 |
- * Resolves the name of "wrapped" jobs such as class-based handlers. |
|
127 |
- * |
|
128 |
- * @return string |
|
129 |
- */ |
|
130 |
- public function resolveName(); |
|
131 |
- |
|
132 |
- /** |
|
133 |
- * Get the name of the connection the job belongs to. |
|
134 |
- * |
|
135 |
- * @return string |
|
136 |
- */ |
|
137 |
- public function getConnectionName(); |
|
138 |
- |
|
139 |
- /** |
|
140 |
- * Get the name of the queue the job belongs to. |
|
141 |
- * |
|
142 |
- * @return string |
|
143 |
- */ |
|
144 |
- public function getQueue(); |
|
145 |
- |
|
146 |
- /** |
|
147 |
- * Get the raw body string for the job. |
|
148 |
- * |
|
149 |
- * @return string |
|
150 |
- */ |
|
151 |
- public function getRawBody(); |
|
152 |
-} |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,152 @@ |
1 |
+<?php |
|
2 |
+ |
|
3 |
+namespace Illuminate\Contracts\Queue; |
|
4 |
+ |
|
5 |
+interface Job |
|
6 |
+{ |
|
7 |
+ /** |
|
8 |
+ * Get the job identifier. |
|
9 |
+ * |
|
10 |
+ * @return string |
|
11 |
+ */ |
|
12 |
+ public function getJobId(); |
|
13 |
+ |
|
14 |
+ /** |
|
15 |
+ * Get the decoded body of the job. |
|
16 |
+ * |
|
17 |
+ * @return array |
|
18 |
+ */ |
|
19 |
+ public function payload(); |
|
20 |
+ |
|
21 |
+ /** |
|
22 |
+ * Fire the job. |
|
23 |
+ * |
|
24 |
+ * @return void |
|
25 |
+ */ |
|
26 |
+ public function fire(); |
|
27 |
+ |
|
28 |
+ /** |
|
29 |
+ * Release the job back into the queue. |
|
30 |
+ * |
|
31 |
+ * Accepts a delay specified in seconds. |
|
32 |
+ * |
|
33 |
+ * @param int $delay |
|
34 |
+ * @return void |
|
35 |
+ */ |
|
36 |
+ public function release($delay = 0); |
|
37 |
+ |
|
38 |
+ /** |
|
39 |
+ * Determine if the job was released back into the queue. |
|
40 |
+ * |
|
41 |
+ * @return bool |
|
42 |
+ */ |
|
43 |
+ public function isReleased(); |
|
44 |
+ |
|
45 |
+ /** |
|
46 |
+ * Delete the job from the queue. |
|
47 |
+ * |
|
48 |
+ * @return void |
|
49 |
+ */ |
|
50 |
+ public function delete(); |
|
51 |
+ |
|
52 |
+ /** |
|
53 |
+ * Determine if the job has been deleted. |
|
54 |
+ * |
|
55 |
+ * @return bool |
|
56 |
+ */ |
|
57 |
+ public function isDeleted(); |
|
58 |
+ |
|
59 |
+ /** |
|
60 |
+ * Determine if the job has been deleted or released. |
|
61 |
+ * |
|
62 |
+ * @return bool |
|
63 |
+ */ |
|
64 |
+ public function isDeletedOrReleased(); |
|
65 |
+ |
|
66 |
+ /** |
|
67 |
+ * Get the number of times the job has been attempted. |
|
68 |
+ * |
|
69 |
+ * @return int |
|
70 |
+ */ |
|
71 |
+ public function attempts(); |
|
72 |
+ |
|
73 |
+ /** |
|
74 |
+ * Determine if the job has been marked as a failure. |
|
75 |
+ * |
|
76 |
+ * @return bool |
|
77 |
+ */ |
|
78 |
+ public function hasFailed(); |
|
79 |
+ |
|
80 |
+ /** |
|
81 |
+ * Mark the job as "failed". |
|
82 |
+ * |
|
83 |
+ * @return void |
|
84 |
+ */ |
|
85 |
+ public function markAsFailed(); |
|
86 |
+ |
|
87 |
+ /** |
|
88 |
+ * Delete the job, call the "failed" method, and raise the failed job event. |
|
89 |
+ * |
|
90 |
+ * @param \Throwable|null $e |
|
91 |
+ * @return void |
|
92 |
+ */ |
|
93 |
+ public function fail($e = null); |
|
94 |
+ |
|
95 |
+ /** |
|
96 |
+ * Get the number of times to attempt a job. |
|
97 |
+ * |
|
98 |
+ * @return int|null |
|
99 |
+ */ |
|
100 |
+ public function maxTries(); |
|
101 |
+ |
|
102 |
+ /** |
|
103 |
+ * Get the number of seconds the job can run. |
|
104 |
+ * |
|
105 |
+ * @return int|null |
|
106 |
+ */ |
|
107 |
+ public function timeout(); |
|
108 |
+ |
|
109 |
+ /** |
|
110 |
+ * Get the timestamp indicating when the job should timeout. |
|
111 |
+ * |
|
112 |
+ * @return int|null |
|
113 |
+ */ |
|
114 |
+ public function timeoutAt(); |
|
115 |
+ |
|
116 |
+ /** |
|
117 |
+ * Get the name of the queued job class. |
|
118 |
+ * |
|
119 |
+ * @return string |
|
120 |
+ */ |
|
121 |
+ public function getName(); |
|
122 |
+ |
|
123 |
+ /** |
|
124 |
+ * Get the resolved name of the queued job class. |
|
125 |
+ * |
|
126 |
+ * Resolves the name of "wrapped" jobs such as class-based handlers. |
|
127 |
+ * |
|
128 |
+ * @return string |
|
129 |
+ */ |
|
130 |
+ public function resolveName(); |
|
131 |
+ |
|
132 |
+ /** |
|
133 |
+ * Get the name of the connection the job belongs to. |
|
134 |
+ * |
|
135 |
+ * @return string |
|
136 |
+ */ |
|
137 |
+ public function getConnectionName(); |
|
138 |
+ |
|
139 |
+ /** |
|
140 |
+ * Get the name of the queue the job belongs to. |
|
141 |
+ * |
|
142 |
+ * @return string |
|
143 |
+ */ |
|
144 |
+ public function getQueue(); |
|
145 |
+ |
|
146 |
+ /** |
|
147 |
+ * Get the raw body string for the job. |
|
148 |
+ * |
|
149 |
+ * @return string |
|
150 |
+ */ |
|
151 |
+ public function getRawBody(); |
|
152 |
+} |