| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>SpoutTopologyContext (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SpoutTopologyContext (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">backtype.storm.task</a></div> |
| <h2 title="Class SpoutTopologyContext" class="title">Class SpoutTopologyContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="GeneralTopologyContext.html" title="class in backtype.storm.task">backtype.storm.task.GeneralTopologyContext</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="WorkerTopologyContext.html" title="class in backtype.storm.task">backtype.storm.task.WorkerTopologyContext</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="TopologyContext.html" title="class in backtype.storm.task">backtype.storm.task.TopologyContext</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>backtype.storm.task.SpoutTopologyContext</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="IMetricsContext.html" title="interface in backtype.storm.task">IMetricsContext</a></code>, <code>org.json.simple.JSONAware</code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SpoutTopologyContext</span> |
| extends <a href="TopologyContext.html" title="class in backtype.storm.task">TopologyContext</a></pre> |
| <div class="block">A TopologyContext that is given to a spout is actually an instance |
| of SpoutTopologyContext. Currently spouts can store spout specific |
| information in this structure.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.api.topology.TopologyContext)">SpoutTopologyContext</a></span>​(<a href="../../../org/apache/heron/api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a> delegate)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.Long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxSpoutPending()">getMaxSpoutPending</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the Maximum Spout Pending value for this instance of spout.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxSpoutPending(java.lang.Long)">setMaxSpoutPending</a></span>​(java.lang.Long maxSpoutPending)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the Maximum Spout Pending value for this instance of spout</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.backtype.storm.task.TopologyContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class backtype.storm.task.<a href="TopologyContext.html" title="class in backtype.storm.task">TopologyContext</a></h3> |
| <code><a href="TopologyContext.html#addTaskHook(backtype.storm.hooks.ITaskHook)">addTaskHook</a>, <a href="TopologyContext.html#getHooks()">getHooks</a>, <a href="TopologyContext.html#getTaskData(java.lang.String)">getTaskData</a>, <a href="TopologyContext.html#getThisComponentId()">getThisComponentId</a>, <a href="TopologyContext.html#getThisOutputFields(java.lang.String)">getThisOutputFields</a>, <a href="TopologyContext.html#getThisStreams()">getThisStreams</a>, <a href="TopologyContext.html#getThisTaskId()">getThisTaskId</a>, <a href="TopologyContext.html#getThisTaskIndex()">getThisTaskIndex</a>, <a href="TopologyContext.html#registerMetric(java.lang.String,backtype.storm.metric.api.ICombiner,int)">registerMetric</a>, <a href="TopologyContext.html#registerMetric(java.lang.String,backtype.storm.metric.api.IReducer,int)">registerMetric</a>, <a href="TopologyContext.html#registerMetric(java.lang.String,T,int)">registerMetric</a>, <a href="TopologyContext.html#setTaskData(java.lang.String,java.lang.Object)">setTaskData</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.backtype.storm.task.WorkerTopologyContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class backtype.storm.task.<a href="WorkerTopologyContext.html" title="class in backtype.storm.task">WorkerTopologyContext</a></h3> |
| <code><a href="WorkerTopologyContext.html#getCodeDir()">getCodeDir</a>, <a href="WorkerTopologyContext.html#getPIDDir()">getPIDDir</a>, <a href="WorkerTopologyContext.html#getResource(java.lang.String)">getResource</a>, <a href="WorkerTopologyContext.html#getSharedExecutor()">getSharedExecutor</a>, <a href="WorkerTopologyContext.html#getThisWorkerPort()">getThisWorkerPort</a>, <a href="WorkerTopologyContext.html#getThisWorkerTasks()">getThisWorkerTasks</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.backtype.storm.task.GeneralTopologyContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class backtype.storm.task.<a href="GeneralTopologyContext.html" title="class in backtype.storm.task">GeneralTopologyContext</a></h3> |
| <code><a href="GeneralTopologyContext.html#getComponentId(int)">getComponentId</a>, <a href="GeneralTopologyContext.html#getComponentIds()">getComponentIds</a>, <a href="GeneralTopologyContext.html#getComponentOutputFields(java.lang.String,java.lang.String)">getComponentOutputFields</a>, <a href="GeneralTopologyContext.html#getComponentStreams(java.lang.String)">getComponentStreams</a>, <a href="GeneralTopologyContext.html#getComponentTasks(java.lang.String)">getComponentTasks</a>, <a href="GeneralTopologyContext.html#getStormId()">getStormId</a>, <a href="GeneralTopologyContext.html#getTaskToComponent()">getTaskToComponent</a>, <a href="GeneralTopologyContext.html#toJSONString()">toJSONString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.api.topology.TopologyContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SpoutTopologyContext</h4> |
| <pre>public SpoutTopologyContext​(<a href="../../../org/apache/heron/api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a> delegate)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getMaxSpoutPending()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxSpoutPending</h4> |
| <pre class="methodSignature">public java.lang.Long getMaxSpoutPending()</pre> |
| <div class="block">Gets the Maximum Spout Pending value for this instance of spout.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Maximum Spout Pending value for this instance of spout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxSpoutPending(java.lang.Long)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setMaxSpoutPending</h4> |
| <pre class="methodSignature">public void setMaxSpoutPending​(java.lang.Long maxSpoutPending)</pre> |
| <div class="block">Sets the Maximum Spout Pending value for this instance of spout</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxSpoutPending</code> - the max spout pending value</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
