blob: cf828c19e7db68a8238ce96276a8d7c61d790e07 [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>KafkaSource - io.gearpump.streaming.kafka.KafkaSource</title>
<meta name="description" content="KafkaSource - io.gearpump.streaming.kafka.KafkaSource" />
<meta name="keywords" content="KafkaSource io.gearpump.streaming.kafka.KafkaSource" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript" src="../../../../lib/jquery.js" id="jquery-js"></script>
<script type="text/javascript" src="../../../../lib/jquery-ui.js"></script>
<script type="text/javascript" src="../../../../lib/template.js"></script>
<script type="text/javascript" src="../../../../lib/tools.tooltip.js"></script>
<script type="text/javascript">
if(top === self) {
var url = '../../../../index.html';
var hash = 'io.gearpump.streaming.kafka.KafkaSource';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="type">
<div id="definition">
<a href="KafkaSource$.html" title="Go to companion"><img src="../../../../lib/class_to_object_big.png" /></a>
<p id="owner"><a href="../../../package.html" class="extype" name="io">io</a>.<a href="../../package.html" class="extype" name="io.gearpump">gearpump</a>.<a href="../package.html" class="extype" name="io.gearpump.streaming">streaming</a>.<a href="package.html" class="extype" name="io.gearpump.streaming.kafka">kafka</a></p>
<h1><a href="KafkaSource$.html" title="Go to companion">KafkaSource</a></h1><h3><span class="morelinks"><div>
Related Docs:
<a href="KafkaSource$.html" title="See companion">object KafkaSource</a>
| <a href="package.html" class="extype" name="io.gearpump.streaming.kafka">package kafka</a>
</div></span></h3><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<span class="name">KafkaSource</span><span class="result"> extends <a href="../transaction/api/TimeReplayableSource.html" class="extype" name="io.gearpump.streaming.transaction.api.TimeReplayableSource">TimeReplayableSource</a></span>
</span>
</h4>
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Kafka source connectors that pulls a batch of messages (<code>kafka.consumer.emit.batch.size</code>)
from multiple Kafka TopicAndPartition in a round-robin way.</p><p>This is a TimeReplayableSource which is able to replay messages given a start time.
Each kafka message is tagged with a timestamp by <a href="../transaction/api/MessageDecoder.html" class="extype" name="io.gearpump.streaming.transaction.api.MessageDecoder">io.gearpump.streaming.transaction.api.MessageDecoder</a> and the (offset, timestamp) mapping
is stored to a <span class="extype" name="OffsetStorage">OffsetStorage</span>. On recovery, we could retrieve the previously stored offset
from the <span class="extype" name="OffsetStorage">OffsetStorage</span> by timestamp and start to read from there.</p><p>kafka message is wrapped into gearpump <a href="../../Message.html" class="extype" name="io.gearpump.Message">Message</a> and further filtered by a <span class="extype" name="TimeStampFilter">TimeStampFilter</span>
such that obsolete messages are dropped.
</p></div><div class="toggleContainer block">
<span class="toggle">Linear Supertypes</span>
<div class="superTypes hiddenContent"><a href="../transaction/api/TimeReplayableSource.html" class="extype" name="io.gearpump.streaming.transaction.api.TimeReplayableSource">TimeReplayableSource</a>, <a href="../source/DataSource.html" class="extype" name="io.gearpump.streaming.source.DataSource">DataSource</a>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
</div></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
<div id="order">
<span class="filtertype">Ordering</span>
<ol>
<li class="alpha in"><span>Alphabetic</span></li>
<li class="inherit out"><span>By inheritance</span></li>
</ol>
</div>
<div id="ancestors">
<span class="filtertype">Inherited<br />
</span>
<ol id="linearization">
<li class="in" name="io.gearpump.streaming.kafka.KafkaSource"><span>KafkaSource</span></li><li class="in" name="io.gearpump.streaming.transaction.api.TimeReplayableSource"><span>TimeReplayableSource</span></li><li class="in" name="io.gearpump.streaming.source.DataSource"><span>DataSource</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li>
</ol>
</div><div id="ancestors">
<span class="filtertype"></span>
<ol>
<li class="hideall out"><span>Hide All</span></li>
<li class="showall in"><span>Show all</span></li>
</ol>
<a href="http://docs.scala-lang.org/overviews/scaladoc/usage.html#members" target="_blank">Learn more about member selection</a>
</div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="constructors" class="members">
<h3>Instance Constructors</h3>
<ol><li name="io.gearpump.streaming.kafka.KafkaSource#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="&lt;init&gt;(topics:String,zkConnect:String,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory,messageDecoder:io.gearpump.streaming.transaction.api.MessageDecoder,timestampFilter:io.gearpump.streaming.transaction.api.TimeStampFilter):io.gearpump.streaming.kafka.KafkaSource"></a>
<a id="&lt;init&gt;:KafkaSource"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">new</span>
</span>
<span class="symbol">
<span class="name">KafkaSource</span><span class="params">(<span name="topics">topics: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="zkConnect">zkConnect: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="offsetStorageFactory">offsetStorageFactory: <a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">OffsetStorageFactory</a></span>, <span name="messageDecoder">messageDecoder: <a href="../transaction/api/MessageDecoder.html" class="extype" name="io.gearpump.streaming.transaction.api.MessageDecoder">MessageDecoder</a></span>, <span name="timestampFilter">timestampFilter: <a href="../transaction/api/TimeStampFilter.html" class="extype" name="io.gearpump.streaming.transaction.api.TimeStampFilter">TimeStampFilter</a></span>)</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@&lt;init&gt;(topics:String,zkConnect:String,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory,messageDecoder:io.gearpump.streaming.transaction.api.MessageDecoder,timestampFilter:io.gearpump.streaming.transaction.api.TimeStampFilter):io.gearpump.streaming.kafka.KafkaSource" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">topics</dt><dd class="cmt"><p>comma-separated string of topics</p></dd><dt class="param">zkConnect</dt><dd class="cmt"><p>kafka consumer config <code>zookeeper.connect</code></p></dd><dt class="param">offsetStorageFactory</dt><dd class="cmt"><p><a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">io.gearpump.streaming.transaction.api.OffsetStorageFactory</a>
that creates <a href="../transaction/api/OffsetStorage.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorage">io.gearpump.streaming.transaction.api.OffsetStorage</a></p></dd><dt class="param">messageDecoder</dt><dd class="cmt"><p>decodes <a href="../../Message.html" class="extype" name="io.gearpump.Message">Message</a> from raw bytes</p></dd><dt class="param">timestampFilter</dt><dd class="cmt"><p>filters out message based on timestamp
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.KafkaSource#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="&lt;init&gt;(topics:String,zkConnect:String,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory):io.gearpump.streaming.kafka.KafkaSource"></a>
<a id="&lt;init&gt;:KafkaSource"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">new</span>
</span>
<span class="symbol">
<span class="name">KafkaSource</span><span class="params">(<span name="topics">topics: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="zkConnect">zkConnect: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="offsetStorageFactory">offsetStorageFactory: <a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">OffsetStorageFactory</a></span>)</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@&lt;init&gt;(topics:String,zkConnect:String,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory):io.gearpump.streaming.kafka.KafkaSource" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">topics</dt><dd class="cmt"><p>comma-separated string of topics</p></dd><dt class="param">zkConnect</dt><dd class="cmt"><p>kafka consumer config <code>zookeeper.connect</code></p></dd><dt class="param">offsetStorageFactory</dt><dd class="cmt"><p><a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">io.gearpump.streaming.transaction.api.OffsetStorageFactory</a>
that creates <a href="../transaction/api/OffsetStorage.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorage">io.gearpump.streaming.transaction.api.OffsetStorage</a>
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.KafkaSource#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="&lt;init&gt;(topics:String,properties:java.util.Properties,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory,messageDecoder:io.gearpump.streaming.transaction.api.MessageDecoder,timestampFilter:io.gearpump.streaming.transaction.api.TimeStampFilter):io.gearpump.streaming.kafka.KafkaSource"></a>
<a id="&lt;init&gt;:KafkaSource"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">new</span>
</span>
<span class="symbol">
<span class="name">KafkaSource</span><span class="params">(<span name="topics">topics: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="properties">properties: <span class="extype" name="java.util.Properties">Properties</span></span>, <span name="offsetStorageFactory">offsetStorageFactory: <a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">OffsetStorageFactory</a></span>, <span name="messageDecoder">messageDecoder: <a href="../transaction/api/MessageDecoder.html" class="extype" name="io.gearpump.streaming.transaction.api.MessageDecoder">MessageDecoder</a></span>, <span name="timestampFilter">timestampFilter: <a href="../transaction/api/TimeStampFilter.html" class="extype" name="io.gearpump.streaming.transaction.api.TimeStampFilter">TimeStampFilter</a></span>)</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@&lt;init&gt;(topics:String,properties:java.util.Properties,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory,messageDecoder:io.gearpump.streaming.transaction.api.MessageDecoder,timestampFilter:io.gearpump.streaming.transaction.api.TimeStampFilter):io.gearpump.streaming.kafka.KafkaSource" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">topics</dt><dd class="cmt"><p>comma-separated string of topics</p></dd><dt class="param">properties</dt><dd class="cmt"><p>kafka consumer config</p></dd><dt class="param">offsetStorageFactory</dt><dd class="cmt"><p><a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">io.gearpump.streaming.transaction.api.OffsetStorageFactory</a>
that creates <a href="../transaction/api/OffsetStorage.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorage">io.gearpump.streaming.transaction.api.OffsetStorage</a></p></dd><dt class="param">messageDecoder</dt><dd class="cmt"><p>decodes <a href="../../Message.html" class="extype" name="io.gearpump.Message">Message</a> from raw bytes</p></dd><dt class="param">timestampFilter</dt><dd class="cmt"><p>filters out message based on timestamp
</p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.KafkaSource#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="&lt;init&gt;(topics:String,properties:java.util.Properties,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory):io.gearpump.streaming.kafka.KafkaSource"></a>
<a id="&lt;init&gt;:KafkaSource"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">new</span>
</span>
<span class="symbol">
<span class="name">KafkaSource</span><span class="params">(<span name="topics">topics: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="properties">properties: <span class="extype" name="java.util.Properties">Properties</span></span>, <span name="offsetStorageFactory">offsetStorageFactory: <a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">OffsetStorageFactory</a></span>)</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@&lt;init&gt;(topics:String,properties:java.util.Properties,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory):io.gearpump.streaming.kafka.KafkaSource" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">topics</dt><dd class="cmt"><p>comma-separated string of topics</p></dd><dt class="param">properties</dt><dd class="cmt"><p>kafka consumer config</p></dd><dt class="param">offsetStorageFactory</dt><dd class="cmt"><p><a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">io.gearpump.streaming.transaction.api.OffsetStorageFactory</a>
that creates <a href="../transaction/api/OffsetStorage.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorage">io.gearpump.streaming.transaction.api.OffsetStorage</a></p></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.KafkaSource#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="&lt;init&gt;(config:io.gearpump.streaming.kafka.lib.KafkaSourceConfig,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory,messageDecoder:io.gearpump.streaming.transaction.api.MessageDecoder,timestampFilter:io.gearpump.streaming.transaction.api.TimeStampFilter,fetchThread:Option[io.gearpump.streaming.kafka.lib.consumer.FetchThread],offsetManagers:Map[kafka.common.TopicAndPartition,io.gearpump.streaming.kafka.lib.KafkaOffsetManager]):io.gearpump.streaming.kafka.KafkaSource"></a>
<a id="&lt;init&gt;:KafkaSource"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">new</span>
</span>
<span class="symbol">
<span class="name">KafkaSource</span><span class="params">(<span name="config">config: <a href="lib/KafkaSourceConfig.html" class="extype" name="io.gearpump.streaming.kafka.lib.KafkaSourceConfig">KafkaSourceConfig</a></span>, <span name="offsetStorageFactory">offsetStorageFactory: <a href="../transaction/api/OffsetStorageFactory.html" class="extype" name="io.gearpump.streaming.transaction.api.OffsetStorageFactory">OffsetStorageFactory</a></span>, <span name="messageDecoder">messageDecoder: <a href="../transaction/api/MessageDecoder.html" class="extype" name="io.gearpump.streaming.transaction.api.MessageDecoder">MessageDecoder</a> = <span class="symbol"><span class="name"><a href="../../../package.html">new DefaultMessageDecoder</a></span></span></span>, <span name="timestampFilter">timestampFilter: <a href="../transaction/api/TimeStampFilter.html" class="extype" name="io.gearpump.streaming.transaction.api.TimeStampFilter">TimeStampFilter</a> = <span class="symbol"><span class="name"><a href="../../../package.html">new DefaultTimeStampFilter</a></span></span></span>, <span name="fetchThread">fetchThread: <span class="extype" name="scala.Option">Option</span>[<span class="extype" name="io.gearpump.streaming.kafka.lib.consumer.FetchThread">FetchThread</span>] = <span class="symbol">None</span></span>, <span name="offsetManagers">offsetManagers: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="kafka.common.TopicAndPartition">TopicAndPartition</span>, <span class="extype" name="io.gearpump.streaming.kafka.lib.KafkaOffsetManager">KafkaOffsetManager</span>] = <span class="defval" name="Map.empty[TopicAndPartition, KafkaOffsetManager]">...</span></span>)</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@&lt;init&gt;(config:io.gearpump.streaming.kafka.lib.KafkaSourceConfig,offsetStorageFactory:io.gearpump.streaming.transaction.api.OffsetStorageFactory,messageDecoder:io.gearpump.streaming.transaction.api.MessageDecoder,timestampFilter:io.gearpump.streaming.transaction.api.TimeStampFilter,fetchThread:Option[io.gearpump.streaming.kafka.lib.consumer.FetchThread],offsetManagers:Map[kafka.common.TopicAndPartition,io.gearpump.streaming.kafka.lib.KafkaOffsetManager]):io.gearpump.streaming.kafka.KafkaSource" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">config</dt><dd class="cmt"><p>kafka source config</p></dd><dt class="param">messageDecoder</dt><dd class="cmt"><p>decodes <a href="../../Message.html" class="extype" name="io.gearpump.Message">Message</a> from raw bytes</p></dd><dt class="param">timestampFilter</dt><dd class="cmt"><p>filters out message based on timestamp</p></dd><dt class="param">fetchThread</dt><dd class="cmt"><p>fetches messages and puts on a in-memory queue</p></dd><dt class="param">offsetManagers</dt><dd class="cmt"><p>manages offset-to-timestamp storage for each kafka.common.TopicAndPartition
</p></dd></dl></div>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="!=(x$1:Any):Boolean"></a>
<a id="!=(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@!=(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="##():Int"></a>
<a id="##():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@##():Int" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="==(x$1:Any):Boolean"></a>
<a id="==(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@==(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="asInstanceOf[T0]:T0"></a>
<a id="asInstanceOf[T0]:T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@asInstanceOf[T0]:T0" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="clone():Object"></a>
<a id="clone():AnyRef"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@clone():Object" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.KafkaSource#close" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="close():Unit"></a>
<a id="close():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">close</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@close():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt">close connection to data source.</p><div class="fullcomment"><div class="comment cmt"><p>close connection to data source.
invoked in onStop() method of <a href="../source/DataSourceTask.html" class="extype" name="io.gearpump.streaming.source.DataSourceTask">io.gearpump.streaming.source.DataSourceTask</a>
</p></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="io.gearpump.streaming.kafka.KafkaSource">KafkaSource</a><a href="../source/DataSource.html" class="extype" name="io.gearpump.streaming.source.DataSource">DataSource</a></dd></dl></div>
</li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="eq(x$1:AnyRef):Boolean"></a>
<a id="eq(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="equals(x$1:Any):Boolean"></a>
<a id="equals(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@equals(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="finalize():Unit"></a>
<a id="finalize():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">finalize</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@finalize():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="symbol">classOf[java.lang.Throwable]</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getClass():Class[_]"></a>
<a id="getClass():Class[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@getClass():Class[_]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="hashCode():Int"></a>
<a id="hashCode():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@hashCode():Int" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="isInstanceOf[T0]:Boolean"></a>
<a id="isInstanceOf[T0]:Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@isInstanceOf[T0]:Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="ne(x$1:AnyRef):Boolean"></a>
<a id="ne(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notify():Unit"></a>
<a id="notify():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notify</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@notify():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notifyAll():Unit"></a>
<a id="notifyAll():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@notifyAll():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.KafkaSource#open" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="open(context:io.gearpump.streaming.task.TaskContext,startTime:Option[io.gearpump.TimeStamp]):Unit"></a>
<a id="open(TaskContext,Option[TimeStamp]):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">open</span><span class="params">(<span name="context">context: <a href="../task/TaskContext.html" class="extype" name="io.gearpump.streaming.task.TaskContext">TaskContext</a></span>, <span name="startTime">startTime: <span class="extype" name="scala.Option">Option</span>[<a href="../../package.html#TimeStamp=Long" class="extmbr" name="io.gearpump.TimeStamp">TimeStamp</a>]</span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@open(context:io.gearpump.streaming.task.TaskContext,startTime:Option[io.gearpump.TimeStamp]):Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt">open connection to data source
invoked in onStart() method of <a href="../source/DataSourceTask.html" class="extype" name="io.gearpump.streaming.source.DataSourceTask">io.gearpump.streaming.source.DataSourceTask</a></p><div class="fullcomment"><div class="comment cmt"><p>open connection to data source
invoked in onStart() method of <a href="../source/DataSourceTask.html" class="extype" name="io.gearpump.streaming.source.DataSourceTask">io.gearpump.streaming.source.DataSourceTask</a></p></div><dl class="paramcmts block"><dt class="param">context</dt><dd class="cmt"><p>is the task context at runtime</p></dd><dt class="param">startTime</dt><dd class="cmt"><p>is the start time of system
</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="io.gearpump.streaming.kafka.KafkaSource">KafkaSource</a><a href="../source/DataSource.html" class="extype" name="io.gearpump.streaming.source.DataSource">DataSource</a></dd></dl></div>
</li><li name="io.gearpump.streaming.kafka.KafkaSource#read" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="read(batchSize:Int):List[io.gearpump.Message]"></a>
<a id="read(Int):List[Message]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">read</span><span class="params">(<span name="batchSize">batchSize: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.List">List</span>[<a href="../../Message.html" class="extype" name="io.gearpump.Message">Message</a>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@read(batchSize:Int):List[io.gearpump.Message]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<p class="shortcomment cmt">read a number of messages from data source.</p><div class="fullcomment"><div class="comment cmt"><p>read a number of messages from data source.
invoked in each onNext() method of <a href="../source/DataSourceTask.html" class="extype" name="io.gearpump.streaming.source.DataSourceTask">io.gearpump.streaming.source.DataSourceTask</a></p></div><dl class="paramcmts block"><dt class="param">batchSize</dt><dd class="cmt"><p>max number of messages to read</p></dd><dt>returns</dt><dd class="cmt"><p>a list of messages wrapped in <a href="../../Message.html" class="extype" name="io.gearpump.Message">io.gearpump.Message</a>
</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="io.gearpump.streaming.kafka.KafkaSource">KafkaSource</a><a href="../source/DataSource.html" class="extype" name="io.gearpump.streaming.source.DataSource">DataSource</a></dd></dl></div>
</li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="synchronized[T0](x$1:=&gt;T0):T0"></a>
<a id="synchronized[T0](⇒T0):T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@synchronized[T0](x$1:=&gt;T0):T0" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="toString():String"></a>
<a id="toString():String"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@toString():String" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait():Unit"></a>
<a id="wait():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@wait():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long,x$2:Int):Unit"></a>
<a id="wait(Long,Int):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long):Unit"></a>
<a id="wait(Long):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#io.gearpump.streaming.kafka.KafkaSource@wait(x$1:Long):Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li></ol>
</div>
</div>
<div id="inheritedMembers">
<div class="parent" name="io.gearpump.streaming.transaction.api.TimeReplayableSource">
<h3>Inherited from <a href="../transaction/api/TimeReplayableSource.html" class="extype" name="io.gearpump.streaming.transaction.api.TimeReplayableSource">TimeReplayableSource</a></h3>
</div><div class="parent" name="io.gearpump.streaming.source.DataSource">
<h3>Inherited from <a href="../source/DataSource.html" class="extype" name="io.gearpump.streaming.source.DataSource">DataSource</a></h3>
</div><div class="parent" name="java.io.Serializable">
<h3>Inherited from <span class="extype" name="java.io.Serializable">Serializable</span></h3>
</div><div class="parent" name="scala.AnyRef">
<h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
</div><div class="parent" name="scala.Any">
<h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3>
</div>
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
</body>
</html>