<!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_07) on Fri Mar 13 20:01:08 CET 2009 --> <TITLE> ScribeMultiClient (Rice Pastry - API Specifications) </TITLE> <META NAME="date" CONTENT="2009-03-13"> <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="ScribeMultiClient (Rice Pastry - API Specifications)"; } } </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> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ScribeMultiClient.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> Rice Pastry API</EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../rice/p2p/scribe/ScribeImpl.TopicManager.html" title="class in rice.p2p.scribe"><B>PREV CLASS</B></A> <A HREF="../../../rice/p2p/scribe/ScribePolicy.html" title="interface in rice.p2p.scribe"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?rice/p2p/scribe/ScribeMultiClient.html" target="_top"><B>FRAMES</B></A> <A HREF="ScribeMultiClient.html" target="_top"><B>NO FRAMES</B></A> <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <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"> rice.p2p.scribe</FONT> <BR> Interface ScribeMultiClient</H2> <DL> <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A></DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../rice/p2p/scribe/ScribeImpl.ScribeClientConverter.html" title="class in rice.p2p.scribe">ScribeImpl.ScribeClientConverter</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>ScribeMultiClient</B><DT>extends <A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A></DL> </PRE> <P> The new interface for scribe as of FreePastry 2.1. Handles multiple concurrent Joins/Failures. <P> <P> <DL> <DT><B>Author:</B></DT> <DD>Jeff Hoye</DD> </DL> <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> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html#anycast(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeContent)">anycast</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeContent.html" title="interface in rice.p2p.scribe">ScribeContent</A> content)</CODE> <BR> This method is invoked when an anycast is received for a topic which this client is interested in.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html#childAdded(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)">childAdded</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</CODE> <BR> Informs this client that a child was added to a topic in which it was interested in.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html#childRemoved(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)">childRemoved</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</CODE> <BR> Informs this client that a child was removed from a topic in which it was interested in.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html#deliver(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeContent)">deliver</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeContent.html" title="interface in rice.p2p.scribe">ScribeContent</A> content)</CODE> <BR> This method is invoked when a message is delivered for a topic this client is interested in.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html#subscribeFailed(java.util.Collection)">subscribeFailed</A></B>(java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>> topics)</CODE> <BR> Informs the client that a subscribe on the given topic failed - the client should retry the subscribe or take appropriate action.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html#subscribeFailed(rice.p2p.scribe.Topic)">subscribeFailed</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> <B>Deprecated.</B> <I>use subscribeFailed(Collection<Topic> topics)</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html#subscribeSuccess(java.util.Collection)">subscribeSuccess</A></B>(java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>> topics)</CODE> <BR> Informs the client that a subscribe on the given topic failed - the client should retry the subscribe or take appropriate action.</TD> </TR> </TABLE> <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="anycast(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeContent)"><!-- --></A><H3> anycast</H3> <PRE> boolean <B>anycast</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeContent.html" title="interface in rice.p2p.scribe">ScribeContent</A> content)</PRE> <DL> <DD>This method is invoked when an anycast is received for a topic which this client is interested in. The client should return whether or not the anycast should continue. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html#anycast(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeContent)">anycast</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic the message was anycasted to<DD><CODE>content</CODE> - The content which was anycasted <DT><B>Returns:</B><DD>Whether or not the anycast should continue, true if we will accept the anycast</DL> </DD> </DL> <HR> <A NAME="deliver(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeContent)"><!-- --></A><H3> deliver</H3> <PRE> void <B>deliver</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeContent.html" title="interface in rice.p2p.scribe">ScribeContent</A> content)</PRE> <DL> <DD>This method is invoked when a message is delivered for a topic this client is interested in. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html#deliver(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeContent)">deliver</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic the message was published to<DD><CODE>content</CODE> - The content which was published</DL> </DD> </DL> <HR> <A NAME="childAdded(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3> childAdded</H3> <PRE> void <B>childAdded</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</PRE> <DL> <DD>Informs this client that a child was added to a topic in which it was interested in. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html#childAdded(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)">childAdded</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic to unsubscribe from<DD><CODE>child</CODE> - The child that was added</DL> </DD> </DL> <HR> <A NAME="childRemoved(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3> childRemoved</H3> <PRE> void <B>childRemoved</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</PRE> <DL> <DD>Informs this client that a child was removed from a topic in which it was interested in. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html#childRemoved(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)">childRemoved</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic to unsubscribe from<DD><CODE>child</CODE> - The child that was removed</DL> </DD> </DL> <HR> <A NAME="subscribeFailed(rice.p2p.scribe.Topic)"><!-- --></A><H3> subscribeFailed</H3> <PRE> void <B>subscribeFailed</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD><B>Deprecated.</B> <I>use subscribeFailed(Collection<Topic> topics)</I> <P> <DD>Informs the client that a subscribe on the given topic failed - the client should retry the subscribe or take appropriate action. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html#subscribeFailed(rice.p2p.scribe.Topic)">subscribeFailed</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic which the subscribe failed on</DL> </DD> </DL> <HR> <A NAME="subscribeFailed(java.util.Collection)"><!-- --></A><H3> subscribeFailed</H3> <PRE> void <B>subscribeFailed</B>(java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>> topics)</PRE> <DL> <DD>Informs the client that a subscribe on the given topic failed - the client should retry the subscribe or take appropriate action. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic which the subscribe failed on</DL> </DD> </DL> <HR> <A NAME="subscribeSuccess(java.util.Collection)"><!-- --></A><H3> subscribeSuccess</H3> <PRE> void <B>subscribeSuccess</B>(java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>> topics)</PRE> <DL> <DD>Informs the client that a subscribe on the given topic failed - the client should retry the subscribe or take appropriate action. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic which the subscribe failed on</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> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ScribeMultiClient.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> Rice Pastry API</EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../rice/p2p/scribe/ScribeImpl.TopicManager.html" title="class in rice.p2p.scribe"><B>PREV CLASS</B></A> <A HREF="../../../rice/p2p/scribe/ScribePolicy.html" title="interface in rice.p2p.scribe"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?rice/p2p/scribe/ScribeMultiClient.html" target="_top"><B>FRAMES</B></A> <A HREF="ScribeMultiClient.html" target="_top"><B>NO FRAMES</B></A> <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> <i>Copyright © 2001-2005 - Rice Pastry.</i> </BODY> </HTML>