resque_ui 3.2.3 → 3.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/History.txt +5 -0
- data/VERSION.yml +1 -1
- data/app/views/resque/cleaner_list.html.erb +1 -1
- data/lib/resque_ui.rb +1 -0
- data/lib/resque_ui/overrides/resque/failure/redis.rb +11 -0
- data/rdoc/Object.html +147 -160
- data/rdoc/Redis.html +185 -0
- data/rdoc/Resque.html +148 -186
- data/rdoc/Resque/ChainedJobWithStatus.html +195 -214
- data/rdoc/Resque/Failure.html +134 -0
- data/rdoc/Resque/Failure/Redis.html +187 -0
- data/rdoc/Resque/Job.html +149 -162
- data/rdoc/Resque/JobWithStatus.html +351 -390
- data/rdoc/Resque/Status.html +265 -293
- data/rdoc/Resque/Worker.html +758 -851
- data/rdoc/ResqueScheduler.html +277 -306
- data/rdoc/ResqueUi.html +114 -136
- data/rdoc/ResqueUi/Cap.html +118 -128
- data/rdoc/ResqueUi/Engine.html +118 -128
- data/rdoc/created.rid +3 -2
- data/rdoc/images/add.png +0 -0
- data/rdoc/images/delete.png +0 -0
- data/rdoc/images/tag_blue.png +0 -0
- data/rdoc/images/transparent.png +0 -0
- data/rdoc/index.html +78 -166
- data/rdoc/js/darkfish.js +99 -62
- data/rdoc/js/jquery.js +15 -29
- data/rdoc/js/navigation.js +142 -0
- data/rdoc/js/search.js +94 -0
- data/rdoc/js/search_index.js +1 -0
- data/rdoc/js/searcher.js +228 -0
- data/rdoc/rdoc.css +119 -339
- data/rdoc/table_of_contents.html +196 -0
- data/resque_ui.gemspec +15 -2
- metadata +15 -2
|
@@ -1,291 +1,273 @@
|
|
|
1
|
-
|
|
2
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
3
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
-
<head>
|
|
6
|
-
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
|
1
|
+
<!DOCTYPE html>
|
|
7
2
|
|
|
8
|
-
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
9
6
|
|
|
10
|
-
|
|
7
|
+
<title>Class: Resque::JobWithStatus</title>
|
|
11
8
|
|
|
12
|
-
|
|
13
|
-
<script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
|
|
14
|
-
<script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
|
|
15
|
-
<script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
|
|
9
|
+
<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
|
|
16
10
|
|
|
17
|
-
|
|
18
|
-
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "../";
|
|
13
|
+
</script>
|
|
19
14
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
<a href="../index.html#methods">Methods</a>
|
|
27
|
-
</h3>
|
|
28
|
-
</div>
|
|
29
|
-
</div>
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
|
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
|
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
|
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
|
|
30
21
|
|
|
31
|
-
<div id="file-metadata">
|
|
32
|
-
<div id="file-list-section" class="section">
|
|
33
|
-
<h3 class="section-header">In Files</h3>
|
|
34
|
-
<div class="section-body">
|
|
35
|
-
<ul>
|
|
36
|
-
|
|
37
|
-
<li><a href="../lib/resque_ui/overrides/resque_status/job_with_status_rb.html?TB_iframe=true&height=550&width=785"
|
|
38
|
-
class="thickbox" title="lib/resque_ui/overrides/resque_status/job_with_status.rb">lib/resque_ui/overrides/resque_status/job_with_status.rb</a></li>
|
|
39
|
-
|
|
40
|
-
</ul>
|
|
41
|
-
</div>
|
|
42
|
-
</div>
|
|
43
22
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
23
|
+
<body id="top" class="class">
|
|
24
|
+
<nav id="metadata">
|
|
25
|
+
<nav id="home-section" class="section">
|
|
26
|
+
<h3 class="section-header">
|
|
27
|
+
<a href="../index.html">Home</a>
|
|
28
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
29
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
30
|
+
</h3>
|
|
31
|
+
</nav>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
+
<h3 class="section-header">
|
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
+
</h3>
|
|
40
|
+
</form>
|
|
41
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/resque_ui/overrides/resque_status/job_with_status.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
57
53
|
|
|
58
|
-
|
|
54
|
+
|
|
55
|
+
</div>
|
|
59
56
|
|
|
60
|
-
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
<nav id="parent-class-section" class="section">
|
|
60
|
+
<h3 class="section-header">Parent</h3>
|
|
61
|
+
|
|
62
|
+
<p class="link"><a href="../Object.html">Object</a>
|
|
63
|
+
|
|
64
|
+
</nav>
|
|
61
65
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
<ul class="link-list">
|
|
67
|
-
|
|
68
|
-
<li><a href="#method-c-enqueue">::enqueue</a></li>
|
|
69
|
-
|
|
70
|
-
<li><a href="#method-c-new">::new</a></li>
|
|
71
|
-
|
|
72
|
-
<li><a href="#method-c-perform">::perform</a></li>
|
|
73
|
-
|
|
74
|
-
<li><a href="#method-i-counter">#counter</a></li>
|
|
75
|
-
|
|
76
|
-
<li><a href="#method-i-incr_counter">#incr_counter</a></li>
|
|
77
|
-
|
|
78
|
-
<li><a href="#method-i-name">#name</a></li>
|
|
79
|
-
|
|
80
|
-
<li><a href="#method-i-pause-21">#pause!</a></li>
|
|
81
|
-
|
|
82
|
-
<li><a href="#method-i-safe_perform-21">#safe_perform!</a></li>
|
|
83
|
-
|
|
84
|
-
<li><a href="#method-i-tick">#tick</a></li>
|
|
85
|
-
|
|
86
|
-
</ul>
|
|
87
|
-
</div>
|
|
88
|
-
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<nav id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
89
70
|
|
|
90
|
-
|
|
91
|
-
|
|
71
|
+
<ul class="link-list">
|
|
72
|
+
|
|
73
|
+
<li><a href="#method-c-enqueue">::enqueue</a>
|
|
74
|
+
|
|
75
|
+
<li><a href="#method-c-new">::new</a>
|
|
76
|
+
|
|
77
|
+
<li><a href="#method-c-perform">::perform</a>
|
|
78
|
+
|
|
79
|
+
<li><a href="#method-i-counter">#counter</a>
|
|
80
|
+
|
|
81
|
+
<li><a href="#method-i-incr_counter">#incr_counter</a>
|
|
82
|
+
|
|
83
|
+
<li><a href="#method-i-name">#name</a>
|
|
84
|
+
|
|
85
|
+
<li><a href="#method-i-pause-21">#pause!</a>
|
|
86
|
+
|
|
87
|
+
<li><a href="#method-i-safe_perform-21">#safe_perform!</a>
|
|
88
|
+
|
|
89
|
+
<li><a href="#method-i-tick">#tick</a>
|
|
90
|
+
|
|
91
|
+
</ul>
|
|
92
|
+
</nav>
|
|
92
93
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
94
|
+
</div>
|
|
96
95
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
title="show/hide quicksearch" /></span></h3>
|
|
102
|
-
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
103
|
-
<fieldset>
|
|
104
|
-
<legend>Quicksearch</legend>
|
|
105
|
-
<input type="text" name="quicksearch" value=""
|
|
106
|
-
class="quicksearch-field" />
|
|
107
|
-
</fieldset>
|
|
108
|
-
</form>
|
|
96
|
+
<div id="project-metadata">
|
|
97
|
+
|
|
98
|
+
<nav id="classindex-section" class="section project-section">
|
|
99
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
109
100
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
101
|
+
<ul class="link-list">
|
|
102
|
+
|
|
103
|
+
<li><a href="../Resque.html">Resque</a>
|
|
104
|
+
|
|
105
|
+
<li><a href="../Resque/ChainedJobWithStatus.html">Resque::ChainedJobWithStatus</a>
|
|
106
|
+
|
|
107
|
+
<li><a href="../Resque/Failure.html">Resque::Failure</a>
|
|
108
|
+
|
|
109
|
+
<li><a href="../Resque/Failure/Redis.html">Resque::Failure::Redis</a>
|
|
110
|
+
|
|
111
|
+
<li><a href="../Resque/Job.html">Resque::Job</a>
|
|
112
|
+
|
|
113
|
+
<li><a href="../Resque/JobWithStatus.html">Resque::JobWithStatus</a>
|
|
114
|
+
|
|
115
|
+
<li><a href="../Resque/Status.html">Resque::Status</a>
|
|
116
|
+
|
|
117
|
+
<li><a href="../Resque/Worker.html">Resque::Worker</a>
|
|
118
|
+
|
|
119
|
+
<li><a href="../ResqueUi.html">ResqueUi</a>
|
|
120
|
+
|
|
121
|
+
<li><a href="../ResqueUi/Cap.html">ResqueUi::Cap</a>
|
|
122
|
+
|
|
123
|
+
<li><a href="../ResqueUi/Engine.html">ResqueUi::Engine</a>
|
|
124
|
+
|
|
125
|
+
<li><a href="../Object.html">Object</a>
|
|
126
|
+
|
|
127
|
+
<li><a href="../ResqueScheduler.html">ResqueScheduler</a>
|
|
128
|
+
|
|
129
|
+
</ul>
|
|
130
|
+
</nav>
|
|
137
131
|
|
|
138
|
-
|
|
139
|
-
</div>
|
|
140
132
|
</div>
|
|
133
|
+
</nav>
|
|
141
134
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
<div id="description" class="description">
|
|
146
|
-
|
|
147
|
-
</div><!-- description -->
|
|
135
|
+
<div id="documentation">
|
|
136
|
+
<h1 class="class">class Resque::JobWithStatus</h1>
|
|
148
137
|
|
|
138
|
+
<div id="description" class="description">
|
|
149
139
|
|
|
140
|
+
</div><!-- description -->
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
150
146
|
|
|
147
|
+
|
|
151
148
|
|
|
152
|
-
<div id="5Buntitled-5D" class="documentation-section">
|
|
153
|
-
|
|
154
149
|
|
|
155
|
-
|
|
150
|
+
|
|
156
151
|
|
|
157
|
-
|
|
152
|
+
|
|
153
|
+
<!-- Attributes -->
|
|
154
|
+
<section id="attribute-method-details" class="method-section section">
|
|
155
|
+
<h3 class="section-header">Attributes</h3>
|
|
158
156
|
|
|
159
157
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
158
|
+
<div id="attribute-i-worker" class="method-detail">
|
|
159
|
+
<div class="method-heading attribute-method-heading">
|
|
160
|
+
<span class="method-name">worker</span><span
|
|
161
|
+
class="attribute-access-type">[R]</span>
|
|
162
|
+
</div>
|
|
163
163
|
|
|
164
|
+
<div class="method-description">
|
|
165
|
+
|
|
164
166
|
|
|
165
|
-
<div id="worker-attribute-method" class="method-detail">
|
|
166
|
-
<a name="worker"></a>
|
|
167
|
-
|
|
168
|
-
<div class="method-heading attribute-method-heading">
|
|
169
|
-
<span class="method-name">worker</span><span
|
|
170
|
-
class="attribute-access-type">[R]</span>
|
|
171
|
-
</div>
|
|
172
|
-
|
|
173
|
-
<div class="method-description">
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
</div>
|
|
178
|
-
</div>
|
|
179
167
|
|
|
180
|
-
|
|
168
|
+
</div>
|
|
169
|
+
</div>
|
|
181
170
|
|
|
171
|
+
</section><!-- attribute-method-details -->
|
|
172
|
+
|
|
182
173
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
174
|
+
<!-- Methods -->
|
|
175
|
+
|
|
176
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
177
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
187
178
|
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
179
|
+
|
|
180
|
+
<div id="method-c-enqueue" class="method-detail ">
|
|
181
|
+
|
|
182
|
+
<div class="method-heading">
|
|
183
|
+
<span class="method-name">enqueue</span><span
|
|
184
|
+
class="method-args">(klass, options = {})</span>
|
|
185
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
186
|
+
</div>
|
|
187
|
+
|
|
191
188
|
|
|
189
|
+
<div class="method-description">
|
|
192
190
|
|
|
193
|
-
<
|
|
194
|
-
<span class="method-name">enqueue</span><span
|
|
195
|
-
class="method-args">(klass, options = {})</span>
|
|
196
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
197
|
-
</div>
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
<div class="method-description">
|
|
201
|
-
|
|
202
|
-
<p>Adds a job of type <tt>klass<tt> to the queue with
|
|
191
|
+
<p>Adds a job of type <tt>klass<tt> to the queue with
|
|
203
192
|
<tt>options<tt>. Returns the UUID of the job override to pass
|
|
204
193
|
actual parameters instead of a single hash, to make backward compatible
|
|
205
194
|
with existing resque jobs.</p>
|
|
206
|
-
|
|
195
|
+
|
|
207
196
|
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
<pre>
|
|
211
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 9</span>
|
|
197
|
+
|
|
198
|
+
<div class="method-source-code" id="enqueue-source">
|
|
199
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 9</span>
|
|
212
200
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">enqueue</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">options</span> = {})
|
|
213
201
|
<span class="ruby-identifier">uuid</span> = <span class="ruby-constant">Resque</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span>.<span class="ruby-identifier">create</span> <span class="ruby-value">:name</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{self.name}: #{options.inspect}"</span>
|
|
214
202
|
<span class="ruby-constant">Resque</span>.<span class="ruby-identifier">enqueue</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">uuid</span>, <span class="ruby-identifier">options</span>)
|
|
215
203
|
<span class="ruby-identifier">uuid</span>
|
|
216
204
|
<span class="ruby-keyword">end</span></pre>
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
</div>
|
|
220
|
-
|
|
205
|
+
</div><!-- enqueue-source -->
|
|
221
206
|
|
|
207
|
+
</div>
|
|
222
208
|
|
|
223
|
-
|
|
224
|
-
</div><!-- enqueue-method -->
|
|
209
|
+
|
|
225
210
|
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
211
|
+
|
|
212
|
+
</div><!-- enqueue-method -->
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<div id="method-c-new" class="method-detail ">
|
|
216
|
+
|
|
217
|
+
<div class="method-heading">
|
|
218
|
+
<span class="method-name">new</span><span
|
|
219
|
+
class="method-args">(uuid, worker = nil, options = {})</span>
|
|
220
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
221
|
+
</div>
|
|
222
|
+
|
|
229
223
|
|
|
224
|
+
<div class="method-description">
|
|
230
225
|
|
|
231
|
-
<
|
|
232
|
-
|
|
233
|
-
class="method-args">(uuid, worker = nil, options = {})</span>
|
|
234
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
235
|
-
</div>
|
|
226
|
+
<p>Create a new instance with <code>uuid</code> and <code>options</code>
|
|
227
|
+
OVERRIDE to add the worker attr</p>
|
|
236
228
|
|
|
237
229
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
<
|
|
241
|
-
add the worker attr</p>
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
<div class="method-source-code" id="new-source">
|
|
246
|
-
<pre>
|
|
247
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 45</span>
|
|
230
|
+
|
|
231
|
+
<div class="method-source-code" id="new-source">
|
|
232
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 45</span>
|
|
248
233
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">uuid</span>, <span class="ruby-identifier">worker</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span> = {})
|
|
249
234
|
<span class="ruby-ivar">@uuid</span> = <span class="ruby-identifier">uuid</span>
|
|
250
235
|
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
|
|
251
236
|
<span class="ruby-ivar">@worker</span> = <span class="ruby-identifier">worker</span>
|
|
252
237
|
<span class="ruby-keyword">end</span></pre>
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
</div>
|
|
256
|
-
|
|
238
|
+
</div><!-- new-source -->
|
|
257
239
|
|
|
240
|
+
</div>
|
|
258
241
|
|
|
259
|
-
|
|
260
|
-
</div><!-- new-method -->
|
|
242
|
+
|
|
261
243
|
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
<a name="method-c-perform"></a>
|
|
244
|
+
|
|
245
|
+
</div><!-- new-method -->
|
|
265
246
|
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
247
|
+
|
|
248
|
+
<div id="method-c-perform" class="method-detail ">
|
|
249
|
+
|
|
250
|
+
<div class="method-heading">
|
|
251
|
+
<span class="method-name">perform</span><span
|
|
252
|
+
class="method-args">(uuid=nil, options = {}) { || ... }</span>
|
|
253
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
254
|
+
</div>
|
|
255
|
+
|
|
273
256
|
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
257
|
+
<div class="method-description">
|
|
258
|
+
|
|
259
|
+
<p>This is the method called by <a href="Worker.html">Resque::Worker</a> when
|
|
277
260
|
processing jobs. It creates a new instance of the job class and populates
|
|
278
261
|
it with the uuid and options.</p>
|
|
279
262
|
|
|
280
|
-
<p>You should not override this method, rather the <
|
|
281
|
-
method. OVERRIDE to pass the block in order to set the worker
|
|
282
|
-
returns the worker object</p>
|
|
283
|
-
|
|
263
|
+
<p>You should not override this method, rather the <code>perform</code>
|
|
264
|
+
instance method. OVERRIDE to pass the block in order to set the worker
|
|
265
|
+
status, returns the worker object</p>
|
|
266
|
+
|
|
284
267
|
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
<pre>
|
|
288
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 57</span>
|
|
268
|
+
|
|
269
|
+
<div class="method-source-code" id="perform-source">
|
|
270
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 57</span>
|
|
289
271
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">perform</span>(<span class="ruby-identifier">uuid</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span> = {})
|
|
290
272
|
<span class="ruby-identifier">uuid</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Resque</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span>.<span class="ruby-identifier">generate_uuid</span>
|
|
291
273
|
<span class="ruby-identifier">worker</span> = <span class="ruby-keyword">yield</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
@@ -293,180 +275,165 @@ returns the worker object</p>
|
|
|
293
275
|
<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">safe_perform!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">status</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">status</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span> }
|
|
294
276
|
<span class="ruby-identifier">instance</span>
|
|
295
277
|
<span class="ruby-keyword">end</span></pre>
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
</div>
|
|
299
|
-
|
|
278
|
+
</div><!-- perform-source -->
|
|
300
279
|
|
|
280
|
+
</div>
|
|
301
281
|
|
|
302
|
-
|
|
303
|
-
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
</div><!-- perform-method -->
|
|
304
286
|
|
|
305
|
-
|
|
306
|
-
</div><!-- public-class-method-details -->
|
|
307
287
|
|
|
308
|
-
|
|
309
|
-
|
|
288
|
+
</section><!-- public-class-method-details -->
|
|
289
|
+
|
|
290
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
291
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
310
292
|
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
293
|
+
|
|
294
|
+
<div id="method-i-counter" class="method-detail ">
|
|
295
|
+
|
|
296
|
+
<div class="method-heading">
|
|
297
|
+
<span class="method-name">counter</span><span
|
|
298
|
+
class="method-args">(counter)</span>
|
|
299
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
300
|
+
</div>
|
|
301
|
+
|
|
314
302
|
|
|
303
|
+
<div class="method-description">
|
|
304
|
+
|
|
315
305
|
|
|
316
|
-
<div class="method-heading">
|
|
317
|
-
<span class="method-name">counter</span><span
|
|
318
|
-
class="method-args">(counter)</span>
|
|
319
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
320
|
-
</div>
|
|
321
306
|
|
|
322
307
|
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
<div class="method-source-code" id="counter-source">
|
|
330
|
-
<pre>
|
|
331
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 99</span>
|
|
308
|
+
|
|
309
|
+
<div class="method-source-code" id="counter-source">
|
|
310
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 99</span>
|
|
332
311
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">counter</span>(<span class="ruby-identifier">counter</span>)
|
|
333
312
|
<span class="ruby-constant">Resque</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span>.<span class="ruby-identifier">counter</span>(<span class="ruby-identifier">counter</span>, <span class="ruby-identifier">uuid</span>)
|
|
334
313
|
<span class="ruby-keyword">end</span></pre>
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
</div>
|
|
338
|
-
|
|
314
|
+
</div><!-- counter-source -->
|
|
339
315
|
|
|
316
|
+
</div>
|
|
340
317
|
|
|
341
|
-
|
|
342
|
-
</div><!-- counter-method -->
|
|
318
|
+
|
|
343
319
|
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
320
|
+
|
|
321
|
+
</div><!-- counter-method -->
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
<div id="method-i-incr_counter" class="method-detail ">
|
|
325
|
+
|
|
326
|
+
<div class="method-heading">
|
|
327
|
+
<span class="method-name">incr_counter</span><span
|
|
328
|
+
class="method-args">(counter)</span>
|
|
329
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
330
|
+
</div>
|
|
331
|
+
|
|
347
332
|
|
|
333
|
+
<div class="method-description">
|
|
334
|
+
|
|
348
335
|
|
|
349
|
-
<div class="method-heading">
|
|
350
|
-
<span class="method-name">incr_counter</span><span
|
|
351
|
-
class="method-args">(counter)</span>
|
|
352
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
353
|
-
</div>
|
|
354
336
|
|
|
355
337
|
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
<div class="method-source-code" id="incr_counter-source">
|
|
363
|
-
<pre>
|
|
364
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 95</span>
|
|
338
|
+
|
|
339
|
+
<div class="method-source-code" id="incr_counter-source">
|
|
340
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 95</span>
|
|
365
341
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">incr_counter</span>(<span class="ruby-identifier">counter</span>)
|
|
366
342
|
<span class="ruby-constant">Resque</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span>.<span class="ruby-identifier">incr_counter</span>(<span class="ruby-identifier">counter</span>, <span class="ruby-identifier">uuid</span>)
|
|
367
343
|
<span class="ruby-keyword">end</span></pre>
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
</div>
|
|
371
|
-
|
|
344
|
+
</div><!-- incr_counter-source -->
|
|
372
345
|
|
|
346
|
+
</div>
|
|
373
347
|
|
|
374
|
-
|
|
375
|
-
</div><!-- incr_counter-method -->
|
|
348
|
+
|
|
376
349
|
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
350
|
+
|
|
351
|
+
</div><!-- incr_counter-method -->
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<div id="method-i-name" class="method-detail ">
|
|
355
|
+
|
|
356
|
+
<div class="method-heading">
|
|
357
|
+
<span class="method-name">name</span><span
|
|
358
|
+
class="method-args">()</span>
|
|
359
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
360
|
+
</div>
|
|
361
|
+
|
|
380
362
|
|
|
363
|
+
<div class="method-description">
|
|
364
|
+
|
|
381
365
|
|
|
382
|
-
<div class="method-heading">
|
|
383
|
-
<span class="method-name">name</span><span
|
|
384
|
-
class="method-args">()</span>
|
|
385
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
386
|
-
</div>
|
|
387
366
|
|
|
388
367
|
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
<div class="method-source-code" id="name-source">
|
|
396
|
-
<pre>
|
|
397
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 91</span>
|
|
368
|
+
|
|
369
|
+
<div class="method-source-code" id="name-source">
|
|
370
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 91</span>
|
|
398
371
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">name</span>
|
|
399
372
|
<span class="ruby-node">"#{self.class.name}: #{options.inspect}"</span>
|
|
400
373
|
<span class="ruby-keyword">end</span></pre>
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
</div>
|
|
404
|
-
|
|
374
|
+
</div><!-- name-source -->
|
|
405
375
|
|
|
376
|
+
</div>
|
|
406
377
|
|
|
407
|
-
|
|
408
|
-
</div><!-- name-method -->
|
|
378
|
+
|
|
409
379
|
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
380
|
+
|
|
381
|
+
</div><!-- name-method -->
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
<div id="method-i-pause-21" class="method-detail ">
|
|
385
|
+
|
|
386
|
+
<div class="method-heading">
|
|
387
|
+
<span class="method-name">pause!</span><span
|
|
388
|
+
class="method-args">()</span>
|
|
389
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
390
|
+
</div>
|
|
391
|
+
|
|
413
392
|
|
|
393
|
+
<div class="method-description">
|
|
414
394
|
|
|
415
|
-
<
|
|
416
|
-
<span class="method-name">pause!</span><span
|
|
417
|
-
class="method-args">()</span>
|
|
418
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
419
|
-
</div>
|
|
395
|
+
<p>Pause the current job, setting the status to ‘paused’</p>
|
|
420
396
|
|
|
421
397
|
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
<
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
<div class="method-source-code" id="pause-21-source">
|
|
429
|
-
<pre>
|
|
430
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 36</span>
|
|
398
|
+
|
|
399
|
+
<div class="method-source-code" id="pause-21-source">
|
|
400
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 36</span>
|
|
431
401
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">pause!</span>
|
|
432
402
|
<span class="ruby-identifier">set_status</span>({
|
|
433
403
|
<span class="ruby-string">'status'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'paused'</span>,
|
|
434
404
|
<span class="ruby-string">'message'</span> =<span class="ruby-operator">></span> <span class="ruby-node">"#{worker} paused at #{Time.now}"</span>
|
|
435
405
|
})
|
|
436
406
|
<span class="ruby-keyword">end</span></pre>
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
</div>
|
|
440
|
-
|
|
407
|
+
</div><!-- pause-21-source -->
|
|
441
408
|
|
|
409
|
+
</div>
|
|
442
410
|
|
|
443
|
-
|
|
444
|
-
</div><!-- pause-21-method -->
|
|
411
|
+
|
|
445
412
|
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
413
|
+
|
|
414
|
+
</div><!-- pause-21-method -->
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
<div id="method-i-safe_perform-21" class="method-detail ">
|
|
418
|
+
|
|
419
|
+
<div class="method-heading">
|
|
420
|
+
<span class="method-name">safe_perform!</span><span
|
|
421
|
+
class="method-args">() { |status| ... }</span>
|
|
422
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
423
|
+
</div>
|
|
424
|
+
|
|
449
425
|
|
|
426
|
+
<div class="method-description">
|
|
450
427
|
|
|
451
|
-
<
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
</div>
|
|
428
|
+
<p>Run by the <a href="Worker.html">Resque::Worker</a> when processing this
|
|
429
|
+
job. It wraps the <code>perform</code> method ensuring that the final
|
|
430
|
+
status of the job is set regardless of error. If an error occurs within the
|
|
431
|
+
job’s work, it will set the status as failed and re-raise the error.</p>
|
|
456
432
|
|
|
457
433
|
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
<
|
|
461
|
-
job. It wraps the <tt>perform</tt> method ensuring that the final status of
|
|
462
|
-
the job is set regardless of error. If an error occurs within the job’s
|
|
463
|
-
work, it will set the status as failed and re-raise the error.</p>
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
<div class="method-source-code" id="safe_perform-21-source">
|
|
468
|
-
<pre>
|
|
469
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 69</span>
|
|
434
|
+
|
|
435
|
+
<div class="method-source-code" id="safe_perform-21-source">
|
|
436
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 69</span>
|
|
470
437
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">safe_perform!</span>
|
|
471
438
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">should_kill?</span> <span class="ruby-operator">||</span> (<span class="ruby-identifier">status</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">killed?</span>)
|
|
472
439
|
<span class="ruby-identifier">set_status</span>({<span class="ruby-string">'status'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'working'</span>})
|
|
@@ -488,39 +455,36 @@ work, it will set the status as failed and re-raise the error.</p>
|
|
|
488
455
|
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
|
|
489
456
|
<span class="ruby-keyword">end</span>
|
|
490
457
|
<span class="ruby-keyword">end</span></pre>
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
</div>
|
|
494
|
-
|
|
458
|
+
</div><!-- safe_perform-21-source -->
|
|
495
459
|
|
|
460
|
+
</div>
|
|
496
461
|
|
|
497
|
-
|
|
498
|
-
</div><!-- safe_perform-21-method -->
|
|
462
|
+
|
|
499
463
|
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
<a name="method-i-tick"></a>
|
|
464
|
+
|
|
465
|
+
</div><!-- safe_perform-21-method -->
|
|
503
466
|
|
|
467
|
+
|
|
468
|
+
<div id="method-i-tick" class="method-detail ">
|
|
469
|
+
|
|
470
|
+
<div class="method-heading">
|
|
471
|
+
<span class="method-name">tick</span><span
|
|
472
|
+
class="method-args">(*messages)</span>
|
|
473
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
<div class="method-description">
|
|
504
478
|
|
|
505
|
-
<
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
</div>
|
|
479
|
+
<p>sets the status of the job for the current iteration. You should use the
|
|
480
|
+
<code>at</code> method if you have actual numbers to track the iteration
|
|
481
|
+
count. This will kill the job if it has been added to the kill list with
|
|
482
|
+
<code>Resque::Status.kill()</code></p>
|
|
510
483
|
|
|
511
484
|
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
<
|
|
515
|
-
<tt>at</tt> method if you have actual numbers to track the iteration count.
|
|
516
|
-
This will kill the job if it has been added to the kill list with
|
|
517
|
-
<tt>Resque::Status.kill()</tt></p>
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
<div class="method-source-code" id="tick-source">
|
|
522
|
-
<pre>
|
|
523
|
-
<span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 19</span>
|
|
485
|
+
|
|
486
|
+
<div class="method-source-code" id="tick-source">
|
|
487
|
+
<pre><span class="ruby-comment"># File lib/resque_ui/overrides/resque_status/job_with_status.rb, line 19</span>
|
|
524
488
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">tick</span>(*<span class="ruby-identifier">messages</span>)
|
|
525
489
|
<span class="ruby-identifier">kill!</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">should_kill?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">killed?</span>
|
|
526
490
|
<span class="ruby-identifier">set_status</span>({<span class="ruby-string">'status'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'working'</span>}, *<span class="ruby-identifier">messages</span>)
|
|
@@ -536,29 +500,26 @@ This will kill the job if it has been added to the kill list with
|
|
|
536
500
|
<span class="ruby-identifier">set_status</span>({<span class="ruby-string">'status'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'working'</span>}, *<span class="ruby-identifier">messages</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">&&</span> (<span class="ruby-identifier">status</span>.<span class="ruby-identifier">completed?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">paused?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">killed?</span>)
|
|
537
501
|
<span class="ruby-keyword">end</span>
|
|
538
502
|
<span class="ruby-keyword">end</span></pre>
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
</div>
|
|
542
|
-
|
|
503
|
+
</div><!-- tick-source -->
|
|
543
504
|
|
|
505
|
+
</div>
|
|
544
506
|
|
|
545
|
-
|
|
546
|
-
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</div><!-- tick-method -->
|
|
547
511
|
|
|
548
|
-
|
|
549
|
-
</div><!-- public-instance-method-details -->
|
|
550
512
|
|
|
551
|
-
</
|
|
513
|
+
</section><!-- public-instance-method-details -->
|
|
552
514
|
|
|
515
|
+
</section><!-- 5Buntitled-5D -->
|
|
553
516
|
|
|
554
|
-
|
|
517
|
+
</div><!-- documentation -->
|
|
555
518
|
|
|
556
|
-
<div id="validator-badges">
|
|
557
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
558
|
-
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
559
|
-
Rdoc Generator</a> 2</small>.</p>
|
|
560
|
-
</div>
|
|
561
519
|
|
|
562
|
-
|
|
563
|
-
</
|
|
520
|
+
<footer id="validator-badges">
|
|
521
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
522
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
|
|
523
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
524
|
+
</footer>
|
|
564
525
|
|