| <!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_80) on Sat Apr 08 11:09:16 PDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>BrokerService (Apache Twill 0.11.0 API)</title> |
| <meta name="date" content="2017-04-08"> |
| <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="BrokerService (Apache Twill 0.11.0 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/BrokerService.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-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/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/twill/kafka/client/BrokerService.html" target="_top">Frames</a></li> |
| <li><a href="BrokerService.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.twill.kafka.client</div> |
| <h2 title="Interface BrokerService" class="title">Interface BrokerService</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>com.google.common.util.concurrent.Service</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">BrokerService</span> |
| extends com.google.common.util.concurrent.Service</pre> |
| <div class="block">Service for providing information of kafka brokers.</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="overviewSummary" 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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client">BrokerService.BrokerChangeListener</a></strong></code> |
| <div class="block">Listener for changes in broker list.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_com.google.common.util.concurrent.Service"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service</h3> |
| <code>com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State</code></li> |
| </ul> |
| </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><a href="../../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/BrokerService.html#addChangeListener(org.apache.twill.kafka.client.BrokerService.BrokerChangeListener,%20java.util.concurrent.Executor)">addChangeListener</a></strong>(<a href="../../../../../org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client">BrokerService.BrokerChangeListener</a> listener, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a> executor)</code> |
| <div class="block">Adds a listener to changes in broker list managed by this service.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/BrokerService.html#getBrokerList()">getBrokerList</a></strong>()</code> |
| <div class="block">Returns a comma separate string of all current brokers.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client">BrokerInfo</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/BrokerService.html#getBrokers()">getBrokers</a></strong>()</code> |
| <div class="block">Returns a live iterable that gives information for all the known brokers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client">BrokerInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/BrokerService.html#getLeader(java.lang.String,%20int)">getLeader</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic, |
| int partition)</code> |
| <div class="block">Returns the broker information of the current leader of the given topic and partition.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_com.google.common.util.concurrent.Service"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.common.util.concurrent.Service</h3> |
| <code>addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, start, startAndWait, startAsync, state, stop, stopAndWait, stopAsync</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getLeader(java.lang.String, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLeader</h4> |
| <pre><a href="../../../../../org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client">BrokerInfo</a> getLeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic, |
| int partition)</pre> |
| <div class="block">Returns the broker information of the current leader of the given topic and partition.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - Topic for looking up for leader.</dd><dd><code>partition</code> - Partition for looking up for leader.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../../org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client"><code>BrokerInfo</code></a> containing information about the current leader, or <code>null</code> if |
| current leader is unknown.</dd></dl> |
| </li> |
| </ul> |
| <a name="getBrokers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBrokers</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client">BrokerInfo</a>> getBrokers()</pre> |
| <div class="block">Returns a live iterable that gives information for all the known brokers.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>An <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../../org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client"><code>BrokerInfo</code></a> that when <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang"><code>Iterable.iterator()</code></a> is called, it returns |
| an iterator that gives the latest list of <a href="../../../../../org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client"><code>BrokerInfo</code></a>.</dd></dl> |
| </li> |
| </ul> |
| <a name="getBrokerList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBrokerList</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBrokerList()</pre> |
| <div class="block">Returns a comma separate string of all current brokers.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>A string in the format <code>host1:port1,host2:port2</code> or empty string if no broker has been discovered.</dd></dl> |
| </li> |
| </ul> |
| <a name="addChangeListener(org.apache.twill.kafka.client.BrokerService.BrokerChangeListener, java.util.concurrent.Executor)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addChangeListener</h4> |
| <pre><a href="../../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a> addChangeListener(<a href="../../../../../org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client">BrokerService.BrokerChangeListener</a> listener, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a> executor)</pre> |
| <div class="block">Adds a listener to changes in broker list managed by this service.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - The listener to invoke when there is changes.</dd><dd><code>executor</code> - Executor to use for invocation to the listener.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common"><code>Cancellable</code></a> to stop listening.</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/BrokerService.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-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/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/twill/kafka/client/BrokerService.html" target="_top">Frames</a></li> |
| <li><a href="BrokerService.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2013-2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
