Permalink
Browse files

Update docs to 0.1.0 release

  • Loading branch information...
1 parent 54a7fdc commit eaa000fd7c186027ca6673550b33f92bc9288570 @samstokes samstokes committed Oct 31, 2011
View
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Sun Oct 30 22:32:15 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-All Classes (storm-amqp-spout 0.0.2 API)
+All Classes (storm-amqp-spout 0.1.0 API)
</TITLE>
-<META NAME="date" CONTENT="2011-10-05">
+<META NAME="date" CONTENT="2011-10-30">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -24,6 +24,12 @@
<TR>
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="com/rapportive/storm/spout/AMQPSpout.html" title="class in com.rapportive.storm.spout" target="classFrame">AMQPSpout</A>
<BR>
+<A HREF="com/rapportive/storm/amqp/ExclusiveQueueWithBinding.html" title="class in com.rapportive.storm.amqp" target="classFrame">ExclusiveQueueWithBinding</A>
+<BR>
+<A HREF="com/rapportive/storm/amqp/QueueDeclaration.html" title="interface in com.rapportive.storm.amqp" target="classFrame"><I>QueueDeclaration</I></A>
+<BR>
+<A HREF="com/rapportive/storm/amqp/SharedQueueWithBinding.html" title="class in com.rapportive.storm.amqp" target="classFrame">SharedQueueWithBinding</A>
+<BR>
</FONT></TD>
</TR>
</TABLE>
@@ -2,13 +2,13 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_20) on Wed Oct 05 01:49:45 PDT 2011 -->
+<!-- Generated by javadoc (build 1.6.0_20) on Sun Oct 30 22:32:15 PDT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
-All Classes (storm-amqp-spout 0.0.2 API)
+All Classes (storm-amqp-spout 0.1.0 API)
</TITLE>
-<META NAME="date" CONTENT="2011-10-05">
+<META NAME="date" CONTENT="2011-10-30">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -24,6 +24,12 @@
<TR>
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="com/rapportive/storm/spout/AMQPSpout.html" title="class in com.rapportive.storm.spout">AMQPSpout</A>
<BR>
+<A HREF="com/rapportive/storm/amqp/ExclusiveQueueWithBinding.html" title="class in com.rapportive.storm.amqp">ExclusiveQueueWithBinding</A>
+<BR>
+<A HREF="com/rapportive/storm/amqp/QueueDeclaration.html" title="interface in com.rapportive.storm.amqp"><I>QueueDeclaration</I></A>
+<BR>
+<A HREF="com/rapportive/storm/amqp/SharedQueueWithBinding.html" title="class in com.rapportive.storm.amqp">SharedQueueWithBinding</A>
+<BR>
</FONT></TD>
</TR>
</TABLE>

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -0,0 +1,269 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_20) on Sun Oct 30 22:32:14 PDT 2011 -->
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<TITLE>
+QueueDeclaration (storm-amqp-spout 0.1.0 API)
+</TITLE>
+
+<META NAME="date" CONTENT="2011-10-30">
+
+<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="QueueDeclaration (storm-amqp-spout 0.1.0 API)";
+ }
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+<HR>
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/QueueDeclaration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../com/rapportive/storm/amqp/ExclusiveQueueWithBinding.html" title="class in com.rapportive.storm.amqp"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../com/rapportive/storm/amqp/SharedQueueWithBinding.html" title="class in com.rapportive.storm.amqp"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?com/rapportive/storm/amqp/QueueDeclaration.html" target="_top"><B>FRAMES</B></A> &nbsp;
+&nbsp;<A HREF="QueueDeclaration.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
+&nbsp;<SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+com.rapportive.storm.amqp</FONT>
+<BR>
+Interface QueueDeclaration</H2>
+<DL>
+<DT><B>All Superinterfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
+</DL>
+<DL>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/rapportive/storm/amqp/ExclusiveQueueWithBinding.html" title="class in com.rapportive.storm.amqp">ExclusiveQueueWithBinding</A>, <A HREF="../../../../com/rapportive/storm/amqp/SharedQueueWithBinding.html" title="class in com.rapportive.storm.amqp">SharedQueueWithBinding</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public interface <B>QueueDeclaration</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
+</PRE>
+
+<P>
+Declaration of a queue to consume, and any exchange bindings the queue needs.
+
+ <p>Depending on the queue parameters (exclusive, auto_delete, server-named)
+ and exchange bindings, it may or may not be safe to start several consumers
+ in parallel using a given queue declaration. For example, an exclusive
+ named queue bound to an exchange is not safe because only one of the
+ consumers will succeed in declaring the queue; an exclusive
+ <em>server-named</em> queue does not have that problem, but is still
+ probably not safe, because most exchange types will send a copy of every
+ message to every queue bound to them, so you will end up consuming each
+ message several times.</p>
+
+ <p>For that reason, to implement this interface you must implement
+ <A HREF="../../../../com/rapportive/storm/amqp/QueueDeclaration.html#isParallelConsumable()"><CODE>isParallelConsumable()</CODE></A> to indicate whether or not this queue is safe
+ for parallel consumers.</p>
+<P>
+
+<P>
+<HR>
+
+<P>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_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>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;com.rabbitmq.client.AMQP.Queue.DeclareOk</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../com/rapportive/storm/amqp/QueueDeclaration.html#declare(com.rabbitmq.client.Channel)">declare</A></B>(com.rabbitmq.client.Channel&nbsp;channel)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Declare the queue, and any exchanges and bindings that it needs.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../com/rapportive/storm/amqp/QueueDeclaration.html#isParallelConsumable()">isParallelConsumable</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate whether this queue is safe for parallel consumers.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_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>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="declare(com.rabbitmq.client.Channel)"><!-- --></A><H3>
+declare</H3>
+<PRE>
+com.rabbitmq.client.AMQP.Queue.DeclareOk <B>declare</B>(com.rabbitmq.client.Channel&nbsp;channel)
+ throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
+<DL>
+<DD>Declare the queue, and any exchanges and bindings that it needs. Called
+ once to determine the queue to consume from.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>channel</CODE> - An open AMQP channel which can be used to send the
+ declarations.
+<DT><B>Returns:</B><DD>the server's response to the successful queue declaration (used
+ to determine the queue name to subscribe to).
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if a declaration fails or the AMQP connection drops.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="isParallelConsumable()"><!-- --></A><H3>
+isParallelConsumable</H3>
+<PRE>
+boolean <B>isParallelConsumable</B>()</PRE>
+<DL>
+<DD>Indicate whether this queue is safe for parallel consumers.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD><tt>true</tt> if safe for parallel consumers, otherwise
+ <tt>false</tt>.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/QueueDeclaration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../com/rapportive/storm/amqp/ExclusiveQueueWithBinding.html" title="class in com.rapportive.storm.amqp"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../com/rapportive/storm/amqp/SharedQueueWithBinding.html" title="class in com.rapportive.storm.amqp"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?com/rapportive/storm/amqp/QueueDeclaration.html" target="_top"><B>FRAMES</B></A> &nbsp;
+&nbsp;<A HREF="QueueDeclaration.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
+&nbsp;<SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright &#169; 2011. All Rights Reserved.
+</BODY>
+</HTML>
Oops, something went wrong.

0 comments on commit eaa000f

Please sign in to comment.