You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ya...@apache.org on 2015/04/01 20:56:21 UTC
svn commit: r1670752 [17/27] - in /samza/site: ./ archive/ community/
contribute/ img/0.9/ img/0.9/learn/ img/0.9/learn/documentation/
img/0.9/learn/documentation/comparisons/
img/0.9/learn/documentation/container/
img/0.9/learn/documentation/introduct...
Added: samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/WindowableTask.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/WindowableTask.html?rev=1670752&view=auto
==============================================================================
--- samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/WindowableTask.html (added)
+++ samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/WindowableTask.html Wed Apr 1 18:56:19 2015
@@ -0,0 +1,219 @@
+<!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_65) on Wed Apr 01 11:54:57 PDT 2015 -->
+<title>WindowableTask (samza-api 0.9.0 API)</title>
+<meta name="date" content="2015-04-01">
+<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="WindowableTask (samza-api 0.9.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="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/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/task/WindowableTask.html" target="_top">Frames</a></li>
+<li><a href="WindowableTask.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>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.samza.task</div>
+<h2 title="Interface WindowableTask" class="title">Interface WindowableTask</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="strong">WindowableTask</span></pre>
+<div class="block">Add-on interface to <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to add code which will be run on
+ a specified time interval (via configuration). This can be used to implement direct time-based windowing or,
+ with a frequent window interval, windowing based on some other condition which is checked during the call to
+ window. The window method will be called even if no messages are received for a particular StreamTask.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== 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>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)">window</a></strong>(<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector,
+ <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a> coordinator)</code>
+<div class="block">Called by TaskRunner for each implementing task at the end of every specified window.</div>
+</td>
+</tr>
+</table>
+</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="window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>window</h4>
+<pre>void window(<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector,
+ <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a> coordinator)
+ throws java.lang.Exception</pre>
+<div class="block">Called by TaskRunner for each implementing task at the end of every specified window.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>collector</code> - Contains the means of sending message envelopes to the output stream. The collector must only
+ be used during the current call to the window method; you should not reuse the collector between invocations
+ of this method.</dd><dd><code>coordinator</code> - Manages execution of tasks.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.Exception</code> - Any exception types encountered during the execution of the processing task.</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="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/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/task/WindowableTask.html" target="_top">Frames</a></li>
+<li><a href="WindowableTask.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>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 ======= -->
+</body>
+</html>
Added: samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-frame.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-frame.html?rev=1670752&view=auto
==============================================================================
--- samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-frame.html (added)
+++ samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-frame.html Wed Apr 1 18:56:19 2015
@@ -0,0 +1,29 @@
+<!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_65) on Wed Apr 01 11:54:57 PDT 2015 -->
+<title>org.apache.samza.task (samza-api 0.9.0 API)</title>
+<meta name="date" content="2015-04-01">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<h1 class="bar"><a href="../../../../org/apache/samza/task/package-summary.html" target="classFrame">org.apache.samza.task</a></h1>
+<div class="indexContainer">
+<h2 title="Interfaces">Interfaces</h2>
+<ul title="Interfaces">
+<li><a href="ClosableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>ClosableTask</i></a></li>
+<li><a href="InitableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>InitableTask</i></a></li>
+<li><a href="MessageCollector.html" title="interface in org.apache.samza.task" target="classFrame"><i>MessageCollector</i></a></li>
+<li><a href="StreamTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>StreamTask</i></a></li>
+<li><a href="TaskContext.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskContext</i></a></li>
+<li><a href="TaskCoordinator.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskCoordinator</i></a></li>
+<li><a href="WindowableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>WindowableTask</i></a></li>
+</ul>
+<h2 title="Enums">Enums</h2>
+<ul title="Enums">
+<li><a href="TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task" target="classFrame">TaskCoordinator.RequestScope</a></li>
+</ul>
+</div>
+</body>
+</html>
Added: samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-summary.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-summary.html?rev=1670752&view=auto
==============================================================================
--- samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-summary.html (added)
+++ samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-summary.html Wed Apr 1 18:56:19 2015
@@ -0,0 +1,196 @@
+<!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_65) on Wed Apr 01 11:54:57 PDT 2015 -->
+<title>org.apache.samza.task (samza-api 0.9.0 API)</title>
+<meta name="date" content="2015-04-01">
+<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="org.apache.samza.task (samza-api 0.9.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 class="navBarCell1Rev">Package</li>
+<li>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/samza/system/chooser/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../org/apache/samza/util/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/task/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Package" class="title">Package org.apache.samza.task</h1>
+</div>
+<div class="contentContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
+<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Interface</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task">ClosableTask</a></td>
+<td class="colLast">
+<div class="block">A ClosableTask augments <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, allowing the method implementer to specify
+ code that will be called when the StreamTask is being shut down by the framework, providing to emit final metrics,
+ clean or close resources, etc.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task">InitableTask</a></td>
+<td class="colLast">
+<div class="block">Used as an interface for user processing StreamTasks that need to have specific functionality performed as their StreamTasks
+ are instantiated by TaskRunner.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a></td>
+<td class="colLast">
+<div class="block">Used as an interface for the means of sending message envelopes to an output stream.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task">StreamTask</a></td>
+<td class="colLast">
+<div class="block">A StreamTask is the basic class on which Samza jobs are implemented.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></td>
+<td class="colLast">
+<div class="block">A TaskContext provides resources about the <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, particularly during
+ initialization in an <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a></td>
+<td class="colLast">
+<div class="block">TaskCoordinators are provided to the process methods of <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations
+ to allow the user code to request actions from the Samza framework, including committing the current checkpoints
+ to configured <a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>s or shutting down the task or all tasks within
+ a container.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task">WindowableTask</a></td>
+<td class="colLast">
+<div class="block">Add-on interface to <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to add code which will be run on
+ a specified time interval (via configuration).</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
+<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Enum</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></td>
+<td class="colLast">
+<div class="block">A task can make requests to the Samza framework while processing messages, such as
+ <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>TaskCoordinator.commit(RequestScope)</code></a> and
+ <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>TaskCoordinator.shutdown(RequestScope)</code></a>.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+</div>
+<!-- ======= 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 class="navBarCell1Rev">Package</li>
+<li>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/samza/system/chooser/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../org/apache/samza/util/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/task/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-tree.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-tree.html?rev=1670752&view=auto
==============================================================================
--- samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-tree.html (added)
+++ samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/task/package-tree.html Wed Apr 1 18:56:19 2015
@@ -0,0 +1,140 @@
+<!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_65) on Wed Apr 01 11:54:57 PDT 2015 -->
+<title>org.apache.samza.task Class Hierarchy (samza-api 0.9.0 API)</title>
+<meta name="date" content="2015-04-01">
+<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="org.apache.samza.task Class Hierarchy (samza-api 0.9.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</li>
+<li class="navBarCell1Rev">Tree</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/samza/system/chooser/package-tree.html">Prev</a></li>
+<li><a href="../../../../org/apache/samza/util/package-tree.html">Next</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/task/package-tree.html" target="_top">Frames</a></li>
+<li><a href="package-tree.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>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 class="title">Hierarchy For Package org.apache.samza.task</h1>
+<span class="strong">Package Hierarchies:</span>
+<ul class="horizontal">
+<li><a href="../../../../overview-tree.html">All Packages</a></li>
+</ul>
+</div>
+<div class="contentContainer">
+<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
+<ul>
+<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><span class="strong">ClosableTask</span></a></li>
+<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">InitableTask</span></a></li>
+<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">MessageCollector</span></a></li>
+<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">StreamTask</span></a></li>
+<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">TaskContext</span></a></li>
+<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">TaskCoordinator</span></a></li>
+<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><span class="strong">WindowableTask</span></a></li>
+</ul>
+<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
+<ul>
+<li type="circle">java.lang.Object
+<ul>
+<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
+<ul>
+<li type="circle">org.apache.samza.task.<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">TaskCoordinator.RequestScope</span></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<!-- ======= 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</li>
+<li class="navBarCell1Rev">Tree</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/samza/system/chooser/package-tree.html">Prev</a></li>
+<li><a href="../../../../org/apache/samza/util/package-tree.html">Next</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/task/package-tree.html" target="_top">Frames</a></li>
+<li><a href="package-tree.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>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html?rev=1670752&view=auto
==============================================================================
--- samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html (added)
+++ samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html Wed Apr 1 18:56:19 2015
@@ -0,0 +1,314 @@
+<!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_65) on Wed Apr 01 11:54:57 PDT 2015 -->
+<title>BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (samza-api 0.9.0 API)</title>
+<meta name="date" content="2015-04-01">
+<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="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (samza-api 0.9.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="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/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" target="_top">Frames</a></li>
+<li><a href="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.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.samza.util</div>
+<h2 title="Class BlockingEnvelopeMap.BlockingEnvelopeMapMetrics" class="title">Class BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.util.BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>Enclosing class:</dt>
+<dd><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</span>
+extends java.lang.Object</pre>
+</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="overviewSummary" 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><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String,%20org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></strong>(java.lang.String group,
+ <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</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="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>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incBlockingPoll(org.apache.samza.system.SystemStreamPartition)">incBlockingPoll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incBlockingTimeoutPoll(org.apache.samza.system.SystemStreamPartition)">incBlockingTimeoutPoll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#incPoll()">incPoll</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#initMetrics(org.apache.samza.system.SystemStreamPartition)">initMetrics</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#setNoMoreMessages(org.apache.samza.system.SystemStreamPartition,%20boolean)">setNoMoreMessages</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ boolean noMoreMessages)</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="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String, org.apache.samza.metrics.MetricsRegistry)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</h4>
+<pre>public BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String group,
+ <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="initMetrics(org.apache.samza.system.SystemStreamPartition)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>initMetrics</h4>
+<pre>public void initMetrics(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre>
+</li>
+</ul>
+<a name="setNoMoreMessages(org.apache.samza.system.SystemStreamPartition, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setNoMoreMessages</h4>
+<pre>public void setNoMoreMessages(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ boolean noMoreMessages)</pre>
+</li>
+</ul>
+<a name="incBlockingPoll(org.apache.samza.system.SystemStreamPartition)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>incBlockingPoll</h4>
+<pre>public void incBlockingPoll(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre>
+</li>
+</ul>
+<a name="incBlockingTimeoutPoll(org.apache.samza.system.SystemStreamPartition)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>incBlockingTimeoutPoll</h4>
+<pre>public void incBlockingTimeoutPoll(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre>
+</li>
+</ul>
+<a name="incPoll()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>incPoll</h4>
+<pre>public void incPoll()</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><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="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/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" target="_top">Frames</a></li>
+<li><a href="BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.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>
Added: samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html?rev=1670752&view=auto
==============================================================================
--- samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html (added)
+++ samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html Wed Apr 1 18:56:19 2015
@@ -0,0 +1,280 @@
+<!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_65) on Wed Apr 01 11:54:57 PDT 2015 -->
+<title>BlockingEnvelopeMap.BufferGauge (samza-api 0.9.0 API)</title>
+<meta name="date" content="2015-04-01">
+<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="BlockingEnvelopeMap.BufferGauge (samza-api 0.9.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="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/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" target="_top">Frames</a></li>
+<li><a href="BlockingEnvelopeMap.BufferGauge.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.samza.util</div>
+<h2 title="Class BlockingEnvelopeMap.BufferGauge" class="title">Class BlockingEnvelopeMap.BufferGauge</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">org.apache.samza.metrics.Gauge</a><java.lang.Integer></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.util.BlockingEnvelopeMap.BufferGauge</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics">Metric</a></dd>
+</dl>
+<dl>
+<dt>Enclosing class:</dt>
+<dd><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">BlockingEnvelopeMap.BufferGauge</span>
+extends <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><java.lang.Integer></pre>
+</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="overviewSummary" 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><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#BlockingEnvelopeMap.BufferGauge(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">BlockingEnvelopeMap.BufferGauge</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String name)</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="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>java.lang.Integer</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#getValue()">getValue</a></strong>()</code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.metrics.Gauge">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></h3>
+<code><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T,%20T)">compareAndSet</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#getName()">getName</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#set(T)">set</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#toString()">toString</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></code></li>
+</ul>
+<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, 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="BlockingEnvelopeMap.BufferGauge(org.apache.samza.system.SystemStreamPartition, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>BlockingEnvelopeMap.BufferGauge</h4>
+<pre>public BlockingEnvelopeMap.BufferGauge(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String name)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getValue()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getValue</h4>
+<pre>public java.lang.Integer getValue()</pre>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code><a href="../../../../org/apache/samza/metrics/Gauge.html#getValue()">getValue</a></code> in class <code><a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><java.lang.Integer></code></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="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/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" target="_top">Frames</a></li>
+<li><a href="BlockingEnvelopeMap.BufferGauge.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>
Added: samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html
URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html?rev=1670752&view=auto
==============================================================================
--- samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html (added)
+++ samza/site/learn/documentation/0.9/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html Wed Apr 1 18:56:19 2015
@@ -0,0 +1,557 @@
+<!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_65) on Wed Apr 01 11:54:57 PDT 2015 -->
+<title>BlockingEnvelopeMap (samza-api 0.9.0 API)</title>
+<meta name="date" content="2015-04-01">
+<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="BlockingEnvelopeMap (samza-api 0.9.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="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>Prev Class</li>
+<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.html" target="_top">Frames</a></li>
+<li><a href="BlockingEnvelopeMap.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><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.samza.util</div>
+<h2 title="Class BlockingEnvelopeMap" class="title">Class BlockingEnvelopeMap</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.util.BlockingEnvelopeMap</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="strong">BlockingEnvelopeMap</span>
+extends java.lang.Object
+implements <a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></pre>
+<div class="block"><p>
+ BlockingEnvelopeMap is a helper class for SystemConsumer implementations.
+ Samza's poll() requirements make implementing SystemConsumers somewhat
+ tricky. BlockingEnvelopeMap is provided to help other developers write
+ SystemConsumers. The intended audience is not those writing Samza jobs, but
+ rather those extending Samza to consume from new types of stream providers
+ and other systems.
+ </p>
+
+ <p>
+ SystemConsumers that implement BlockingEnvelopeMap need to add messages using
+ <a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put(org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.system.IncomingMessageEnvelope)"><code>put</code></a>
+ (or <a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll(org.apache.samza.system.SystemStreamPartition,%20java.util.List)"><code>putAll</code></a>),
+ and update noMoreMessage using setIsAtHead. The noMoreMessage variable is used
+ to determine whether a SystemStreamPartition is "caught up" (has read all
+ possible messages from the underlying system). For example, with a Kafka
+ system, noMoreMessages would be set to true when the last message offset
+ returned is equal to the offset high watermark for a given topic/partition.
+ </p>
+ The BlockingEnvelopeMap is backed by a concurrent map, which allows concurrent
+ put or putAll calls to be thread safe without external synchronization.</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">Class and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>class </code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>class </code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html" title="class in org.apache.samza.util">BlockingEnvelopeMap.BufferGauge</a></strong></code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_org.apache.samza.system.SystemConsumer">
+<!-- -->
+</a>
+<h3>Fields inherited from interface org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></h3>
+<code><a href="../../../../org/apache/samza/system/SystemConsumer.html#BLOCK_ON_OUTSTANDING_MESSAGES">BLOCK_ON_OUTSTANDING_MESSAGES</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="overviewSummary" 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><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap()">BlockingEnvelopeMap</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.util.Clock)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
+ <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock,%20java.lang.String)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
+ <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock,
+ java.lang.String metricsGroupName)</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="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>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#getNumMessagesInQueue(org.apache.samza.system.SystemStreamPartition)">getNumMessagesInQueue</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#isAtHead(org.apache.samza.system.SystemStreamPartition)">isAtHead</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected java.util.concurrent.BlockingQueue<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#newBlockingQueue()">newBlockingQueue</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#poll(java.util.Set,%20long)">poll</a></strong>(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions,
+ long timeout)</code>
+<div class="block">Poll the SystemConsumer to get any available messages from the underlying
+ system.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put(org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.system.IncomingMessageEnvelope)">put</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</code>
+<div class="block">Place a new <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a> on the
+ queue for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll(org.apache.samza.system.SystemStreamPartition,%20java.util.List)">putAll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</code>
+<div class="block">Place a collection of <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a>
+ on the queue for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</code>
+<div class="block">Register a SystemStreamPartition to this SystemConsumer.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected java.lang.Boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#setIsAtHead(org.apache.samza.system.SystemStreamPartition,%20boolean)">setIsAtHead</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ boolean isAtHead)</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>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.system.SystemConsumer">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></h3>
+<code><a href="../../../../org/apache/samza/system/SystemConsumer.html#start()">start</a>, <a href="../../../../org/apache/samza/system/SystemConsumer.html#stop()">stop</a></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="BlockingEnvelopeMap()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>BlockingEnvelopeMap</h4>
+<pre>public BlockingEnvelopeMap()</pre>
+</li>
+</ul>
+<a name="BlockingEnvelopeMap(org.apache.samza.util.Clock)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>BlockingEnvelopeMap</h4>
+<pre>public BlockingEnvelopeMap(<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</pre>
+</li>
+</ul>
+<a name="BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>BlockingEnvelopeMap</h4>
+<pre>public BlockingEnvelopeMap(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</pre>
+</li>
+</ul>
+<a name="BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry, org.apache.samza.util.Clock)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>BlockingEnvelopeMap</h4>
+<pre>public BlockingEnvelopeMap(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
+ <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</pre>
+</li>
+</ul>
+<a name="BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry, org.apache.samza.util.Clock, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>BlockingEnvelopeMap</h4>
+<pre>public BlockingEnvelopeMap(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
+ <a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock,
+ java.lang.String metricsGroupName)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>register</h4>
+<pre>public void register(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</pre>
+<div class="block">Register a SystemStreamPartition to this SystemConsumer. The SystemConsumer
+ should try and read messages from all SystemStreamPartitions that are
+ registered to it. SystemStreamPartitions should only be registered before
+ start is called.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - The SystemStreamPartition object representing the Samza
+ SystemStreamPartition to receive messages from.</dd><dd><code>offset</code> - String representing the offset of the point in the stream to start
+ reading messages from. This is an inclusive parameter; if "7" were
+ specified, the first message for the system/stream/partition to be
+ consumed and returned would be a message whose offset is "7".</dd></dl>
+</li>
+</ul>
+<a name="newBlockingQueue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>newBlockingQueue</h4>
+<pre>protected java.util.concurrent.BlockingQueue<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> newBlockingQueue()</pre>
+</li>
+</ul>
+<a name="poll(java.util.Set, long)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>poll</h4>
+<pre>public java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>>> poll(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions,
+ long timeout)
+ throws java.lang.InterruptedException</pre>
+<div class="block">Poll the SystemConsumer to get any available messages from the underlying
+ system.
+
+ <p>
+ If the underlying implementation does not take care to adhere to the
+ timeout parameter, the SamzaContainer's performance will suffer
+ drastically. Specifically, if poll blocks when it's not supposed to, it
+ will block the entire main thread in SamzaContainer, and no messages will
+ be processed while blocking is occurring.
+ </p></div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Set,%20long)">poll</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartitions</code> - A set of SystemStreamPartition to poll for new messages. If
+ SystemConsumer has messages available for other registered
+ SystemStreamPartitions, but they are not in the
+ systemStreamPartitions set in a given poll invocation, they can't
+ be returned. It is illegal to pass in SystemStreamPartitions that
+ have not been registered with the SystemConsumer first.</dd><dd><code>timeout</code> - If timeout < 0, poll will block unless all SystemStreamPartition
+ are at "head" (the underlying system has been checked, and
+ returned an empty set). If at head, an empty map is returned. If
+ timeout >= 0, poll will return any messages that are currently
+ available for any of the SystemStreamPartitions specified. If no
+ new messages are available, it will wait up to timeout
+ milliseconds for messages from any SystemStreamPartition to become
+ available. It will return an empty map if the timeout is hit, and
+ no new messages are available.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>A map from SystemStreamPartitions to any available
+ IncomingMessageEnvelopes for the SystemStreamPartitions. If no
+ messages are available for a SystemStreamPartition that was
+ supplied in the polling set, the map will not contain a key for the
+ SystemStreamPartition. Will return an empty map, not null, if no
+ new messages are available for any SystemStreamPartitions in the
+ input set.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.InterruptedException</code> - Thrown when a blocking poll has been interrupted by another
+ thread.</dd></dl>
+</li>
+</ul>
+<a name="put(org.apache.samza.system.SystemStreamPartition, org.apache.samza.system.IncomingMessageEnvelope)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>put</h4>
+<pre>protected void put(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)
+ throws java.lang.InterruptedException</pre>
+<div class="block">Place a new <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a> on the
+ queue for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - SystemStreamPartition that owns the envelope</dd><dd><code>envelope</code> - Message for specified SystemStreamPartition</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.InterruptedException</code> - from underlying concurrent collection</dd></dl>
+</li>
+</ul>
+<a name="putAll(org.apache.samza.system.SystemStreamPartition, java.util.List)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>putAll</h4>
+<pre>protected void putAll(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)
+ throws java.lang.InterruptedException</pre>
+<div class="block">Place a collection of <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a>
+ on the queue for the specified <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.
+ <p>
+ Insertion of all the messages into the queue is not guaranteed to be done
+ atomically.
+ </p></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - SystemStreamPartition that owns the envelope</dd><dd><code>envelopes</code> - Messages for specified SystemStreamPartition</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.InterruptedException</code> - from underlying concurrent collection</dd></dl>
+</li>
+</ul>
+<a name="getNumMessagesInQueue(org.apache.samza.system.SystemStreamPartition)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumMessagesInQueue</h4>
+<pre>public int getNumMessagesInQueue(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</pre>
+</li>
+</ul>
+<a name="setIsAtHead(org.apache.samza.system.SystemStreamPartition, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setIsAtHead</h4>
+<pre>protected java.lang.Boolean setIsAtHead(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ boolean isAtHead)</pre>
+</li>
+</ul>
+<a name="isAtHead(org.apache.samza.system.SystemStreamPartition)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>isAtHead</h4>
+<pre>protected boolean isAtHead(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</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><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="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>Prev Class</li>
+<li><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html" title="class in org.apache.samza.util"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/util/BlockingEnvelopeMap.html" target="_top">Frames</a></li>
+<li><a href="BlockingEnvelopeMap.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><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>