<!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:07 CET 2009 --> <TITLE> BaseScribe (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="BaseScribe (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/BaseScribe.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"> PREV CLASS <A HREF="../../../rice/p2p/scribe/Scribe.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/BaseScribe.html" target="_top"><B>FRAMES</B></A> <A HREF="BaseScribe.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 BaseScribe</H2> <DL> <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../rice/Destructable.html" title="interface in rice">Destructable</A></DD> </DL> <DL> <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../rice/p2p/scribe/javaserialized/JavaScribe.html" title="interface in rice.p2p.scribe.javaserialized">JavaScribe</A>, <A HREF="../../../rice/p2p/scribe/maintenance/MaintainableScribe.html" title="interface in rice.p2p.scribe.maintenance">MaintainableScribe</A>, <A HREF="../../../rice/p2p/scribe/rawserialization/RawScribe.html" title="interface in rice.p2p.scribe.rawserialization">RawScribe</A>, <A HREF="../../../rice/p2p/scribe/Scribe.html" title="interface in rice.p2p.scribe">Scribe</A></DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../rice/p2p/scribe/ScribeImpl.html" title="class in rice.p2p.scribe">ScribeImpl</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>BaseScribe</B><DT>extends <A HREF="../../../rice/Destructable.html" title="interface in rice">Destructable</A></DL> </PRE> <P> Scribe functions not specific to serialization type. <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> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#addChild(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)">addChild</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> Adds a child to the given topic</TD> </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/BaseScribe.html#containsChild(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)">containsChild</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> </TD> </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/BaseScribe.html#containsTopic(rice.p2p.scribe.Topic)">containsTopic</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> Returns true if there is a TopicManager object corresponding to this topic</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getChildren(rice.p2p.scribe.Topic)">getChildren</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 getChildrenOfTopic</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Collection<<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getChildrenOfTopic(rice.p2p.scribe.Topic)">getChildrenOfTopic</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Collection<<A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getClients(rice.p2p.scribe.Topic)">getClients</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Collection<<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getClientsByTopic(rice.p2p.scribe.Topic)">getClientsByTopic</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/environment/Environment.html" title="class in rice.environment">Environment</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getEnvironment()">getEnvironment</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getParent(rice.p2p.scribe.Topic)">getParent</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> Returns the parent node for a given topic</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/p2p/scribe/ScribePolicy.html" title="interface in rice.p2p.scribe">ScribePolicy</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getPolicy()">getPolicy</A></B>()</CODE> <BR> Returns the current policy for this scribe object</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getRoot(rice.p2p.scribe.Topic)">getRoot</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> Returns the root of the topic, if we can determine it.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getTopics(rice.p2p.scribe.ScribeClient)">getTopics</A></B>(<A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A> client)</CODE> <BR> <B>Deprecated.</B> <I>use getTopicsByClient()</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getTopicsByClient(rice.p2p.scribe.ScribeClient)">getTopicsByClient</A></B>(<A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A> client)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#getTopicsByClient(rice.p2p.scribe.ScribeMultiClient)">getTopicsByClient</A></B>(<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</CODE> <BR> </TD> </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/BaseScribe.html#isRoot(rice.p2p.scribe.Topic)">isRoot</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> Returns whether or not this Scribe is the root for the given topic</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../rice/p2p/scribe/BaseScribe.html#numChildren(rice.p2p.scribe.Topic)">numChildren</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE> <BR> </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/BaseScribe.html#removeChild(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)">removeChild</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> Removes a child from the given topic</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/BaseScribe.html#setPolicy(rice.p2p.scribe.ScribePolicy)">setPolicy</A></B>(<A HREF="../../../rice/p2p/scribe/ScribePolicy.html" title="interface in rice.p2p.scribe">ScribePolicy</A> policy)</CODE> <BR> Sets the current policy for this scribe object</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/BaseScribe.html#subscribe(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeClient)">subscribe</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A> client)</CODE> <BR> <B>Deprecated.</B> <I>use subscribe(Topic, ScribeMultiClient, ScribeContent, NodeHandle hint)</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/BaseScribe.html#unsubscribe(java.util.Collection, rice.p2p.scribe.ScribeMultiClient)">unsubscribe</A></B>(java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>> topicsToUnsubscribe, <A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</CODE> <BR> </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/BaseScribe.html#unsubscribe(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeClient)">unsubscribe</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A> client)</CODE> <BR> <B>Deprecated.</B> <I>use unsubscribe(Topic, ScribeMultiClient)</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/BaseScribe.html#unsubscribe(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeMultiClient)">unsubscribe</A></B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</CODE> <BR> </TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_rice.Destructable"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface rice.<A HREF="../../../rice/Destructable.html" title="interface in rice">Destructable</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../rice/Destructable.html#destroy()">destroy</A></CODE></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="subscribe(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeClient)"><!-- --></A><H3> subscribe</H3> <PRE> void <B>subscribe</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A> client)</PRE> <DL> <DD><B>Deprecated.</B> <I>use subscribe(Topic, ScribeMultiClient, ScribeContent, NodeHandle hint)</I> <P> <DD>Subscribes the given client to the provided topic. Any message published to the topic will be delivered to the Client via the deliver() method. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic to subscribe to<DD><CODE>client</CODE> - The client to give messages to</DL> </DD> </DL> <HR> <A NAME="unsubscribe(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeClient)"><!-- --></A><H3> unsubscribe</H3> <PRE> void <B>unsubscribe</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A> client)</PRE> <DL> <DD><B>Deprecated.</B> <I>use unsubscribe(Topic, ScribeMultiClient)</I> <P> <DD>Unsubscribes the given client from the provided topic. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic to unsubscribe from<DD><CODE>client</CODE> - The client to unsubscribe</DL> </DD> </DL> <HR> <A NAME="unsubscribe(rice.p2p.scribe.Topic, rice.p2p.scribe.ScribeMultiClient)"><!-- --></A><H3> unsubscribe</H3> <PRE> void <B>unsubscribe</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic, <A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="unsubscribe(java.util.Collection, rice.p2p.scribe.ScribeMultiClient)"><!-- --></A><H3> unsubscribe</H3> <PRE> void <B>unsubscribe</B>(java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>> topicsToUnsubscribe, <A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="addChild(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3> addChild</H3> <PRE> void <B>addChild</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>Adds a child to the given topic <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic to add the child to<DD><CODE>child</CODE> - The child to add</DL> </DD> </DL> <HR> <A NAME="removeChild(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3> removeChild</H3> <PRE> void <B>removeChild</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>Removes a child from the given topic <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic to remove the child from<DD><CODE>child</CODE> - The child to remove</DL> </DD> </DL> <HR> <A NAME="isRoot(rice.p2p.scribe.Topic)"><!-- --></A><H3> isRoot</H3> <PRE> boolean <B>isRoot</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD>Returns whether or not this Scribe is the root for the given topic <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic in question <DT><B>Returns:</B><DD>Whether or not we are currently the root</DL> </DD> </DL> <HR> <A NAME="getRoot(rice.p2p.scribe.Topic)"><!-- --></A><H3> getRoot</H3> <PRE> <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>getRoot</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD>Returns the root of the topic, if we can determine it. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - <DT><B>Returns:</B><DD>null if beyond our knowledge range</DL> </DD> </DL> <HR> <A NAME="getChildren(rice.p2p.scribe.Topic)"><!-- --></A><H3> getChildren</H3> <PRE> <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A>[] <B>getChildren</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 getChildrenOfTopic</I> <P> <DD>Returns the list of children for a given topic <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>topic</CODE> - The topic to return the children of <DT><B>Returns:</B><DD>The children of the topic</DL> </DD> </DL> <HR> <A NAME="getChildrenOfTopic(rice.p2p.scribe.Topic)"><!-- --></A><H3> getChildrenOfTopic</H3> <PRE> java.util.Collection<<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A>> <B>getChildrenOfTopic</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getParent(rice.p2p.scribe.Topic)"><!-- --></A><H3> getParent</H3> <PRE> <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>getParent</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD>Returns the parent node for a given topic <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>myTopic</CODE> - The topic to return the parent of <DT><B>Returns:</B><DD>The parent of the topic</DL> </DD> </DL> <HR> <A NAME="getTopics(rice.p2p.scribe.ScribeClient)"><!-- --></A><H3> getTopics</H3> <PRE> <A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>[] <B>getTopics</B>(<A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A> client)</PRE> <DL> <DD><B>Deprecated.</B> <I>use getTopicsByClient()</I> <P> <DD>Returns the list of topics the given client is subscribed to. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>client</CODE> - The client in question <DT><B>Returns:</B><DD>The list of topics</DL> </DD> </DL> <HR> <A NAME="getTopicsByClient(rice.p2p.scribe.ScribeClient)"><!-- --></A><H3> getTopicsByClient</H3> <PRE> java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>> <B>getTopicsByClient</B>(<A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A> client)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getTopicsByClient(rice.p2p.scribe.ScribeMultiClient)"><!-- --></A><H3> getTopicsByClient</H3> <PRE> java.util.Collection<<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A>> <B>getTopicsByClient</B>(<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="numChildren(rice.p2p.scribe.Topic)"><!-- --></A><H3> numChildren</H3> <PRE> int <B>numChildren</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getClients(rice.p2p.scribe.Topic)"><!-- --></A><H3> getClients</H3> <PRE> java.util.Collection<<A HREF="../../../rice/p2p/scribe/ScribeClient.html" title="interface in rice.p2p.scribe">ScribeClient</A>> <B>getClients</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getClientsByTopic(rice.p2p.scribe.Topic)"><!-- --></A><H3> getClientsByTopic</H3> <PRE> java.util.Collection<<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A>> <B>getClientsByTopic</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="containsTopic(rice.p2p.scribe.Topic)"><!-- --></A><H3> containsTopic</H3> <PRE> boolean <B>containsTopic</B>(<A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE> <DL> <DD>Returns true if there is a TopicManager object corresponding to this topic <P> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="containsChild(rice.p2p.scribe.Topic, rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3> containsChild</H3> <PRE> boolean <B>containsChild</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><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getPolicy()"><!-- --></A><H3> getPolicy</H3> <PRE> <A HREF="../../../rice/p2p/scribe/ScribePolicy.html" title="interface in rice.p2p.scribe">ScribePolicy</A> <B>getPolicy</B>()</PRE> <DL> <DD>Returns the current policy for this scribe object <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>The current policy for this scribe</DL> </DD> </DL> <HR> <A NAME="setPolicy(rice.p2p.scribe.ScribePolicy)"><!-- --></A><H3> setPolicy</H3> <PRE> void <B>setPolicy</B>(<A HREF="../../../rice/p2p/scribe/ScribePolicy.html" title="interface in rice.p2p.scribe">ScribePolicy</A> policy)</PRE> <DL> <DD>Sets the current policy for this scribe object <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>policy</CODE> - The current policy for this scribe</DL> </DD> </DL> <HR> <A NAME="getEnvironment()"><!-- --></A><H3> getEnvironment</H3> <PRE> <A HREF="../../../rice/environment/Environment.html" title="class in rice.environment">Environment</A> <B>getEnvironment</B>()</PRE> <DL> <DD><DL> </DL> </DD> <DD><DL> </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/BaseScribe.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"> PREV CLASS <A HREF="../../../rice/p2p/scribe/Scribe.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/BaseScribe.html" target="_top"><B>FRAMES</B></A> <A HREF="BaseScribe.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>