blob: fef3c4fcef4538061bc92d93c0137813c5eef656 [file] [log] [blame]
<!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 (1.8.0_121) on Sun Jul 09 07:41:23 CEST 2017 -->
<title>FetchThread</title>
<meta name="date" content="2017-07-09">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FetchThread";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/ExponentialBackoffSleeper.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.FetchThreadFactory.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html" target="_top">Frames</a></li>
<li><a href="FetchThread.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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.class.summary">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">org.apache.gearpump.streaming.kafka.lib.source.consumer</div>
<h2 title="Class FetchThread" class="title">Class FetchThread</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>org.apache.gearpump.streaming.kafka.lib.source.consumer.FetchThread</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</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FetchThread</span>
extends java.lang.Thread</pre>
<div class="block">A thread to fetch messages from multiple kafka org.apache.kafka.TopicAndPartition and puts them
onto a queue, which is asynchronously polled by a consumer
<p>
param: createConsumer given a org.apache.kafka.TopicAndPartition, create a
<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/KafkaConsumer.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer"><code>KafkaConsumer</code></a> to
connect to it
param: incomingQueue a queue to buffer incoming messages
param: fetchThreshold above which thread should stop fetching messages
param: fetchSleepMS interval to sleep when no more messages or hitting fetchThreshold</div>
</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.FetchThreadFactory.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">FetchThread.FetchThreadFactory</a></span></code>&nbsp;</td>
</tr>
</table>
<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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html#FetchThread-scala.Function1-java.util.concurrent.LinkedBlockingQueue-org.apache.gearpump.streaming.kafka.lib.source.consumer.ExponentialBackoffSleeper-int-long-">FetchThread</a></span>(scala.Function1&lt;kafka.common.TopicAndPartition,<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/KafkaConsumer.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">KafkaConsumer</a>&gt;&nbsp;createConsumer,
java.util.concurrent.LinkedBlockingQueue&lt;<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/KafkaMessage.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">KafkaMessage</a>&gt;&nbsp;incomingQueue,
<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/ExponentialBackoffSleeper.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">ExponentialBackoffSleeper</a>&nbsp;sleeper,
int&nbsp;fetchThreshold,
long&nbsp;fetchSleepMS)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">FetchThread</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html#apply-int-long-long-org.apache.gearpump.streaming.kafka.lib.util.KafkaClient-">apply</a></span>(int&nbsp;fetchThreshold,
long&nbsp;fetchSleepMS,
long&nbsp;startOffsetTime,
<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/util/KafkaClient.html" title="class in org.apache.gearpump.streaming.kafka.lib.util">KafkaClient</a>&nbsp;client)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.FetchThreadFactory.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">FetchThread.FetchThreadFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html#factory--">factory</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>scala.Option&lt;<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/KafkaMessage.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">KafkaMessage</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html#poll--">poll</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html#run--">run</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html#runLoop--">runLoop</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html#setStartOffset-kafka.common.TopicAndPartition-long-">setStartOffset</a></span>(kafka.common.TopicAndPartition&nbsp;tp,
long&nbsp;startOffset)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html#setTopicAndPartitions-kafka.common.TopicAndPartition:A-">setTopicAndPartitions</a></span>(kafka.common.TopicAndPartition[]&nbsp;topicAndPartitions)</code>&nbsp;</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="FetchThread-scala.Function1-java.util.concurrent.LinkedBlockingQueue-org.apache.gearpump.streaming.kafka.lib.source.consumer.ExponentialBackoffSleeper-int-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FetchThread</h4>
<pre>public&nbsp;FetchThread(scala.Function1&lt;kafka.common.TopicAndPartition,<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/KafkaConsumer.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">KafkaConsumer</a>&gt;&nbsp;createConsumer,
java.util.concurrent.LinkedBlockingQueue&lt;<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/KafkaMessage.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">KafkaMessage</a>&gt;&nbsp;incomingQueue,
<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/ExponentialBackoffSleeper.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">ExponentialBackoffSleeper</a>&nbsp;sleeper,
int&nbsp;fetchThreshold,
long&nbsp;fetchSleepMS)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="factory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>factory</h4>
<pre>public static&nbsp;<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.FetchThreadFactory.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">FetchThread.FetchThreadFactory</a>&nbsp;factory()</pre>
</li>
</ul>
<a name="apply-int-long-long-org.apache.gearpump.streaming.kafka.lib.util.KafkaClient-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>public static&nbsp;<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">FetchThread</a>&nbsp;apply(int&nbsp;fetchThreshold,
long&nbsp;fetchSleepMS,
long&nbsp;startOffsetTime,
<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/util/KafkaClient.html" title="class in org.apache.gearpump.streaming.kafka.lib.util">KafkaClient</a>&nbsp;client)</pre>
</li>
</ul>
<a name="setTopicAndPartitions-kafka.common.TopicAndPartition:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopicAndPartitions</h4>
<pre>public&nbsp;void&nbsp;setTopicAndPartitions(kafka.common.TopicAndPartition[]&nbsp;topicAndPartitions)</pre>
</li>
</ul>
<a name="setStartOffset-kafka.common.TopicAndPartition-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStartOffset</h4>
<pre>public&nbsp;void&nbsp;setStartOffset(kafka.common.TopicAndPartition&nbsp;tp,
long&nbsp;startOffset)</pre>
</li>
</ul>
<a name="poll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poll</h4>
<pre>public&nbsp;scala.Option&lt;<a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/KafkaMessage.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer">KafkaMessage</a>&gt;&nbsp;poll()</pre>
</li>
</ul>
<a name="run--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;void&nbsp;run()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>run</code>&nbsp;in class&nbsp;<code>java.lang.Thread</code></dd>
</dl>
</li>
</ul>
<a name="runLoop--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>runLoop</h4>
<pre>public&nbsp;void&nbsp;runLoop()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/ExponentialBackoffSleeper.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.FetchThreadFactory.html" title="class in org.apache.gearpump.streaming.kafka.lib.source.consumer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/gearpump/streaming/kafka/lib/source/consumer/FetchThread.html" target="_top">Frames</a></li>
<li><a href="FetchThread.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;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.class.summary">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 ======= -->
</body>
</html>