summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/util/TaskQueueThread.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/com/amazon/carbonado/util/TaskQueueThread.html')
-rw-r--r--apidocs/com/amazon/carbonado/util/TaskQueueThread.html402
1 files changed, 402 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/util/TaskQueueThread.html b/apidocs/com/amazon/carbonado/util/TaskQueueThread.html
new file mode 100644
index 0000000..441eb60
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/util/TaskQueueThread.html
@@ -0,0 +1,402 @@
+<!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:42 PST 2013 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>TaskQueueThread (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="TaskQueueThread (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/TaskQueueThread.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/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/util/TaskQueueThread.html" target="_top">Frames</a></li>
+<li><a href="TaskQueueThread.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:&nbsp;</li>
+<li><a href="#nested_classes_inherited_from_class_java.lang.Thread">Nested</a>&nbsp;|&nbsp;</li>
+<li><a href="#fields_inherited_from_class_java.lang.Thread">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.util</div>
+<h2 title="Class TaskQueueThread" class="title">Class TaskQueueThread</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>java.lang.Thread</li>
+<li>
+<ul class="inheritance">
+<li>com.amazon.carbonado.util.TaskQueueThread</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>java.lang.Runnable, java.util.concurrent.Executor</dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">TaskQueueThread</span>
+extends java.lang.Thread
+implements java.util.concurrent.Executor</pre>
+<div class="block">Simple generic queue for running tasks from a single thread. Be sure to call
+ shutdown or interrupt when done using the thread, or else it will never exit.</div>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Brian S O'Neill</dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested_class_summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="nested_classes_inherited_from_class_java.lang.Thread">
+<!-- -->
+</a>
+<h3>Nested classes/interfaces inherited from class&nbsp;java.lang.Thread</h3>
+<code>java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler</code></li>
+</ul>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_java.lang.Thread">
+<!-- -->
+</a>
+<h3>Fields inherited from class&nbsp;java.lang.Thread</h3>
+<code>MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY</code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== 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">&nbsp;</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/util/TaskQueueThread.html#TaskQueueThread(java.lang.String, int)">TaskQueueThread</a></strong>(java.lang.String&nbsp;name,
+ int&nbsp;queueSize)</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#TaskQueueThread(java.lang.String, int, long)">TaskQueueThread</a></strong>(java.lang.String&nbsp;name,
+ int&nbsp;queueSize,
+ long&nbsp;timeoutMillis)</code>&nbsp;</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">&nbsp;</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/util/TaskQueueThread.html#execute(java.lang.Runnable)">execute</a></strong>(java.lang.Runnable&nbsp;task)</code>
+<div class="block">Enqueue a task to run.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#execute(java.lang.Runnable, long)">execute</a></strong>(java.lang.Runnable&nbsp;task,
+ long&nbsp;timeoutMillis)</code>
+<div class="block">Enqueue a task to run.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#run()">run</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#shutdown()">shutdown</a></strong>()</code>
+<div class="block">Indicate that this task queue thread should finish running its enqueued
+ tasks and then exit.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Thread">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.Thread</h3>
+<code>activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
+<code>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="TaskQueueThread(java.lang.String, int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>TaskQueueThread</h4>
+<pre>public&nbsp;TaskQueueThread(java.lang.String&nbsp;name,
+ int&nbsp;queueSize)</pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name to give this thread</dd><dd><code>queueSize</code> - fixed size of queue</dd></dl>
+</li>
+</ul>
+<a name="TaskQueueThread(java.lang.String, int, long)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>TaskQueueThread</h4>
+<pre>public&nbsp;TaskQueueThread(java.lang.String&nbsp;name,
+ int&nbsp;queueSize,
+ long&nbsp;timeoutMillis)</pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name to give this thread</dd><dd><code>queueSize</code> - fixed size of queue</dd><dd><code>timeoutMillis</code> - default maximum time to wait for queue to have an available slot</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="execute(java.lang.Runnable)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre>public&nbsp;void&nbsp;execute(java.lang.Runnable&nbsp;task)
+ throws java.util.concurrent.RejectedExecutionException</pre>
+<div class="block">Enqueue a task to run.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>execute</code>&nbsp;in interface&nbsp;<code>java.util.concurrent.Executor</code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>task</code> - task to enqueue</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.util.concurrent.RejectedExecutionException</code> - if wait interrupted, timeout expires,
+ or shutdown has been called</dd></dl>
+</li>
+</ul>
+<a name="execute(java.lang.Runnable, long)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre>public&nbsp;void&nbsp;execute(java.lang.Runnable&nbsp;task,
+ long&nbsp;timeoutMillis)
+ throws java.util.concurrent.RejectedExecutionException</pre>
+<div class="block">Enqueue a task to run.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>task</code> - task to enqueue</dd><dd><code>timeoutMillis</code> - maximum time to wait for queue to have an available slot</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.util.concurrent.RejectedExecutionException</code> - if wait interrupted, timeout expires,
+ or shutdown has been called</dd></dl>
+</li>
+</ul>
+<a name="shutdown()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>shutdown</h4>
+<pre>public&nbsp;void&nbsp;shutdown()</pre>
+<div class="block">Indicate that this task queue thread should finish running its enqueued
+ tasks and then exit. Enqueueing new tasks will result in a
+ RejectedExecutionException being thrown. Join on this thread to wait for
+ it to exit.</div>
+</li>
+</ul>
+<a name="run()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>run</h4>
+<pre>public&nbsp;void&nbsp;run()</pre>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code></dd>
+<dt><strong>Overrides:</strong></dt>
+<dd><code>run</code>&nbsp;in class&nbsp;<code>java.lang.Thread</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/TaskQueueThread.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/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/util/TaskQueueThread.html" target="_top">Frames</a></li>
+<li><a href="TaskQueueThread.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:&nbsp;</li>
+<li><a href="#nested_classes_inherited_from_class_java.lang.Thread">Nested</a>&nbsp;|&nbsp;</li>
+<li><a href="#fields_inherited_from_class_java.lang.Thread">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>