author | Jan Vrany <jan.vrany@fit.cvut.cz> |
Wed, 07 Sep 2011 14:10:12 +0200 | |
changeset 2637 | 41e0362d5631 |
parent 2612 | 922aa3063807 |
child 2696 | 689bb9231455 |
permissions | -rw-r--r-- |
2573 | 1 |
" |
2575 | 2 |
COPYRIGHT (c) 2010 by Jan Vrany, SWING Research Group. CTU in Prague |
2587 | 3 |
All Rights Reserved |
2573 | 4 |
|
2575 | 5 |
Permission is hereby granted, free of charge, to any person |
6 |
obtaining a copy of this software and associated documentation |
|
7 |
files (the 'Software'), to deal in the Software without |
|
8 |
restriction, including without limitation the rights to use, |
|
9 |
copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
10 |
copies of the Software, and to permit persons to whom the |
|
11 |
Software is furnished to do so, subject to the following |
|
12 |
conditions: |
|
13 |
||
14 |
The above copyright notice and this permission notice shall be |
|
15 |
included in all copies or substantial portions of the Software. |
|
16 |
||
17 |
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
|
18 |
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES |
|
19 |
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
|
20 |
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
21 |
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
|
22 |
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
23 |
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
|
24 |
OTHER DEALINGS IN THE SOFTWARE. |
|
2573 | 25 |
" |
2587 | 26 |
"{ Package: 'stx:libbasic2' }" |
2573 | 27 |
|
28 |
BackgroundJob subclass:#BackgroundQueueProcessingJob |
|
29 |
instanceVariableNames:'queue queueAccessLock' |
|
30 |
classVariableNames:'' |
|
31 |
poolDictionaries:'' |
|
2591 | 32 |
category:'System-Support' |
2573 | 33 |
! |
34 |
||
35 |
!BackgroundQueueProcessingJob class methodsFor:'documentation'! |
|
36 |
||
37 |
copyright |
|
38 |
" |
|
2575 | 39 |
COPYRIGHT (c) 2010 by Jan Vrany, SWING Research Group. CTU in Prague |
2587 | 40 |
All Rights Reserved |
2573 | 41 |
|
2575 | 42 |
Permission is hereby granted, free of charge, to any person |
43 |
obtaining a copy of this software and associated documentation |
|
44 |
files (the 'Software'), to deal in the Software without |
|
45 |
restriction, including without limitation the rights to use, |
|
46 |
copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
47 |
copies of the Software, and to permit persons to whom the |
|
48 |
Software is furnished to do so, subject to the following |
|
49 |
conditions: |
|
50 |
||
51 |
The above copyright notice and this permission notice shall be |
|
52 |
included in all copies or substantial portions of the Software. |
|
53 |
||
54 |
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
|
55 |
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES |
|
56 |
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
|
57 |
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
58 |
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
|
59 |
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
60 |
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
|
61 |
OTHER DEALINGS IN THE SOFTWARE. |
|
2573 | 62 |
" |
2601
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
63 |
! |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
64 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
65 |
documentation |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
66 |
" |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
67 |
A BackgroundQueueProcessingJob is a specialized form |
2612 | 68 |
of a BackgroundJob for background processing of a queue. |
2601
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
69 |
Each item in the queue (added by sending #add: item) |
2612 | 70 |
is processed (using the instance variable job). |
2601
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
71 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
72 |
Implementation notes: |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
73 |
The thread is running only if there is at least one item |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
74 |
to process. When the queue is empty, the thread teminates. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
75 |
It is started again when a new item is added to the queue. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
76 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
77 |
[author:] |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
78 |
Jan Vrany <jan.vrany@fit.cvut.cz> |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
79 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
80 |
[instance variables:] |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
81 |
queue <OrderedCollection> the queue of items to be procesed |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
82 |
queueAccessLock<RecursionLock> a lock used to synchronize |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
83 |
access to the queue |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
84 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
85 |
[class variables:] |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
86 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
87 |
[see also:] |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
88 |
BackgroundJob |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
89 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
90 |
" |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
91 |
! |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
92 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
93 |
examples |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
94 |
" |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
95 |
| job text | |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
96 |
job := BackgroundQueueProcessingJob named: 'example job' on:[:text| |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
97 |
Delay waitForSeconds: 3. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
98 |
Transcript showCR:'One guy said: ', text |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
99 |
]. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
100 |
job add:'Hello world'. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
101 |
Delay waitForSeconds: 5. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
102 |
job add:'Ahoj Svete!!'. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
103 |
job restart. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
104 |
Delay waitForSeconds: 1. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
105 |
job add:'Haya, looks like proper queue, you should see all greetings'. |
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
106 |
|
55c6a3887ebf
Added documentation and examples
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2591
diff
changeset
|
107 |
" |
2573 | 108 |
! ! |
109 |
||
110 |
!BackgroundQueueProcessingJob methodsFor:'adding & removing'! |
|
111 |
||
112 |
add: object |
|
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
113 |
|
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
114 |
^self add: object at: nil |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
115 |
|
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
116 |
"Created: / 28-04-2011 / 20:40:29 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
117 |
"Modified (format): / 03-08-2011 / 16:43:01 / cg" |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
118 |
"Modified: / 07-09-2011 / 12:35:24 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
119 |
! |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
120 |
|
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
121 |
add: object at: index |
2573 | 122 |
"includes: is not synchronized, but should not harm" |
123 |
||
124 |
queueAccessLock critical:[ |
|
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
125 |
(queue includes: object) ifFalse:[ |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
126 |
index notNil ifTrue:[ |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
127 |
queue add: object at: index |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
128 |
] ifFalse:[ |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
129 |
queue add: object |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
130 |
] |
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
131 |
]. |
2589 | 132 |
self start |
133 |
]. |
|
2573 | 134 |
|
2589 | 135 |
"Modified (format): / 03-08-2011 / 16:43:01 / cg" |
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
136 |
"Created: / 07-09-2011 / 12:34:22 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
2573 | 137 |
! ! |
138 |
||
139 |
!BackgroundQueueProcessingJob methodsFor:'initialization'! |
|
140 |
||
141 |
initialize |
|
142 |
"Invoked when a new instance is created." |
|
143 |
||
2584
a6cbe910605d
- CodeHighlightingService refactored to use
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2575
diff
changeset
|
144 |
super initialize. |
2573 | 145 |
queue := OrderedCollection new. |
146 |
queueAccessLock := RecursionLock new. |
|
147 |
||
2584
a6cbe910605d
- CodeHighlightingService refactored to use
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2575
diff
changeset
|
148 |
"Modified: / 29-07-2011 / 10:22:42 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
2573 | 149 |
! ! |
150 |
||
151 |
!BackgroundQueueProcessingJob methodsFor:'processing'! |
|
152 |
||
153 |
process |
|
154 |
||
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
155 |
| cookie item | |
2573 | 156 |
|
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
157 |
cookie := 'cookie'. |
2573 | 158 |
[ |
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
159 |
item := cookie. |
2589 | 160 |
queueAccessLock critical:[ |
161 |
queue isEmpty ifFalse:[item := queue removeFirst] |
|
162 |
]. |
|
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
163 |
item ~~ cookie ifTrue:[ |
2589 | 164 |
self processItem: item |
165 |
]. |
|
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
166 |
item ~~ cookie. |
2573 | 167 |
] whileTrue |
168 |
||
169 |
"Created: / 28-04-2011 / 20:36:35 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
2589 | 170 |
"Modified (format): / 03-08-2011 / 16:43:21 / cg" |
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
171 |
"Modified: / 07-09-2011 / 13:02:23 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
2573 | 172 |
! |
173 |
||
174 |
processItem: item |
|
175 |
||
176 |
^job value: item |
|
177 |
||
178 |
"Created: / 28-04-2011 / 20:36:51 / Jan Vrany <jan.vrany@fit.cvut.cz>" |
|
179 |
! ! |
|
180 |
||
181 |
!BackgroundQueueProcessingJob class methodsFor:'documentation'! |
|
182 |
||
2591 | 183 |
version |
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
184 |
^ '$Header: /cvs/stx/stx/libbasic2/BackgroundQueueProcessingJob.st,v 1.9 2011-09-07 12:10:12 vrany Exp $' |
2591 | 185 |
! |
186 |
||
2573 | 187 |
version_CVS |
2637
41e0362d5631
support for nil objects in job's queue
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
2612
diff
changeset
|
188 |
^ '$Header: /cvs/stx/stx/libbasic2/BackgroundQueueProcessingJob.st,v 1.9 2011-09-07 12:10:12 vrany Exp $' |
2573 | 189 |
! |
190 |
||
191 |
version_SVN |
|
192 |
^ '§Id§' |
|
193 |
! ! |