mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 01:26:27 +00:00
664 lines
26 KiB
HTML
664 lines
26 KiB
HTML
<!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>
|
|
ScribeImpl.TopicManager (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="ScribeImpl.TopicManager (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/ScribeImpl.TopicManager.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.ScribeClientConverter.html" title="class in rice.p2p.scribe"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.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/ScribeImpl.TopicManager.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="ScribeImpl.TopicManager.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | 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>
|
|
Class ScribeImpl.TopicManager</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>rice.p2p.scribe.ScribeImpl.TopicManager</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>Enclosing class:</B><DD><A HREF="../../../rice/p2p/scribe/ScribeImpl.html" title="class in rice.p2p.scribe">ScribeImpl</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>ScribeImpl.TopicManager</B><DT>extends java.lang.Object</DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
Class which keeps track of a given topic
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Version:</B></DT>
|
|
<DD>$Id: ScribeImpl.java 4495 2008-09-26 14:48:02Z jeffh $</DD>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>amislove</DD>
|
|
</DL>
|
|
<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>protected java.util.ArrayList<<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/ScribeImpl.TopicManager.html#children">children</A></B></CODE>
|
|
|
|
<BR>
|
|
DESCRIBE THE FIELD</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected java.util.ArrayList<<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/ScribeImpl.TopicManager.html#clients">clients</A></B></CODE>
|
|
|
|
<BR>
|
|
DESCRIBE THE FIELD</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected <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/ScribeImpl.TopicManager.html#parent">parent</A></B></CODE>
|
|
|
|
<BR>
|
|
DESCRIBE THE FIELD</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected java.util.List<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeImpl.TopicManager.html#pathToRoot">pathToRoot</A></B></CODE>
|
|
|
|
<BR>
|
|
The current path to the root for this node</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected <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/ScribeImpl.TopicManager.html#topic">topic</A></B></CODE>
|
|
|
|
<BR>
|
|
DESCRIBE THE FIELD</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== 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/ScribeImpl.TopicManager.html#addChild(rice.p2p.commonapi.NodeHandle)">addChild</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</CODE>
|
|
|
|
<BR>
|
|
Adds a feature to the Child attribute of the TopicManager object
|
|
|
|
Need to be holding lock: topicManagers</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/ScribeImpl.TopicManager.html#addClient(rice.p2p.scribe.ScribeMultiClient)">addClient</A></B>(<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</CODE>
|
|
|
|
<BR>
|
|
Adds a feature to the Client attribute of the TopicManager object</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/ScribeImpl.TopicManager.html#containsChild(rice.p2p.commonapi.NodeHandle)">containsChild</A></B>(<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/ScribeImpl.TopicManager.html#containsClient(rice.p2p.scribe.ScribeMultiClient)">containsClient</A></B>(<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</CODE>
|
|
|
|
<BR>
|
|
Returns whether or not this topic manager contains the given
|
|
client.</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/ScribeImpl.TopicManager.html#getChildren()">getChildren</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the Children attribute of the TopicManager object</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/ScribeImpl.TopicManager.html#getClients()">getClients</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the Clients attribute of the TopicManager 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/ScribeImpl.TopicManager.html#getParent()">getParent</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the Parent attribute of the TopicManager object</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeImpl.TopicManager.html#getPathToRoot()">getPathToRoot</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the PathToRoot attribute of the TopicManager object</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/ScribeImpl.TopicManager.html#getTopic()">getTopic</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the topic of the TopicManager object</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/ScribeImpl.TopicManager.html#numChildren()">numChildren</A></B>()</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/ScribeImpl.TopicManager.html#removeChild(rice.p2p.commonapi.NodeHandle)">removeChild</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</CODE>
|
|
|
|
<BR>
|
|
Removes the child from the 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/ScribeImpl.TopicManager.html#removeClient(rice.p2p.scribe.ScribeMultiClient)">removeClient</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> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeImpl.TopicManager.html#setParent(rice.p2p.commonapi.NodeHandle, java.util.List)">setParent</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
|
java.util.List<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>> pathToRoot)</CODE>
|
|
|
|
<BR>
|
|
Sets the Parent attribute of the TopicManager 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/ScribeImpl.TopicManager.html#setPathToRoot(java.util.List)">setPathToRoot</A></B>(java.util.List<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>> pathToRoot)</CODE>
|
|
|
|
<BR>
|
|
Sets the PathToRoot attribute of the TopicManager object
|
|
|
|
Don't hold the topicManagers lock, this method sends messages</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/scribe/ScribeImpl.TopicManager.html#toString()">toString</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<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="topic"><!-- --></A><H3>
|
|
topic</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> <B>topic</B></PRE>
|
|
<DL>
|
|
<DD>DESCRIBE THE FIELD
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="pathToRoot"><!-- --></A><H3>
|
|
pathToRoot</H3>
|
|
<PRE>
|
|
protected java.util.List<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>> <B>pathToRoot</B></PRE>
|
|
<DL>
|
|
<DD>The current path to the root for this node
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="clients"><!-- --></A><H3>
|
|
clients</H3>
|
|
<PRE>
|
|
protected java.util.ArrayList<<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A>> <B>clients</B></PRE>
|
|
<DL>
|
|
<DD>DESCRIBE THE FIELD
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="children"><!-- --></A><H3>
|
|
children</H3>
|
|
<PRE>
|
|
protected java.util.ArrayList<<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A>> <B>children</B></PRE>
|
|
<DL>
|
|
<DD>DESCRIBE THE FIELD
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="parent"><!-- --></A><H3>
|
|
parent</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>parent</B></PRE>
|
|
<DL>
|
|
<DD>DESCRIBE THE FIELD
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
|
|
<!-- ============ 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="getTopic()"><!-- --></A><H3>
|
|
getTopic</H3>
|
|
<PRE>
|
|
public <A HREF="../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> <B>getTopic</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the topic of the TopicManager object
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The Parent value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getParent()"><!-- --></A><H3>
|
|
getParent</H3>
|
|
<PRE>
|
|
public <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>getParent</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the Parent attribute of the TopicManager object
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The Parent value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getClients()"><!-- --></A><H3>
|
|
getClients</H3>
|
|
<PRE>
|
|
public java.util.Collection<<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A>> <B>getClients</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the Clients attribute of the TopicManager object
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The Clients value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="containsClient(rice.p2p.scribe.ScribeMultiClient)"><!-- --></A><H3>
|
|
containsClient</H3>
|
|
<PRE>
|
|
public boolean <B>containsClient</B>(<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</PRE>
|
|
<DL>
|
|
<DD>Returns whether or not this topic manager contains the given
|
|
client.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>client</CODE> - The client in question
|
|
<DT><B>Returns:</B><DD>Whether or not this manager contains the client</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getChildren()"><!-- --></A><H3>
|
|
getChildren</H3>
|
|
<PRE>
|
|
public java.util.Collection<<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A>> <B>getChildren</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the Children attribute of the TopicManager object
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The Children value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="numChildren()"><!-- --></A><H3>
|
|
numChildren</H3>
|
|
<PRE>
|
|
public int <B>numChildren</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPathToRoot()"><!-- --></A><H3>
|
|
getPathToRoot</H3>
|
|
<PRE>
|
|
public java.util.List<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>> <B>getPathToRoot</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the PathToRoot attribute of the TopicManager object
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The PathToRoot value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPathToRoot(java.util.List)"><!-- --></A><H3>
|
|
setPathToRoot</H3>
|
|
<PRE>
|
|
public void <B>setPathToRoot</B>(java.util.List<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>> pathToRoot)</PRE>
|
|
<DL>
|
|
<DD>Sets the PathToRoot attribute of the TopicManager object
|
|
|
|
Don't hold the topicManagers lock, this method sends messages
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>pathToRoot</CODE> - The new PathToRoot value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setParent(rice.p2p.commonapi.NodeHandle, java.util.List)"><!-- --></A><H3>
|
|
setParent</H3>
|
|
<PRE>
|
|
public void <B>setParent</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
|
java.util.List<<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A>> pathToRoot)</PRE>
|
|
<DL>
|
|
<DD>Sets the Parent attribute of the TopicManager object
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>handle</CODE> - The new Parent value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="toString()"><!-- --></A><H3>
|
|
toString</H3>
|
|
<PRE>
|
|
public java.lang.String <B>toString</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addClient(rice.p2p.scribe.ScribeMultiClient)"><!-- --></A><H3>
|
|
addClient</H3>
|
|
<PRE>
|
|
public void <B>addClient</B>(<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</PRE>
|
|
<DL>
|
|
<DD>Adds a feature to the Client attribute of the TopicManager object
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>client</CODE> - The feature to be added to the Client attribute</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="removeClient(rice.p2p.scribe.ScribeMultiClient)"><!-- --></A><H3>
|
|
removeClient</H3>
|
|
<PRE>
|
|
public boolean <B>removeClient</B>(<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.html" title="interface in rice.p2p.scribe">ScribeMultiClient</A> client)</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>client</CODE> - the client to remove
|
|
<DT><B>Returns:</B><DD>true if there are no children/clients remaining (you can unsubscribe from the parent)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="containsChild(rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3>
|
|
containsChild</H3>
|
|
<PRE>
|
|
public boolean <B>containsChild</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addChild(rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3>
|
|
addChild</H3>
|
|
<PRE>
|
|
public void <B>addChild</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</PRE>
|
|
<DL>
|
|
<DD>Adds a feature to the Child attribute of the TopicManager object
|
|
|
|
Need to be holding lock: topicManagers
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>child</CODE> - The feature to be added to the Child attribute</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="removeChild(rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3>
|
|
removeChild</H3>
|
|
<PRE>
|
|
public boolean <B>removeChild</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> child)</PRE>
|
|
<DL>
|
|
<DD>Removes the child from the topic.
|
|
|
|
Need to be holding lock: topicManagers
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>child</CODE> - the child to be removed
|
|
<DT><B>Returns:</B><DD>true if we can unsubscribe (IE, no clients nor children)</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/ScribeImpl.TopicManager.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.ScribeClientConverter.html" title="class in rice.p2p.scribe"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../rice/p2p/scribe/ScribeMultiClient.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/ScribeImpl.TopicManager.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="ScribeImpl.TopicManager.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | 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>
|