mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 01:26:27 +00:00
278 lines
15 KiB
HTML
278 lines
15 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:30 CET 2009 -->
|
||
|
<TITLE>
|
||
|
Application (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="Application (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/Application.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/commonapi/Cancellable.html" title="interface in rice.p2p.commonapi"><B>NEXT CLASS</B></A></FONT></TD>
|
||
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
<A HREF="../../../index.html?rice/p2p/commonapi/Application.html" target="_top"><B>FRAMES</B></A>
|
||
|
<A HREF="Application.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.commonapi</FONT>
|
||
|
<BR>
|
||
|
Interface Application</H2>
|
||
|
<DL>
|
||
|
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../rice/p2p/aggregation/AggregationImpl.html" title="class in rice.p2p.aggregation">AggregationImpl</A>, <A HREF="../../../org/mpisws/p2p/testing/transportlayer/BandwidthMeasuringTLTest.html" title="class in org.mpisws.p2p.testing.transportlayer">BandwidthMeasuringTLTest</A>, <A HREF="../../../rice/p2p/past/gc/GCPastImpl.html" title="class in rice.p2p.past.gc">GCPastImpl</A>, <A HREF="../../../rice/p2p/glacier/v2/GlacierImpl.html" title="class in rice.p2p.glacier.v2">GlacierImpl</A>, <A HREF="../../../rice/tutorial/lookup/LookupService.html" title="class in rice.tutorial.lookup">LookupService</A>, <A HREF="../../../rice/p2p/multiring/MultiringApplication.html" title="class in rice.p2p.multiring">MultiringApplication</A>, <A HREF="../../../rice/p2p/multiring/testing/MultiringRegrTest.MultiringTestApp.html" title="class in rice.p2p.multiring.testing">MultiringRegrTest.MultiringTestApp</A>, <A HREF="../../../rice/pastry/testing/rendezvous/MyApp.html" title="class in rice.pastry.testing.rendezvous">MyApp</A>, <A HREF="../../../rice/tutorial/appsocket/MyApp.html" title="class in rice.tutorial.appsocket">MyApp</A>, <A HREF="../../../rice/tutorial/deterministicsimulator/MyApp.html" title="class in rice.tutorial.deterministicsimulator">MyApp</A>, <A HREF="../../../rice/tutorial/direct/MyApp.html" title="class in rice.tutorial.direct">MyApp</A>, <A HREF="../../../rice/tutorial/forwarding/MyApp.html" title="class in rice.tutorial.forwarding">MyApp</A>, <A HREF="../../../rice/tutorial/gtitm/MyApp.html" title="class in rice.tutorial.gtitm">MyApp</A>, <A HREF="../../../rice/tutorial/lesson3/MyApp.html" title="class in rice.tutorial.lesson3">MyApp</A>, <A HREF="../../../rice/tutorial/lesson4/MyApp.html" title="class in rice.tutorial.lesson4">MyApp</A>, <A HREF="../../../rice/tutorial/prioritylistener/MyApp.html" title="class in rice.tutorial.prioritylistener">MyApp</A>, <A HREF="../../../rice/tutorial/rawserialization/MyApp.html" title="class in rice.tutorial.rawserialization">MyApp</A>, <A HREF="../../../rice/tutorial/rawserialization2/MyApp.html" title="class in rice.tutorial.rawserialization2">MyApp</A>, <A HREF="../../../rice/tutorial/remotesocket/MyApp.html" title="class in rice.tutorial.remotesocket">MyApp</A>, <A HREF="../../../rice/tutorial/sendfile/MyApp.html" title="class in rice.tutorial.sendfile">MyApp</A>, <A HREF="../../../rice/tutorial/ssl/MyApp.html" title="class in rice.tutorial.ssl">MyApp</A>, <A HREF="../../../rice/tutorial/timer/MyApp.html" title="class in rice.tutorial.timer">MyApp</A>, <A HREF="../../../rice/tutorial/transportdirect/MyApp.html" title="class in rice.tutorial.transportdirect">MyApp</A>, <A HREF="../../../rice/tutorial/transportlayer/MyApp.html" title="class in rice.tutorial.transportlayer">MyApp</A>, <A HREF="../../../org/mpisws/p2p/testing/transportlayer/replay/MyScribeClient.html" title="class in org.mpisws.p2p.testing.transportlayer.replay">MyScribeClient</A>, <A HREF="../../../rice/tutorial/scribe/MyScribeClient.html" title="class in rice.tutorial.scribe">MyScribeClient</A>, <A HREF="../../../rice/tutorial/splitstream/MySplitStreamClient.html" title="class in rice.tutorial.splitstream">MySplitStreamClient</A>, <A HREF="../../../rice/p2p/past/PastImpl.html" title="class in rice.p2p.past">PastImpl</A>, <A HREF="../../../rice/p2p/replication/ReplicationImpl.html" title="class in rice.p2p.replication">ReplicationImpl</A>, <A HREF="../../../rice/p2p/replication/manager/ReplicationManagerImpl.html" title="class in rice.p2p.replication.manager">ReplicationManagerImpl</A>, <A HREF="../../../rice/pastry/testing/RoutingTableTest.MyApp.html" title="class in rice.pastry.testing">RoutingTableTest.MyApp</A>, <A HREF="../../../rice/p2p/scribe/ScribeImpl.html" title="class in rice.p2p.scribe">ScribeImpl</A></DD>
|
||
|
</DL>
|
||
|
<HR>
|
||
|
<DL>
|
||
|
<DT><PRE>public interface <B>Application</B></DL>
|
||
|
</PRE>
|
||
|
|
||
|
<P>
|
||
|
<DL>
|
||
|
<DT><B>Version:</B></DT>
|
||
|
<DD>$Id: Application.java 3613 2007-02-15 14:45:14Z jstewart $</DD>
|
||
|
<DT><B>Author:</B></DT>
|
||
|
<DD>Alan Mislove, Peter Druschel</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/commonapi/Application.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> boolean</CODE></FONT></TD>
|
||
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Application.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> void</CODE></FONT></TD>
|
||
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Application.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>
|
||
|
|
||
|
<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="forward(rice.p2p.commonapi.RouteMessage)"><!-- --></A><H3>
|
||
|
forward</H3>
|
||
|
<PRE>
|
||
|
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>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>
|
||
|
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>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>
|
||
|
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>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>
|
||
|
<!-- ========= 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/Application.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/commonapi/Cancellable.html" title="interface in rice.p2p.commonapi"><B>NEXT CLASS</B></A></FONT></TD>
|
||
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
<A HREF="../../../index.html?rice/p2p/commonapi/Application.html" target="_top"><B>FRAMES</B></A>
|
||
|
<A HREF="Application.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>
|