1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/**
* Copyright 2010 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.common.util;
/**
* Helper class to provide a Runnable queue implementation with a Runnable wrapper
* which notifies after execution for the <code>invokeAndWait()</code> semantics.
*/
public class RunnableTask implements Runnable {
Runnable runnable;
final Object syncObject;
boolean catchExceptions;
Object attachment;
Throwable runnableException;
long tCreated, tStarted;
volatile long tExecuted;
volatile boolean isFlushed;
/**
* Create a RunnableTask object w/o synchronization,
* ie. not suitable for <code>invokeAndWait()</code>.
*
* @param runnable the user action
*/
public RunnableTask(Runnable runnable) {
this(runnable, null, false);
}
/**
* Create a RunnableTask object w/ synchronization,
* ie. suitable for <code>invokeAndWait()</code>.
*
* @param runnable the user action
* @param syncObject the synchronization object the caller shall wait for in case of <code>invokeAndWait()</code>
*/
public RunnableTask(Runnable runnable, Object syncObject) {
this(runnable, syncObject, false);
}
/**
* Create a RunnableTask object w/ synchronization,
* ie. suitable for <code>invokeAndWait()</code>.
*
* @param runnable the user action
* @param syncObject the synchronization object the caller shall wait for in case of <code>invokeAndWai()t</code>
* @param catchExceptions if true, exception during <code>runnable</code> execution are catched, otherwise not.
* Use {@link #getThrowable()} to determine whether an exception has been catched.
*/
public RunnableTask(Runnable runnable, Object syncObject, boolean catchExceptions) {
this.runnable = runnable ;
this.syncObject = syncObject ;
this.catchExceptions = catchExceptions ;
tCreated = System.currentTimeMillis();
tStarted = 0;
tExecuted = 0;
isFlushed = false;
}
/** Return the user action */
public Runnable getRunnable() {
return runnable;
}
/**
* Return the synchronization object if any.
* @see #RunnableTask(Runnable, Object, boolean)
*/
public Object getSyncObject() {
return syncObject;
}
/**
* Attach a custom object to this task.
* Useful to piggybag further information, ie tag a task final.
*/
public void setAttachment(Object o) {
attachment = o;
}
/**
* Return the attachment object if any.
* @see #setAttachment(Object)
*/
public Object getAttachment() {
return attachment;
}
public void run() {
tStarted = System.currentTimeMillis();
if(null == syncObject) {
try {
runnable.run();
} catch (Throwable t) {
runnableException = t;
if(!catchExceptions) {
throw new RuntimeException(runnableException);
}
} finally {
tExecuted = System.currentTimeMillis();
}
} else {
synchronized (syncObject) {
try {
runnable.run();
} catch (Throwable t) {
runnableException = t;
if(!catchExceptions) {
throw new RuntimeException(runnableException);
}
} finally {
tExecuted = System.currentTimeMillis();
syncObject.notifyAll();
}
}
}
}
/**
* Simply flush this task and notify a waiting executor.
* The executor which might have been blocked until notified
* will be unblocked and the task removed from the queue.
*
* @see #isFlushed()
* @see #isInQueue()
*/
public void flush() {
if(!isExecuted() && hasWaiter()) {
synchronized (syncObject) {
isFlushed = true;
syncObject.notifyAll();
}
}
}
/**
* @return !{@link #isExecuted()} && !{@link #isFlushed()}
*/
public boolean isInQueue() { return 0 != tExecuted && !isFlushed; }
/**
* @return True if executed, otherwise false;
*/
public boolean isExecuted() { return 0 != tExecuted ; }
/**
* @return True if flushed, otherwise false;
*/
public boolean isFlushed() { return isFlushed; }
/**
* @return True if invoking thread waits until done,
* ie a <code>notifyObject</code> was passed, otherwise false;
*/
public boolean hasWaiter() { return null != syncObject; }
/**
* @return A thrown exception while execution of the user action, if any and if catched
* @see #RunnableTask(Runnable, Object, boolean)
*/
public Throwable getThrowable() { return runnableException; }
public long getTimestampCreate() { return tCreated; }
public long getTimestampBeforeExec() { return tStarted; }
public long getTimestampAfterExec() { return tExecuted; }
public long getDurationInQueue() { return tStarted - tCreated; }
public long getDurationInExec() { return tExecuted - tStarted; }
public long getDurationTotal() { return tExecuted - tCreated; }
@Override
public String toString() {
return "RunnableTask[executed "+isExecuted()+", t2-t0 "+getDurationTotal()+", t2-t1 "+getDurationInExec()+", t1-t0 "+getDurationInQueue()+", throwable "+getThrowable()+", Runnable "+runnable+", Attachment "+attachment+"]";
}
}
|
