| <!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:25 CEST 2017 --> |
| <title>Subscription</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="Subscription"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/task/SubscriberSpec.TestTask.html" title="class in org.apache.gearpump.streaming.task"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/gearpump/streaming/task/SubscriptionSpec.html" title="class in org.apache.gearpump.streaming.task"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/gearpump/streaming/task/Subscription.html" target="_top">Frames</a></li> |
| <li><a href="Subscription.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.gearpump.streaming.task</div> |
| <h2 title="Class Subscription" class="title">Class Subscription</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.gearpump.streaming.task.Subscription</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Subscription</span> |
| extends java.lang.Object</pre> |
| <div class="block">Manages the output and message clock for single downstream processor |
| <p> |
| param: subscriber downstream processor |
| param: maxPendingMessageCount trigger flow control. Should be bigger than |
| maxPendingMessageCountPerAckRequest |
| param: ackOnceEveryMessageCount send on AckRequest to the target</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#Subscription-int-int-org.apache.gearpump.streaming.task.TaskId-org.apache.gearpump.streaming.task.Subscriber-int-org.apache.gearpump.streaming.task.TaskActor-int-int-">Subscription</a></span>(int appId, |
| int executorId, |
| <a href="../../../../../org/apache/gearpump/streaming/task/TaskId.html" title="class in org.apache.gearpump.streaming.task">TaskId</a> taskId, |
| <a href="../../../../../org/apache/gearpump/streaming/task/Subscriber.html" title="class in org.apache.gearpump.streaming.task">Subscriber</a> subscriber, |
| int sessionId, |
| <a href="../../../../../org/apache/gearpump/streaming/task/TaskActor.html" title="class in org.apache.gearpump.streaming.task">TaskActor</a> publisher, |
| int maxPendingMessageCount, |
| int ackOnceEveryMessageCount)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#allowSendingMoreMessages--">allowSendingMoreMessages</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#changeLife-org.apache.gearpump.streaming.LifeTime-">changeLife</a></span>(<a href="../../../../../org/apache/gearpump/streaming/LifeTime.html" title="class in org.apache.gearpump.streaming">LifeTime</a> life)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#MAX_PENDING_MESSAGE_COUNT--">MAX_PENDING_MESSAGE_COUNT</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#ONE_ACKREQUEST_EVERY_MESSAGE_COUNT--">ONE_ACKREQUEST_EVERY_MESSAGE_COUNT</a></span>()</code> </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/task/Subscription.html#onStallingTime-long-">onStallingTime</a></span>(long stallingTime)</code> </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/task/Subscription.html#receiveAck-org.apache.gearpump.streaming.task.Ack-">receiveAck</a></span>(<a href="../../../../../org/apache/gearpump/streaming/task/Ack.html" title="class in org.apache.gearpump.streaming.task">Ack</a> ack)</code> |
| <div class="block">Handles acknowledge message.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#sendMessage-org.apache.gearpump.Message-">sendMessage</a></span>(<a href="../../../../../org/apache/gearpump/Message.html" title="interface in org.apache.gearpump">Message</a> msg)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#sendMessage-org.apache.gearpump.Message-int-">sendMessage</a></span>(<a href="../../../../../org/apache/gearpump/Message.html" title="interface in org.apache.gearpump">Message</a> msg, |
| int partition)</code> |
| <div class="block">Returns how many message is actually sent by this subscription</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#start--">start</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/gearpump/streaming/task/Subscription.html#watermark--">watermark</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="Subscription-int-int-org.apache.gearpump.streaming.task.TaskId-org.apache.gearpump.streaming.task.Subscriber-int-org.apache.gearpump.streaming.task.TaskActor-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Subscription</h4> |
| <pre>public Subscription(int appId, |
| int executorId, |
| <a href="../../../../../org/apache/gearpump/streaming/task/TaskId.html" title="class in org.apache.gearpump.streaming.task">TaskId</a> taskId, |
| <a href="../../../../../org/apache/gearpump/streaming/task/Subscriber.html" title="class in org.apache.gearpump.streaming.task">Subscriber</a> subscriber, |
| int sessionId, |
| <a href="../../../../../org/apache/gearpump/streaming/task/TaskActor.html" title="class in org.apache.gearpump.streaming.task">TaskActor</a> publisher, |
| int maxPendingMessageCount, |
| int ackOnceEveryMessageCount)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="ONE_ACKREQUEST_EVERY_MESSAGE_COUNT--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ONE_ACKREQUEST_EVERY_MESSAGE_COUNT</h4> |
| <pre>public static final int ONE_ACKREQUEST_EVERY_MESSAGE_COUNT()</pre> |
| </li> |
| </ul> |
| <a name="MAX_PENDING_MESSAGE_COUNT--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MAX_PENDING_MESSAGE_COUNT</h4> |
| <pre>public static final int MAX_PENDING_MESSAGE_COUNT()</pre> |
| </li> |
| </ul> |
| <a name="changeLife-org.apache.gearpump.streaming.LifeTime-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>changeLife</h4> |
| <pre>public void changeLife(<a href="../../../../../org/apache/gearpump/streaming/LifeTime.html" title="class in org.apache.gearpump.streaming">LifeTime</a> life)</pre> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void start()</pre> |
| </li> |
| </ul> |
| <a name="sendMessage-org.apache.gearpump.Message-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessage</h4> |
| <pre>public int sendMessage(<a href="../../../../../org/apache/gearpump/Message.html" title="interface in org.apache.gearpump">Message</a> msg)</pre> |
| </li> |
| </ul> |
| <a name="sendMessage-org.apache.gearpump.Message-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendMessage</h4> |
| <pre>public int sendMessage(<a href="../../../../../org/apache/gearpump/Message.html" title="interface in org.apache.gearpump">Message</a> msg, |
| int partition)</pre> |
| <div class="block">Returns how many message is actually sent by this subscription |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msg</code> - the message to send</dd> |
| <dd><code>partition</code> - the target partition to send message to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>1 if success</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="receiveAck-org.apache.gearpump.streaming.task.Ack-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receiveAck</h4> |
| <pre>public void receiveAck(<a href="../../../../../org/apache/gearpump/streaming/task/Ack.html" title="class in org.apache.gearpump.streaming.task">Ack</a> ack)</pre> |
| <div class="block">Handles acknowledge message. Throw MessageLossException if required. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ack</code> - acknowledge message received</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="watermark--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>watermark</h4> |
| <pre>public long watermark()</pre> |
| </li> |
| </ul> |
| <a name="allowSendingMoreMessages--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allowSendingMoreMessages</h4> |
| <pre>public boolean allowSendingMoreMessages()</pre> |
| </li> |
| </ul> |
| <a name="onStallingTime-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onStallingTime</h4> |
| <pre>public void onStallingTime(long stallingTime)</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/task/SubscriberSpec.TestTask.html" title="class in org.apache.gearpump.streaming.task"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/gearpump/streaming/task/SubscriptionSpec.html" title="class in org.apache.gearpump.streaming.task"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/gearpump/streaming/task/Subscription.html" target="_top">Frames</a></li> |
| <li><a href="Subscription.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |