mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 01:26:27 +00:00
712 lines
31 KiB
HTML
712 lines
31 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:11 CET 2009 -->
|
|
<TITLE>
|
|
ReplicationImpl (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="ReplicationImpl (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/ReplicationImpl.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/replication/ReplicationClient.html" title="interface in rice.p2p.replication"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../rice/p2p/replication/ReplicationImpl.BloomFilterExecutable.html" title="class in rice.p2p.replication"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?rice/p2p/replication/ReplicationImpl.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="ReplicationImpl.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: <A HREF="#nested_class_summary">NESTED</A> | <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.replication</FONT>
|
|
<BR>
|
|
Class ReplicationImpl</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>rice.p2p.replication.ReplicationImpl</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../rice/Destructable.html" title="interface in rice">Destructable</A>, <A HREF="../../../rice/p2p/commonapi/Application.html" title="interface in rice.p2p.commonapi">Application</A>, <A HREF="../../../rice/p2p/replication/Replication.html" title="interface in rice.p2p.replication">Replication</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>ReplicationImpl</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../rice/p2p/replication/Replication.html" title="interface in rice.p2p.replication">Replication</A>, <A HREF="../../../rice/p2p/commonapi/Application.html" title="interface in rice.p2p.commonapi">Application</A>, <A HREF="../../../rice/Destructable.html" title="interface in rice">Destructable</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Version:</B></DT>
|
|
<DD>$Id: ReplicationImpl.java 4654 2009-01-08 16:33:07Z jeffh $</DD>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Alan Mislove</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected class</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.BloomFilterExecutable.html" title="class in rice.p2p.replication">ReplicationImpl.BloomFilterExecutable</A></B></CODE>
|
|
|
|
<BR>
|
|
Internal class which is an executable for creating a bloom filter</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== 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/replication/ReplicationClient.html" title="interface in rice.p2p.replication">ReplicationClient</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#client">client</A></B></CODE>
|
|
|
|
<BR>
|
|
This replication's client</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#destroyed">destroyed</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected <A HREF="../../../rice/p2p/commonapi/Endpoint.html" title="interface in rice.p2p.commonapi">Endpoint</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#endpoint">endpoint</A></B></CODE>
|
|
|
|
<BR>
|
|
this application's endpoint</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected <A HREF="../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#factory">factory</A></B></CODE>
|
|
|
|
<BR>
|
|
The factory for create IdSets and IdRanges</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/replication/ReplicationImpl.html#handle">handle</A></B></CODE>
|
|
|
|
<BR>
|
|
the local node handle</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#instance">instance</A></B></CODE>
|
|
|
|
<BR>
|
|
The instance name of the replication</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/replication/ReplicationImpl.html#MAINTENANCE_INTERVAL">MAINTENANCE_INTERVAL</A></B></CODE>
|
|
|
|
<BR>
|
|
The amount of time to wait between replications</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/replication/ReplicationImpl.html#MAX_KEYS_IN_MESSAGE">MAX_KEYS_IN_MESSAGE</A></B></CODE>
|
|
|
|
<BR>
|
|
The maximum number of keys to return in one message</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected <A HREF="../../../rice/p2p/replication/ReplicationPolicy.html" title="interface in rice.p2p.replication">ReplicationPolicy</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#policy">policy</A></B></CODE>
|
|
|
|
<BR>
|
|
This replication's policy, which allows for application-specific replication</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#replicationFactor">replicationFactor</A></B></CODE>
|
|
|
|
<BR>
|
|
The replication factor for this replication</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/replication/ReplicationImpl.html#ReplicationImpl(rice.p2p.commonapi.Node, rice.p2p.replication.ReplicationClient, int, java.lang.String)">ReplicationImpl</A></B>(<A HREF="../../../rice/p2p/commonapi/Node.html" title="interface in rice.p2p.commonapi">Node</A> node,
|
|
<A HREF="../../../rice/p2p/replication/ReplicationClient.html" title="interface in rice.p2p.replication">ReplicationClient</A> client,
|
|
int replicationFactor,
|
|
java.lang.String instance)</CODE>
|
|
|
|
<BR>
|
|
Constructor</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#ReplicationImpl(rice.p2p.commonapi.Node, rice.p2p.replication.ReplicationClient, int, java.lang.String, rice.p2p.replication.ReplicationPolicy)">ReplicationImpl</A></B>(<A HREF="../../../rice/p2p/commonapi/Node.html" title="interface in rice.p2p.commonapi">Node</A> node,
|
|
<A HREF="../../../rice/p2p/replication/ReplicationClient.html" title="interface in rice.p2p.replication">ReplicationClient</A> client,
|
|
int replicationFactor,
|
|
java.lang.String instance,
|
|
<A HREF="../../../rice/p2p/replication/ReplicationPolicy.html" title="interface in rice.p2p.replication">ReplicationPolicy</A> policy)</CODE>
|
|
|
|
<BR>
|
|
Constructor</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/replication/ReplicationImpl.html#deliver(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message)">deliver</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
|
<A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A> message)</CODE>
|
|
|
|
<BR>
|
|
This method is called on the application at the destination node
|
|
for the given id.</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/replication/ReplicationImpl.html#destroy()">destroy</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/replication/ReplicationImpl.html#forward(rice.p2p.commonapi.RouteMessage)">forward</A></B>(<A HREF="../../../rice/p2p/commonapi/RouteMessage.html" title="interface in rice.p2p.commonapi">RouteMessage</A> message)</CODE>
|
|
|
|
<BR>
|
|
This method is invoked on applications when the underlying node
|
|
is about to forward the given message with the provided target to
|
|
the specified next hop.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected <A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#getTotalRange()">getTotalRange</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the range for which the local node is an i root, where i can range between
|
|
0 and replicationFactor
|
|
|
|
can return null if the range can't be determined</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static <A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/replication/ReplicationImpl.html#merge(rice.p2p.commonapi.IdFactory, rice.p2p.commonapi.IdSet, rice.p2p.commonapi.IdSet)">merge</A></B>(<A HREF="../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> factory,
|
|
<A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> a,
|
|
<A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> b)</CODE>
|
|
|
|
<BR>
|
|
Internal method which takes returns set A + set B, or all of the members
|
|
of set A and set B.</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/replication/ReplicationImpl.html#replicate()">replicate</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This internal method sends out the request messages to all of the nodes
|
|
which hold keys this node may be 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/replication/ReplicationImpl.html#update(rice.p2p.commonapi.NodeHandle, boolean)">update</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
|
boolean joined)</CODE>
|
|
|
|
<BR>
|
|
This method is invoked to inform the application that the given node
|
|
has either joined or left the neighbor set of the local node, as the set
|
|
would be returned by the neighborSet call.</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="MAINTENANCE_INTERVAL"><!-- --></A><H3>
|
|
MAINTENANCE_INTERVAL</H3>
|
|
<PRE>
|
|
public final int <B>MAINTENANCE_INTERVAL</B></PRE>
|
|
<DL>
|
|
<DD>The amount of time to wait between replications
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="MAX_KEYS_IN_MESSAGE"><!-- --></A><H3>
|
|
MAX_KEYS_IN_MESSAGE</H3>
|
|
<PRE>
|
|
public final int <B>MAX_KEYS_IN_MESSAGE</B></PRE>
|
|
<DL>
|
|
<DD>The maximum number of keys to return in one message
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="endpoint"><!-- --></A><H3>
|
|
endpoint</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../rice/p2p/commonapi/Endpoint.html" title="interface in rice.p2p.commonapi">Endpoint</A> <B>endpoint</B></PRE>
|
|
<DL>
|
|
<DD>this application's endpoint
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="handle"><!-- --></A><H3>
|
|
handle</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>handle</B></PRE>
|
|
<DL>
|
|
<DD>the local node handle
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="factory"><!-- --></A><H3>
|
|
factory</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> <B>factory</B></PRE>
|
|
<DL>
|
|
<DD>The factory for create IdSets and IdRanges
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="client"><!-- --></A><H3>
|
|
client</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../rice/p2p/replication/ReplicationClient.html" title="interface in rice.p2p.replication">ReplicationClient</A> <B>client</B></PRE>
|
|
<DL>
|
|
<DD>This replication's client
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="policy"><!-- --></A><H3>
|
|
policy</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../rice/p2p/replication/ReplicationPolicy.html" title="interface in rice.p2p.replication">ReplicationPolicy</A> <B>policy</B></PRE>
|
|
<DL>
|
|
<DD>This replication's policy, which allows for application-specific replication
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="replicationFactor"><!-- --></A><H3>
|
|
replicationFactor</H3>
|
|
<PRE>
|
|
protected int <B>replicationFactor</B></PRE>
|
|
<DL>
|
|
<DD>The replication factor for this replication
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="instance"><!-- --></A><H3>
|
|
instance</H3>
|
|
<PRE>
|
|
protected java.lang.String <B>instance</B></PRE>
|
|
<DL>
|
|
<DD>The instance name of the replication
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="destroyed"><!-- --></A><H3>
|
|
destroyed</H3>
|
|
<PRE>
|
|
protected boolean <B>destroyed</B></PRE>
|
|
<DL>
|
|
<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="ReplicationImpl(rice.p2p.commonapi.Node, rice.p2p.replication.ReplicationClient, int, java.lang.String)"><!-- --></A><H3>
|
|
ReplicationImpl</H3>
|
|
<PRE>
|
|
public <B>ReplicationImpl</B>(<A HREF="../../../rice/p2p/commonapi/Node.html" title="interface in rice.p2p.commonapi">Node</A> node,
|
|
<A HREF="../../../rice/p2p/replication/ReplicationClient.html" title="interface in rice.p2p.replication">ReplicationClient</A> client,
|
|
int replicationFactor,
|
|
java.lang.String instance)</PRE>
|
|
<DL>
|
|
<DD>Constructor
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>node</CODE> - The node below this Replication implementation<DD><CODE>client</CODE> - The client for this Replication<DD><CODE>replicationFactor</CODE> - The replication factor for this instance<DD><CODE>instance</CODE> - The unique instance name of this Replication</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="ReplicationImpl(rice.p2p.commonapi.Node, rice.p2p.replication.ReplicationClient, int, java.lang.String, rice.p2p.replication.ReplicationPolicy)"><!-- --></A><H3>
|
|
ReplicationImpl</H3>
|
|
<PRE>
|
|
public <B>ReplicationImpl</B>(<A HREF="../../../rice/p2p/commonapi/Node.html" title="interface in rice.p2p.commonapi">Node</A> node,
|
|
<A HREF="../../../rice/p2p/replication/ReplicationClient.html" title="interface in rice.p2p.replication">ReplicationClient</A> client,
|
|
int replicationFactor,
|
|
java.lang.String instance,
|
|
<A HREF="../../../rice/p2p/replication/ReplicationPolicy.html" title="interface in rice.p2p.replication">ReplicationPolicy</A> policy)</PRE>
|
|
<DL>
|
|
<DD>Constructor
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>node</CODE> - The node below this Replication implementation<DD><CODE>client</CODE> - The client for this Replication<DD><CODE>replicationFactor</CODE> - The replication factor for this instance<DD><CODE>instance</CODE> - The unique instance name of this Replication</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="merge(rice.p2p.commonapi.IdFactory, rice.p2p.commonapi.IdSet, rice.p2p.commonapi.IdSet)"><!-- --></A><H3>
|
|
merge</H3>
|
|
<PRE>
|
|
public static <A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> <B>merge</B>(<A HREF="../../../rice/p2p/commonapi/IdFactory.html" title="interface in rice.p2p.commonapi">IdFactory</A> factory,
|
|
<A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> a,
|
|
<A HREF="../../../rice/p2p/commonapi/IdSet.html" title="interface in rice.p2p.commonapi">IdSet</A> b)</PRE>
|
|
<DL>
|
|
<DD>Internal method which takes returns set A + set B, or all of the members
|
|
of set A and set B.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>a</CODE> - The first set<DD><CODE>b</CODE> - The second set
|
|
<DT><B>Returns:</B><DD>The merge, a+b</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTotalRange()"><!-- --></A><H3>
|
|
getTotalRange</H3>
|
|
<PRE>
|
|
protected <A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> <B>getTotalRange</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the range for which the local node is an i root, where i can range between
|
|
0 and replicationFactor
|
|
|
|
can return null if the range can't be determined
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The *total* range</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="replicate()"><!-- --></A><H3>
|
|
replicate</H3>
|
|
<PRE>
|
|
public void <B>replicate</B>()</PRE>
|
|
<DL>
|
|
<DD>This internal method sends out the request messages to all of the nodes
|
|
which hold keys this node may be interested in
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/replication/Replication.html#replicate()">replicate</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/replication/Replication.html" title="interface in rice.p2p.replication">Replication</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="forward(rice.p2p.commonapi.RouteMessage)"><!-- --></A><H3>
|
|
forward</H3>
|
|
<PRE>
|
|
public boolean <B>forward</B>(<A HREF="../../../rice/p2p/commonapi/RouteMessage.html" title="interface in rice.p2p.commonapi">RouteMessage</A> message)</PRE>
|
|
<DL>
|
|
<DD>This method is invoked on applications when the underlying node
|
|
is about to forward the given message with the provided target to
|
|
the specified next hop. Applications can change the contents of
|
|
the message, specify a different nextHop (through re-routing), or
|
|
completely terminate the message.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/commonapi/Application.html#forward(rice.p2p.commonapi.RouteMessage)">forward</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/commonapi/Application.html" title="interface in rice.p2p.commonapi">Application</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message being sent, containing an internal message
|
|
along with a destination key and nodeHandle next hop.
|
|
<DT><B>Returns:</B><DD>Whether or not to forward the message further</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="deliver(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message)"><!-- --></A><H3>
|
|
deliver</H3>
|
|
<PRE>
|
|
public void <B>deliver</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
|
<A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A> message)</PRE>
|
|
<DL>
|
|
<DD>This method is called on the application at the destination node
|
|
for the given id.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/commonapi/Application.html#deliver(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message)">deliver</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/commonapi/Application.html" title="interface in rice.p2p.commonapi">Application</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The destination id of the message<DD><CODE>message</CODE> - The message being sent</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="update(rice.p2p.commonapi.NodeHandle, boolean)"><!-- --></A><H3>
|
|
update</H3>
|
|
<PRE>
|
|
public void <B>update</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
|
boolean joined)</PRE>
|
|
<DL>
|
|
<DD>This method is invoked to inform the application that the given node
|
|
has either joined or left the neighbor set of the local node, as the set
|
|
would be returned by the neighborSet call.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/commonapi/Application.html#update(rice.p2p.commonapi.NodeHandle, boolean)">update</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/commonapi/Application.html" title="interface in rice.p2p.commonapi">Application</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>handle</CODE> - The handle that has joined/left<DD><CODE>joined</CODE> - Whether the node has joined or left</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="destroy()"><!-- --></A><H3>
|
|
destroy</H3>
|
|
<PRE>
|
|
public void <B>destroy</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/Destructable.html#destroy()">destroy</A></CODE> in interface <CODE><A HREF="../../../rice/Destructable.html" title="interface in rice">Destructable</A></CODE></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/ReplicationImpl.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/replication/ReplicationClient.html" title="interface in rice.p2p.replication"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../rice/p2p/replication/ReplicationImpl.BloomFilterExecutable.html" title="class in rice.p2p.replication"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?rice/p2p/replication/ReplicationImpl.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="ReplicationImpl.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: <A HREF="#nested_class_summary">NESTED</A> | <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>
|