Permalink
Browse files

Update Javadocs for 0.0.2 release

  • Loading branch information...
samstokes committed Oct 5, 2011
1 parent 3aec222 commit 54a7fdc06c809cb4c2cea8ebce189ddadc28af86
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Thu Sep 29 15:59:52 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-All Classes (storm-amqp-spout 0.0.1 API)
+All Classes (storm-amqp-spout 0.0.2 API)
</TITLE>
-<META NAME="date" CONTENT="2011-09-29">
+<META NAME="date" CONTENT="2011-10-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Thu Sep 29 15:59:52 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-All Classes (storm-amqp-spout 0.0.1 API)
+All Classes (storm-amqp-spout 0.0.2 API)
</TITLE>
-<META NAME="date" CONTENT="2011-09-29">
+<META NAME="date" CONTENT="2011-10-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -2,21 +2,21 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Thu Sep 29 15:59:52 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-AMQPSpout (storm-amqp-spout 0.0.1 API)
+AMQPSpout (storm-amqp-spout 0.0.2 API)
</TITLE>
-<META NAME="date" CONTENT="2011-09-29">
+<META NAME="date" CONTENT="2011-10-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="AMQPSpout (storm-amqp-spout 0.0.1 API)";
+ parent.document.title="AMQPSpout (storm-amqp-spout 0.0.2 API)";
}
}
</SCRIPT>
@@ -76,9 +76,9 @@
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
@@ -106,33 +106,32 @@ <H2>
<P>
Spout to feed messages into Storm from an AMQP exchange.
- This should not currently be used where guaranteed message processing is
- required, because of two limitations:
-
- <ol>
- <li>
- Uses a temporary queue to bind to the specified exchange when the topology
- calls <tt>open()</tt> on the spout, so it will only receive messages
- published to the exchange after the call to <tt>open()</tt>, and if the
- spout worker restarts or the topology is killed, it will not receive any
- messages published while the worker or topology is down.
- </li>
-
- <li>
- Currently auto-acks all consumed messages with the AMQP broker, and does not
- implement Storm's reliability API, so if processing a message fails it will
- simply be discarded.
- </li>
- </ol>
-
- Limitation 1 also means this spout cannot currently be distributed among
+ <p>Each message published to the exchange that matches the supplied routing
+ key will be emitted as a Storm tuple. The message will be acked or rejected
+ once the topology has respectively fully processed or failed the
+ corresponding tuple.</p>
+
+ <p>This consumes messages from AMQP asynchronously, so it may receive
+ messages before Storm requests them as tuples; therefore it buffers messages
+ in an internal queue. To avoid this buffer growing large and consuming too
+ much RAM, set <A HREF="../../../../com/rapportive/storm/spout/AMQPSpout.html#CONFIG_PREFETCH_COUNT"><CODE>CONFIG_PREFETCH_COUNT</CODE></A>.</p>
+
+ <p>This should not currently be used where guaranteed message processing is
+ required, because it binds to the exchange using a temporary queue when the
+ topology calls <tt>open()</tt> on the spout. This means it will only
+ receive messages published to the exchange after the call to
+ <tt>open()</tt>, and if the spout worker restarts or the topology is killed,
+ it will not receive any messages published while the worker or topology is
+ down.</p>
+
+ <p>For the same reason, this spout cannot currently be distributed among
multiple workers (each worker gets its own exclusive queue, so multiple
- workers would each receive their own copy of every message).
+ workers would each receive their own copy of every message).</p>
- Improvements are planned to overcome both these limitations and support
+ <p>Improvements are planned to overcome both these limitations and support
guaranteed message processing, distributed across any number of workers.
These improvements may require API changes (e.g. to specify the name of an
- existing queue to consume, rather than an exchange to bind to).
+ existing queue to consume, rather than an exchange to bind to).</p>
<P>
<P>
@@ -143,7 +142,24 @@ <H2>
<HR>
<P>
+<!-- =========== FIELD SUMMARY =========== -->
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../com/rapportive/storm/spout/AMQPSpout.html#CONFIG_PREFETCH_COUNT">CONFIG_PREFETCH_COUNT</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Storm config key to set the AMQP basic.qos prefetch-count parameter.</TD>
+</TR>
+</TABLE>
+&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
@@ -178,7 +194,7 @@ <H2>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../com/rapportive/storm/spout/AMQPSpout.html#ack(java.lang.Object)">ack</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg0)</CODE>
+<TD><CODE><B><A HREF="../../../../com/rapportive/storm/spout/AMQPSpout.html#ack(java.lang.Object)">ack</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;msgId)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
@@ -202,7 +218,7 @@ <H2>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../com/rapportive/storm/spout/AMQPSpout.html#fail(java.lang.Object)">fail</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg0)</CODE>
+<TD><CODE><B><A HREF="../../../../com/rapportive/storm/spout/AMQPSpout.html#fail(java.lang.Object)">fail</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;msgId)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
@@ -248,6 +264,38 @@ <H2>
&nbsp;
<P>
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="CONFIG_PREFETCH_COUNT"><!-- --></A><H3>
+CONFIG_PREFETCH_COUNT</H3>
+<PRE>
+public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>CONFIG_PREFETCH_COUNT</B></PRE>
+<DL>
+<DD>Storm config key to set the AMQP basic.qos prefetch-count parameter.
+ Defaults to 100.
+
+ <p>This caps the number of messages outstanding (i.e. unacked) at a time
+ that will be sent to each spout worker. Increasing this will improve
+ throughput if the network roundtrip time to the AMQP broker is
+ significant compared to the time for the topology to process each
+ message; this will also increase the RAM requirements as the internal
+ message buffer grows.</p>
+
+ <p>AMQP allows a prefetch-count of zero, indicating unlimited delivery,
+ but that is not allowed here to avoid unbounded buffer growth.)</p>
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.rapportive.storm.spout.AMQPSpout.CONFIG_PREFETCH_COUNT">Constant Field Values</A></DL>
+</DL>
+
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
@@ -295,7 +343,7 @@ <H2>
<A NAME="ack(java.lang.Object)"><!-- --></A><H3>
ack</H3>
<PRE>
-public void <B>ack</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg0)</PRE>
+public void <B>ack</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;msgId)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>ack</CODE> in interface <CODE>backtype.storm.spout.ISpout</CODE></DL>
@@ -323,7 +371,7 @@ <H2>
<A NAME="fail(java.lang.Object)"><!-- --></A><H3>
fail</H3>
<PRE>
-public void <B>fail</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg0)</PRE>
+public void <B>fail</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;msgId)</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>fail</CODE> in interface <CODE>backtype.storm.spout.ISpout</CODE></DL>
@@ -445,9 +493,9 @@ <H2>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
@@ -2,21 +2,21 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Thu Sep 29 15:59:52 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-Uses of Class com.rapportive.storm.spout.AMQPSpout (storm-amqp-spout 0.0.1 API)
+Uses of Class com.rapportive.storm.spout.AMQPSpout (storm-amqp-spout 0.0.2 API)
</TITLE>
-<META NAME="date" CONTENT="2011-09-29">
+<META NAME="date" CONTENT="2011-10-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Uses of Class com.rapportive.storm.spout.AMQPSpout (storm-amqp-spout 0.0.1 API)";
+ parent.document.title="Uses of Class com.rapportive.storm.spout.AMQPSpout (storm-amqp-spout 0.0.2 API)";
}
}
</SCRIPT>
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Thu Sep 29 15:59:52 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-com.rapportive.storm.spout (storm-amqp-spout 0.0.1 API)
+com.rapportive.storm.spout (storm-amqp-spout 0.0.2 API)
</TITLE>
-<META NAME="date" CONTENT="2011-09-29">
+<META NAME="date" CONTENT="2011-10-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
@@ -2,21 +2,21 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Thu Sep 29 15:59:52 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-com.rapportive.storm.spout (storm-amqp-spout 0.0.1 API)
+com.rapportive.storm.spout (storm-amqp-spout 0.0.2 API)
</TITLE>
-<META NAME="date" CONTENT="2011-09-29">
+<META NAME="date" CONTENT="2011-10-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="com.rapportive.storm.spout (storm-amqp-spout 0.0.1 API)";
+ parent.document.title="com.rapportive.storm.spout (storm-amqp-spout 0.0.2 API)";
}
}
</SCRIPT>
@@ -2,21 +2,21 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Thu Sep 29 15:59:52 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-com.rapportive.storm.spout Class Hierarchy (storm-amqp-spout 0.0.1 API)
+com.rapportive.storm.spout Class Hierarchy (storm-amqp-spout 0.0.2 API)
</TITLE>
-<META NAME="date" CONTENT="2011-09-29">
+<META NAME="date" CONTENT="2011-10-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="com.rapportive.storm.spout Class Hierarchy (storm-amqp-spout 0.0.1 API)";
+ parent.document.title="com.rapportive.storm.spout Class Hierarchy (storm-amqp-spout 0.0.2 API)";
}
}
</SCRIPT>
@@ -2,21 +2,21 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Thu Sep 29 15:59:52 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-Uses of Package com.rapportive.storm.spout (storm-amqp-spout 0.0.1 API)
+Uses of Package com.rapportive.storm.spout (storm-amqp-spout 0.0.2 API)
</TITLE>
-<META NAME="date" CONTENT="2011-09-29">
+<META NAME="date" CONTENT="2011-10-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Uses of Package com.rapportive.storm.spout (storm-amqp-spout 0.0.1 API)";
+ parent.document.title="Uses of Package com.rapportive.storm.spout (storm-amqp-spout 0.0.2 API)";
}
}
</SCRIPT>
Oops, something went wrong.

0 comments on commit 54a7fdc

Please sign in to comment.