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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:40 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Query.Timeout (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Query.Timeout (Carbonado 1.2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Query.Timeout.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/amazon/carbonado/Query.Timeout.html" target="_top">Frames</a></li>
<li><a href="Query.Timeout.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.amazon.carbonado</div>
<h2 title="Class Query.Timeout" class="title">Class Query.Timeout</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.amazon.carbonado.Query.Timeout</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable</dd>
</dl>
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd>
</dl>
<hr>
<br>
<pre>public static final class <span class="strong">Query.Timeout</span>
extends java.lang.Object
implements <a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></pre>
<div class="block">Timeout controller, for aborting long running queries. One instance is
good for one timeout. The instance can be shared by multiple queries, if
they are part of a single logical operation.
<p>The timeout applies to the entire duration of fetching results, not
just the time spent between individual fetches. A caller which is slowly
processing results can timeout. More sophisticated timeouts can be
implemented using custom Controller implementations.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#com.amazon.carbonado.Query.Timeout">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#Query.Timeout(long, java.util.concurrent.TimeUnit)">Query.Timeout</a></strong>(long timeout,
java.util.concurrent.TimeUnit unit)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#begin()">begin</a></strong>()</code>
<div class="block">Called by query when it begins, possibly multiple times.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#close()">close</a></strong>()</code>
<div class="block">Always called by query when finished, even when it fails.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#continueCheck()">continueCheck</a></strong>()</code>
<div class="block">Periodically called by query to determine if it should continue.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#getTimeout()">getTimeout</a></strong>()</code>
<div class="block">Returns a non-negative value if controller imposes an absolute upper
bound on query execution time.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.concurrent.TimeUnit</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#getTimeoutUnit()">getTimeoutUnit</a></strong>()</code>
<div class="block">Returns the unit for the timeout, if applicable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#hours(long)">hours</a></strong>(long timeout)</code>
<div class="block">Return a new Timeout in hours.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#micros(long)">micros</a></strong>(long timeout)</code>
<div class="block">Return a new Timeout in microseconds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#millis(long)">millis</a></strong>(long timeout)</code>
<div class="block">Return a new Timeout in milliseconds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#minutes(long)">minutes</a></strong>(long timeout)</code>
<div class="block">Return a new Timeout in minutes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#nanos(long)">nanos</a></strong>(long timeout)</code>
<div class="block">Return a new Timeout in nanoseconds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#seconds(long)">seconds</a></strong>(long timeout)</code>
<div class="block">Return a new Timeout in seconds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Query.Timeout(long, java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Query.Timeout</h4>
<pre>public Query.Timeout(long timeout,
java.util.concurrent.TimeUnit unit)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="nanos(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nanos</h4>
<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> nanos(long timeout)</pre>
<div class="block">Return a new Timeout in nanoseconds.</div>
</li>
</ul>
<a name="micros(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>micros</h4>
<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> micros(long timeout)</pre>
<div class="block">Return a new Timeout in microseconds.</div>
</li>
</ul>
<a name="millis(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>millis</h4>
<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> millis(long timeout)</pre>
<div class="block">Return a new Timeout in milliseconds.</div>
</li>
</ul>
<a name="seconds(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>seconds</h4>
<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> seconds(long timeout)</pre>
<div class="block">Return a new Timeout in seconds.</div>
</li>
</ul>
<a name="minutes(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minutes</h4>
<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> minutes(long timeout)</pre>
<div class="block">Return a new Timeout in minutes.</div>
</li>
</ul>
<a name="hours(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hours</h4>
<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> hours(long timeout)</pre>
<div class="block">Return a new Timeout in hours.</div>
</li>
</ul>
<a name="getTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeout</h4>
<pre>public long getTimeout()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeout()">Query.Controller</a></code></strong></div>
<div class="block">Returns a non-negative value if controller imposes an absolute upper
bound on query execution time.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeout()">getTimeout</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd>
</dl>
</li>
</ul>
<a name="getTimeoutUnit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeoutUnit</h4>
<pre>public java.util.concurrent.TimeUnit getTimeoutUnit()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeoutUnit()">Query.Controller</a></code></strong></div>
<div class="block">Returns the unit for the timeout, if applicable.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeoutUnit()">getTimeoutUnit</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd>
</dl>
</li>
</ul>
<a name="begin()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>begin</h4>
<pre>public void begin()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#begin()">Query.Controller</a></code></strong></div>
<div class="block">Called by query when it begins, possibly multiple times. Implementation
is required to be idempotent and ignore multiple invocations.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#begin()">begin</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd>
</dl>
</li>
</ul>
<a name="continueCheck()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>continueCheck</h4>
<pre>public void continueCheck()
throws <a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#continueCheck()">Query.Controller</a></code></strong></div>
<div class="block">Periodically called by query to determine if it should continue.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#continueCheck()">continueCheck</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></code></dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#close()">Query.Controller</a></code></strong></div>
<div class="block">Always called by query when finished, even when it fails. Implementation
is required to be idempotent and ignore multiple invocations.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#close()">close</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.io.Closeable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd>
</dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Query.Timeout.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/amazon/carbonado/Query.Timeout.html" target="_top">Frames</a></li>
<li><a href="Query.Timeout.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>
|
