mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 01:26:27 +00:00
476 lines
20 KiB
HTML
476 lines
20 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:00 CET 2009 -->
|
||
|
|
<TITLE>
|
||
|
|
Channel (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="Channel (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/Channel.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/splitstream/ChannelId.html" title="class in rice.p2p.splitstream"><B>NEXT CLASS</B></A></FONT></TD>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../index.html?rice/p2p/splitstream/Channel.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="Channel.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> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.splitstream</FONT>
|
||
|
|
<BR>
|
||
|
|
Class Channel</H2>
|
||
|
|
<PRE>
|
||
|
|
java.lang.Object
|
||
|
|
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>rice.p2p.splitstream.Channel</B>
|
||
|
|
</PRE>
|
||
|
|
<HR>
|
||
|
|
<DL>
|
||
|
|
<DT><PRE>public class <B>Channel</B><DT>extends java.lang.Object</DL>
|
||
|
|
</PRE>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
The channel controls all the meta data associated with a group of stripes. It contains the
|
||
|
|
stripes themselves, and one of the stripe is the primary stripe for this channel.
|
||
|
|
A stripe whose topicId matches some prefix with local node id, then it becomes its primary stripe.
|
||
|
|
A channelId uniquely identifies a channel. Number of stripes is obtained by pow(2, STRIPE_BASE), so for
|
||
|
|
STRIPE_BASE = 4, it is 16. Stripe identifiers are obtained by replacing first digit by every possible value of
|
||
|
|
a digit and second digit by 8. So, if channelId is <0x1AB88..>, then stripe id's generated are <0x08B88..>,
|
||
|
|
<0x18B88..>, <0x28B88..> etc.
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>Version:</B></DT>
|
||
|
|
<DD>$Id: Channel.java 3613 2007-02-15 14:45:14Z jstewart $</DD>
|
||
|
|
<DT><B>Author:</B></DT>
|
||
|
|
<DD>Ansley Post, Alan Mislove, Atul Singh</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 <A HREF="../../../rice/p2p/splitstream/ChannelId.html" title="class in rice.p2p.splitstream">ChannelId</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/splitstream/Channel.html#channelId">channelId</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
ChannelId for this channel</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>protected <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/splitstream/Channel.html#localId">localId</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
The Id of the local node</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>protected <A HREF="../../../rice/p2p/splitstream/Stripe.html" title="class in rice.p2p.splitstream">Stripe</A>[]</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/splitstream/Channel.html#stripes">stripes</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
The list of stripeIds for this channel</TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
|
|
||
|
|
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/splitstream/Channel.html#Channel(rice.p2p.splitstream.ChannelId, rice.p2p.scribe.Scribe, java.lang.String, rice.p2p.commonapi.IdFactory, rice.p2p.commonapi.Id, int, int)">Channel</A></B>(<A HREF="../../../rice/p2p/splitstream/ChannelId.html" title="class in rice.p2p.splitstream">ChannelId</A> channelId,
|
||
|
|
<A HREF="../../../rice/p2p/scribe/Scribe.html" title="interface in rice.p2p.scribe">Scribe</A> scribe,
|
||
|
|
java.lang.String instance,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> factory,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> localId,
|
||
|
|
int stripeBase,
|
||
|
|
int maxFailedSubscriptions)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Constructor to create a new channel from scratch</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>protected <A HREF="../../../rice/p2p/splitstream/StripeId.html" title="class in rice.p2p.splitstream">StripeId</A>[]</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/splitstream/Channel.html#generateStripeIds(rice.p2p.splitstream.ChannelId, rice.p2p.commonapi.IdFactory)">generateStripeIds</A></B>(<A HREF="../../../rice/p2p/splitstream/ChannelId.html" title="class in rice.p2p.splitstream">ChannelId</A> id,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> factory)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Creates and returns the Ids associated with the provided channelId</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/splitstream/ChannelId.html" title="class in rice.p2p.splitstream">ChannelId</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/splitstream/Channel.html#getChannelId()">getChannelId</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the channelId for this channel</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <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/splitstream/Channel.html#getLocalId()">getLocalId</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the local node id.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>protected <A HREF="../../../rice/p2p/splitstream/Stripe.html" title="class in rice.p2p.splitstream">Stripe</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/splitstream/Channel.html#getPrimaryStripe()">getPrimaryStripe</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
The primary stripe is the stripe that the user must have.</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/splitstream/Channel.html#getStripeBase()">getStripeBase</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/splitstream/Stripe.html" title="class in rice.p2p.splitstream">Stripe</A>[]</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/splitstream/Channel.html#getStripes()">getStripes</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
At any moment a node is subscribed to at least 1 but possibly more stripes.</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, toString, 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="channelId"><!-- --></A><H3>
|
||
|
|
channelId</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <A HREF="../../../rice/p2p/splitstream/ChannelId.html" title="class in rice.p2p.splitstream">ChannelId</A> <B>channelId</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>ChannelId for this channel
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="stripes"><!-- --></A><H3>
|
||
|
|
stripes</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <A HREF="../../../rice/p2p/splitstream/Stripe.html" title="class in rice.p2p.splitstream">Stripe</A>[] <B>stripes</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>The list of stripeIds for this channel
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="localId"><!-- --></A><H3>
|
||
|
|
localId</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>localId</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>The Id of the local node
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
|
|
||
|
|
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<A NAME="Channel(rice.p2p.splitstream.ChannelId, rice.p2p.scribe.Scribe, java.lang.String, rice.p2p.commonapi.IdFactory, rice.p2p.commonapi.Id, int, int)"><!-- --></A><H3>
|
||
|
|
Channel</H3>
|
||
|
|
<PRE>
|
||
|
|
public <B>Channel</B>(<A HREF="../../../rice/p2p/splitstream/ChannelId.html" title="class in rice.p2p.splitstream">ChannelId</A> channelId,
|
||
|
|
<A HREF="../../../rice/p2p/scribe/Scribe.html" title="interface in rice.p2p.scribe">Scribe</A> scribe,
|
||
|
|
java.lang.String instance,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> factory,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> localId,
|
||
|
|
int stripeBase,
|
||
|
|
int maxFailedSubscriptions)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Constructor to create a new channel from scratch
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>channelId</CODE> - The Id of the channel<DD><CODE>scribe</CODE> - The underlying stripe object<DD><CODE>factory</CODE> - The Id factory<DD><CODE>localId</CODE> - The local Id</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="getLocalId()"><!-- --></A><H3>
|
||
|
|
getLocalId</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>getLocalId</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the local node id.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>The local node id</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getChannelId()"><!-- --></A><H3>
|
||
|
|
getChannelId</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../rice/p2p/splitstream/ChannelId.html" title="class in rice.p2p.splitstream">ChannelId</A> <B>getChannelId</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the channelId for this channel
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>ChannelId the channelId for this channel</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getStripes()"><!-- --></A><H3>
|
||
|
|
getStripes</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../rice/p2p/splitstream/Stripe.html" title="class in rice.p2p.splitstream">Stripe</A>[] <B>getStripes</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>At any moment a node is subscribed to at least 1 but possibly more stripes. They will always be
|
||
|
|
subscribed to their primary Stripe.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>Vector the Stripes this node is subscribed to.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getPrimaryStripe()"><!-- --></A><H3>
|
||
|
|
getPrimaryStripe</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <A HREF="../../../rice/p2p/splitstream/Stripe.html" title="class in rice.p2p.splitstream">Stripe</A> <B>getPrimaryStripe</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>The primary stripe is the stripe that the user must have.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>Stripe The Stripe object that is the primary stripe.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getStripeBase()"><!-- --></A><H3>
|
||
|
|
getStripeBase</H3>
|
||
|
|
<PRE>
|
||
|
|
public int <B>getStripeBase</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="generateStripeIds(rice.p2p.splitstream.ChannelId, rice.p2p.commonapi.IdFactory)"><!-- --></A><H3>
|
||
|
|
generateStripeIds</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <A HREF="../../../rice/p2p/splitstream/StripeId.html" title="class in rice.p2p.splitstream">StripeId</A>[] <B>generateStripeIds</B>(<A HREF="../../../rice/p2p/splitstream/ChannelId.html" title="class in rice.p2p.splitstream">ChannelId</A> id,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> factory)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Creates and returns the Ids associated with the provided channelId
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>channelId</CODE> - The id of the channel
|
||
|
|
<DT><B>Returns:</B><DD>The array of stripeIds based on this channelId</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/Channel.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/splitstream/ChannelId.html" title="class in rice.p2p.splitstream"><B>NEXT CLASS</B></A></FONT></TD>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../index.html?rice/p2p/splitstream/Channel.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="Channel.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> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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>
|