mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 01:26:27 +00:00
1226 lines
61 KiB
HTML
1226 lines
61 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>
|
||
|
|
Endpoint (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="Endpoint (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/Endpoint.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/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi"><B>PREV CLASS</B></A>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.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/Endpoint.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="Endpoint.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 Endpoint</H2>
|
||
|
|
<DL>
|
||
|
|
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../rice/p2p/commonapi/rawserialization/NodeHandleReader.html" title="interface in rice.p2p.commonapi.rawserialization">NodeHandleReader</A></DD>
|
||
|
|
</DL>
|
||
|
|
<DL>
|
||
|
|
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../rice/p2p/past/gc/GCEndpoint.html" title="class in rice.p2p.past.gc">GCEndpoint</A>, <A HREF="../../../rice/p2p/multiring/MultiringEndpoint.html" title="class in rice.p2p.multiring">MultiringEndpoint</A>, <A HREF="../../../rice/pastry/commonapi/PastryEndpoint.html" title="class in rice.pastry.commonapi">PastryEndpoint</A></DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
<DL>
|
||
|
|
<DT><PRE>public interface <B>Endpoint</B><DT>extends <A HREF="../../../rice/p2p/commonapi/rawserialization/NodeHandleReader.html" title="interface in rice.p2p.commonapi.rawserialization">NodeHandleReader</A></DL>
|
||
|
|
</PRE>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>Version:</B></DT>
|
||
|
|
<DD>$Id: Endpoint.java 4654 2009-01-08 16:33:07Z jeffh $</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/Endpoint.html#accept(rice.p2p.commonapi.appsocket.AppSocketReceiver)">accept</A></B>(<A HREF="../../../rice/p2p/commonapi/appsocket/AppSocketReceiver.html" title="interface in rice.p2p.commonapi.appsocket">AppSocketReceiver</A> receiver)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Set's the acceptor for this application.</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/Endpoint.html#connect(rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.appsocket.AppSocketReceiver, int)">connect</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/appsocket/AppSocketReceiver.html" title="interface in rice.p2p.commonapi.appsocket">AppSocketReceiver</A> receiver,
|
||
|
|
int timeout)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Opens a connection to this application on a remote node.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/rawserialization/MessageDeserializer.html" title="interface in rice.p2p.commonapi.rawserialization">MessageDeserializer</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#getDeserializer()">getDeserializer</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the deserializer.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/environment/Environment.html" title="class in rice.environment">Environment</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#getEnvironment()">getEnvironment</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the environment.</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/commonapi/Endpoint.html#getId()">getId</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns this node's id, which is its identifier in the namespace.</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/commonapi/Endpoint.html#getInstance()">getInstance</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns a unique instance name of this endpoint, sort of a mailbox name for this
|
||
|
|
application.</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/commonapi/Endpoint.html#getLocalNodeHandle()">getLocalNodeHandle</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns a handle to the local node below this endpoint.</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/Endpoint.html#isAlive(rice.p2p.commonapi.NodeHandle)">isAlive</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> nh)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#localLookup(rice.p2p.commonapi.Id, int, boolean)">localLookup</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
int num,
|
||
|
|
boolean safe)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
This call produces a list of nodes that can be used as next hops on a route towards
|
||
|
|
the given id, such that the resulting route satisfies the overlay protocol's bounds
|
||
|
|
on the number of hops taken.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#neighborSet(int)">neighborSet</A></B>(int num)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
This methods returns an unordered set of nodehandles on which are neighbors of the local
|
||
|
|
node in the id space.</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/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#networkNeighbors(int)">networkNeighbors</A></B>(int num)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns an ordered list of the nearest known neighbors.</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/Endpoint.html#process(rice.Executable, rice.Continuation)">process</A></B>(<A HREF="../../../rice/Executable.html" title="interface in rice">Executable</A> task,
|
||
|
|
<A HREF="../../../rice/Continuation.html" title="interface in rice">Continuation</A> command)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Schedules a job for processing on the dedicated processing thread.</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/commonapi/Endpoint.html#proximity(rice.p2p.commonapi.NodeHandle)">proximity</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> nh)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
This replaces NodeHandle.proximity(), so that you don't have to have a "coalesced" NodeHandle.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <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/commonapi/Endpoint.html#range(rice.p2p.commonapi.NodeHandle, int, rice.p2p.commonapi.Id)">range</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
||
|
|
int rank,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> lkey)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
This operation provides information about ranges of keys for which the node is currently
|
||
|
|
a rank-root.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <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/commonapi/Endpoint.html#range(rice.p2p.commonapi.NodeHandle, int, rice.p2p.commonapi.Id, boolean)">range</A></B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
||
|
|
int rank,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> lkey,
|
||
|
|
boolean cumulative)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
This operation provides information about ranges of keys for which the node is currently
|
||
|
|
a rank-root.</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/commonapi/Endpoint.html#readId(rice.p2p.commonapi.rawserialization.InputBuffer, short)">readId</A></B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf,
|
||
|
|
short type)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
To use a more efficient serialization format than Java Serialization</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <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/commonapi/Endpoint.html#readIdRange(rice.p2p.commonapi.rawserialization.InputBuffer)">readIdRange</A></B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
To use Raw Serialization</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/commonapi/Endpoint.html#readNodeHandle(rice.p2p.commonapi.rawserialization.InputBuffer)">readNodeHandle</A></B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
To use Raw Serialization</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#readNodeHandleSet(rice.p2p.commonapi.rawserialization.InputBuffer, short)">readNodeHandleSet</A></B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf,
|
||
|
|
short type)</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/commonapi/Endpoint.html#register()">register</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Call this after you have set up your Endpoint:
|
||
|
|
called setDeserializer(), called accept().</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#replicaSet(rice.p2p.commonapi.Id, int)">replicaSet</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
int maxRank)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
This method returns an ordered set of nodehandles on which replicas of an object with
|
||
|
|
a given id can be stored.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#replicaSet(rice.p2p.commonapi.Id, int, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.NodeHandleSet)">replicaSet</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
int maxRank,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> root,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A> set)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
This methods returns an ordered set of nodehandles on which replicas of an object with
|
||
|
|
a given id can be stored.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#route(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message, rice.p2p.commonapi.NodeHandle)">route</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,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#route(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.DeliveryNotification)">route</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,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi">DeliveryNotification</A> deliverAckToMe)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#route(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.DeliveryNotification, java.util.Map)">route</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,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi">DeliveryNotification</A> deliverAckToMe,
|
||
|
|
java.util.Map<java.lang.String,java.lang.Object> options)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
This method makes an attempt to route the message to the root of the given id.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#route(rice.p2p.commonapi.Id, rice.p2p.commonapi.rawserialization.RawMessage, rice.p2p.commonapi.NodeHandle)">route</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/rawserialization/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A> message,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#route(rice.p2p.commonapi.Id, rice.p2p.commonapi.rawserialization.RawMessage, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.DeliveryNotification)">route</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/rawserialization/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A> message,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi">DeliveryNotification</A> deliverAckToMe)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#route(rice.p2p.commonapi.Id, rice.p2p.commonapi.rawserialization.RawMessage, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.DeliveryNotification, java.util.Map)">route</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/rawserialization/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A> message,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi">DeliveryNotification</A> deliverAckToMe,
|
||
|
|
java.util.Map<java.lang.String,java.lang.Object> options)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Same as the other call, but uses the Raw serialization rather than java serialization.</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/Endpoint.html#routingConsistentFor(rice.p2p.commonapi.Id)">routingConsistentFor</A></B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Can we guarantee that this id is currently ours, and routing will be consistent?
|
||
|
|
Note that this has some real timing implications, so don't cache the returned value.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/CancellableTask.html" title="interface in rice.p2p.commonapi">CancellableTask</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#scheduleMessage(rice.p2p.commonapi.Message, long)">scheduleMessage</A></B>(<A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A> message,
|
||
|
|
long delay)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Schedules a message to be delivered to this application after the provided number of
|
||
|
|
milliseconds.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/CancellableTask.html" title="interface in rice.p2p.commonapi">CancellableTask</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#scheduleMessage(rice.p2p.commonapi.Message, long, long)">scheduleMessage</A></B>(<A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A> message,
|
||
|
|
long delay,
|
||
|
|
long period)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Schedules a message to be delivered to this application every period number of
|
||
|
|
milliseconds, after delay number of miliseconds have passed.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../rice/p2p/commonapi/CancellableTask.html" title="interface in rice.p2p.commonapi">CancellableTask</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../rice/p2p/commonapi/Endpoint.html#scheduleMessageAtFixedRate(rice.p2p.commonapi.Message, long, long)">scheduleMessageAtFixedRate</A></B>(<A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A> message,
|
||
|
|
long delay,
|
||
|
|
long period)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Schedules a message to be delivered to this application every period number of
|
||
|
|
milliseconds, after delay number of miliseconds have passed.</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/Endpoint.html#setConsistentRouting(boolean)">setConsistentRouting</A></B>(boolean val)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
default value is true
|
||
|
|
|
||
|
|
Consistent routing causes RouteMessages to be dropped if we are not sure that we are
|
||
|
|
responsible for our current id range.</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/Endpoint.html#setDeserializer(rice.p2p.commonapi.rawserialization.MessageDeserializer)">setDeserializer</A></B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/MessageDeserializer.html" title="interface in rice.p2p.commonapi.rawserialization">MessageDeserializer</A> md)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
To use a more efficient serialization format than Java Serialization</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/Endpoint.html#setSendOptions(java.util.Map)">setSendOptions</A></B>(java.util.Map<java.lang.String,java.lang.Object> options)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Uses these options as defaults.</TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
<A NAME="methods_inherited_from_class_rice.p2p.commonapi.rawserialization.NodeHandleReader"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||
|
|
<TH ALIGN="left"><B>Methods inherited from interface rice.p2p.commonapi.rawserialization.<A HREF="../../../rice/p2p/commonapi/rawserialization/NodeHandleReader.html" title="interface in rice.p2p.commonapi.rawserialization">NodeHandleReader</A></B></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD><CODE><A HREF="../../../rice/p2p/commonapi/rawserialization/NodeHandleReader.html#coalesce(rice.p2p.commonapi.NodeHandle)">coalesce</A></CODE></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
|
|
||
|
|
<A NAME="method_detail"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
||
|
|
<B>Method Detail</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<A NAME="getId()"><!-- --></A><H3>
|
||
|
|
getId</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>getId</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns this node's id, which is its identifier in the namespace.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>The local node's id</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="route(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.DeliveryNotification, java.util.Map)"><!-- --></A><H3>
|
||
|
|
route</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A> <B>route</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,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi">DeliveryNotification</A> deliverAckToMe,
|
||
|
|
java.util.Map<java.lang.String,java.lang.Object> options)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>This method makes an attempt to route the message to the root of the given id.
|
||
|
|
The hint handle will be the first hop in the route. If the id field is null, then
|
||
|
|
the message is routed directly to the given node, and delivers the message
|
||
|
|
there. If the hint field is null, then this method makes an attempt to route
|
||
|
|
the message to the root of the given id. Note that one of the id and hint fields can
|
||
|
|
be null, but not both.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The destination Id of the message.<DD><CODE>message</CODE> - The message to deliver<DD><CODE>hint</CODE> - The first node to send this message to, optional<DD><CODE>deliverAckToMe</CODE> - notified when the message is sent
|
||
|
|
<DT><B>Returns:</B><DD>can cancel the request</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="route(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.DeliveryNotification)"><!-- --></A><H3>
|
||
|
|
route</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A> <B>route</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,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi">DeliveryNotification</A> deliverAckToMe)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="route(rice.p2p.commonapi.Id, rice.p2p.commonapi.Message, rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3>
|
||
|
|
route</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A> <B>route</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,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="route(rice.p2p.commonapi.Id, rice.p2p.commonapi.rawserialization.RawMessage, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.DeliveryNotification, java.util.Map)"><!-- --></A><H3>
|
||
|
|
route</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A> <B>route</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/rawserialization/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A> message,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi">DeliveryNotification</A> deliverAckToMe,
|
||
|
|
java.util.Map<java.lang.String,java.lang.Object> options)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Same as the other call, but uses the Raw serialization rather than java serialization.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - <DD><CODE>message</CODE> - <DD><CODE>hint</CODE> - </DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="route(rice.p2p.commonapi.Id, rice.p2p.commonapi.rawserialization.RawMessage, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.DeliveryNotification)"><!-- --></A><H3>
|
||
|
|
route</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A> <B>route</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/rawserialization/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A> message,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi">DeliveryNotification</A> deliverAckToMe)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="route(rice.p2p.commonapi.Id, rice.p2p.commonapi.rawserialization.RawMessage, rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3>
|
||
|
|
route</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/MessageReceipt.html" title="interface in rice.p2p.commonapi">MessageReceipt</A> <B>route</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/rawserialization/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A> message,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> hint)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="localLookup(rice.p2p.commonapi.Id, int, boolean)"><!-- --></A><H3>
|
||
|
|
localLookup</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A> <B>localLookup</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
int num,
|
||
|
|
boolean safe)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>This call produces a list of nodes that can be used as next hops on a route towards
|
||
|
|
the given id, such that the resulting route satisfies the overlay protocol's bounds
|
||
|
|
on the number of hops taken. If the safe flag is specified, then the fraction of
|
||
|
|
faulty nodes returned is no higher than the fraction of faulty nodes in the overlay.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The destination id.<DD><CODE>num</CODE> - The number of nodes to return.<DD><CODE>safe</CODE> - Whether or not to return safe nodes.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="neighborSet(int)"><!-- --></A><H3>
|
||
|
|
neighborSet</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A> <B>neighborSet</B>(int num)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>This methods returns an unordered set of nodehandles on which are neighbors of the local
|
||
|
|
node in the id space. Up to num handles are returned.
|
||
|
|
|
||
|
|
NOTE: This is not the same thing as the neighborhood set as described in some early papers.
|
||
|
|
The if you are looking for the neighborhood set, see localLookup()
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>num</CODE> - The number of desired handle to return.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="replicaSet(rice.p2p.commonapi.Id, int)"><!-- --></A><H3>
|
||
|
|
replicaSet</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A> <B>replicaSet</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
int maxRank)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>This method returns an ordered set of nodehandles on which replicas of an object with
|
||
|
|
a given id can be stored. The call returns nodes up to and including a node with maxRank.
|
||
|
|
|
||
|
|
This method is equivalent to calling
|
||
|
|
|
||
|
|
replicaSet(id, maxRank, getLocalNodeHandle(), neighborSet(Integer.MAX_VALUE));
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The object's id.<DD><CODE>maxRank</CODE> - The number of desired replicas.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="replicaSet(rice.p2p.commonapi.Id, int, rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.NodeHandleSet)"><!-- --></A><H3>
|
||
|
|
replicaSet</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A> <B>replicaSet</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id,
|
||
|
|
int maxRank,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> root,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A> set)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>This methods returns an ordered set of nodehandles on which replicas of an object with
|
||
|
|
a given id can be stored. The call returns nodes up to and including a node with maxRank.
|
||
|
|
This call also allows the application to provide a remote "center" node, as well as
|
||
|
|
other nodes in the vicinity.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The object's id.<DD><CODE>maxRank</CODE> - The number of desired replicas.<DD><CODE>handle</CODE> - The root handle of the remove set<DD><CODE>set</CODE> - The set of other nodes around the root handle</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="range(rice.p2p.commonapi.NodeHandle, int, rice.p2p.commonapi.Id)"><!-- --></A><H3>
|
||
|
|
range</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> <B>range</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
||
|
|
int rank,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> lkey)
|
||
|
|
throws <A HREF="../../../rice/p2p/commonapi/RangeCannotBeDeterminedException.html" title="class in rice.p2p.commonapi">RangeCannotBeDeterminedException</A></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>This operation provides information about ranges of keys for which the node is currently
|
||
|
|
a rank-root. The operations throws an exception if the range could not be determined.
|
||
|
|
It is an error to query the range of a node not present in the neighbor set as
|
||
|
|
returned bythe update upcall or the neighborSet call. Certain implementations may return
|
||
|
|
an error if rank is greater than zero. Some protocols may have multiple, disjoint ranges
|
||
|
|
of keys for which a given node is responsible. The parameter lkey allows the caller to
|
||
|
|
specify which region should be returned. If the node referenced by is responsible for key
|
||
|
|
lkey, then the resulting range includes lkey. Otherwise, the result is the nearest range
|
||
|
|
clockwise from lkey for which is responsible.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>handle</CODE> - The handle whose range to check.<DD><CODE>rank</CODE> - The root rank.<DD><CODE>lkey</CODE> - An "index" in case of multiple ranges.
|
||
|
|
<DT><B>Throws:</B>
|
||
|
|
<DD><CODE><A HREF="../../../rice/p2p/commonapi/RangeCannotBeDeterminedException.html" title="class in rice.p2p.commonapi">RangeCannotBeDeterminedException</A></CODE></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="range(rice.p2p.commonapi.NodeHandle, int, rice.p2p.commonapi.Id, boolean)"><!-- --></A><H3>
|
||
|
|
range</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> <B>range</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
||
|
|
int rank,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> lkey,
|
||
|
|
boolean cumulative)
|
||
|
|
throws <A HREF="../../../rice/p2p/commonapi/RangeCannotBeDeterminedException.html" title="class in rice.p2p.commonapi">RangeCannotBeDeterminedException</A></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>This operation provides information about ranges of keys for which the node is currently
|
||
|
|
a rank-root. The operations returns null if the range could not be determined, the range
|
||
|
|
otherwise. It is an error to query the range of a node not present in the neighbor set as
|
||
|
|
returned bythe update upcall or the neighborSet call. Certain implementations may return
|
||
|
|
an error if rank is greater than zero. Some protocols may have multiple, disjoint ranges
|
||
|
|
of keys for which a given node is responsible. The parameter lkey allows the caller to
|
||
|
|
specify which region should be returned. If the node referenced by is responsible for key
|
||
|
|
lkey, then the resulting range includes lkey. Otherwise, the result is the nearest range
|
||
|
|
clockwise from lkey for which is responsible.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>handle</CODE> - The handle whose range to check.<DD><CODE>rank</CODE> - The root rank.<DD><CODE>lkey</CODE> - An "index" in case of multiple ranges.<DD><CODE>cumulative</CODE> - Whether to return the cumulative or single range
|
||
|
|
<DT><B>Throws:</B>
|
||
|
|
<DD><CODE><A HREF="../../../rice/p2p/commonapi/RangeCannotBeDeterminedException.html" title="class in rice.p2p.commonapi">RangeCannotBeDeterminedException</A></CODE></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getLocalNodeHandle()"><!-- --></A><H3>
|
||
|
|
getLocalNodeHandle</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>getLocalNodeHandle</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns a handle to the local node below this endpoint. This node handle is serializable,
|
||
|
|
and can therefore be sent to other nodes in the network and still be valid.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>A NodeHandle referring to the local node.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="scheduleMessage(rice.p2p.commonapi.Message, long)"><!-- --></A><H3>
|
||
|
|
scheduleMessage</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/CancellableTask.html" title="interface in rice.p2p.commonapi">CancellableTask</A> <B>scheduleMessage</B>(<A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A> message,
|
||
|
|
long delay)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Schedules a message to be delivered to this application after the provided number of
|
||
|
|
milliseconds.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message to be delivered<DD><CODE>delay</CODE> - The number of milliseconds to wait before delivering the message</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="scheduleMessage(rice.p2p.commonapi.Message, long, long)"><!-- --></A><H3>
|
||
|
|
scheduleMessage</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/CancellableTask.html" title="interface in rice.p2p.commonapi">CancellableTask</A> <B>scheduleMessage</B>(<A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A> message,
|
||
|
|
long delay,
|
||
|
|
long period)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Schedules a message to be delivered to this application every period number of
|
||
|
|
milliseconds, after delay number of miliseconds have passed.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message to be delivered<DD><CODE>delay</CODE> - The number of milliseconds to wait before delivering the fist message<DD><CODE>delay</CODE> - The number of milliseconds to wait before delivering subsequent messages</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="scheduleMessageAtFixedRate(rice.p2p.commonapi.Message, long, long)"><!-- --></A><H3>
|
||
|
|
scheduleMessageAtFixedRate</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/CancellableTask.html" title="interface in rice.p2p.commonapi">CancellableTask</A> <B>scheduleMessageAtFixedRate</B>(<A HREF="../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A> message,
|
||
|
|
long delay,
|
||
|
|
long period)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Schedules a message to be delivered to this application every period number of
|
||
|
|
milliseconds, after delay number of miliseconds have passed.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message to be delivered<DD><CODE>delay</CODE> - The number of milliseconds to wait before delivering the fist message<DD><CODE>delay</CODE> - The number of milliseconds to wait before delivering subsequent messages</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="process(rice.Executable, rice.Continuation)"><!-- --></A><H3>
|
||
|
|
process</H3>
|
||
|
|
<PRE>
|
||
|
|
void <B>process</B>(<A HREF="../../../rice/Executable.html" title="interface in rice">Executable</A> task,
|
||
|
|
<A HREF="../../../rice/Continuation.html" title="interface in rice">Continuation</A> command)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Schedules a job for processing on the dedicated processing thread. CPU intensive jobs, such
|
||
|
|
as encryption, erasure encoding, or bloom filter creation should never be done in the context
|
||
|
|
of the underlying node's thread, and should only be done via this method.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>task</CODE> - The task to run on the processing thread<DD><CODE>command</CODE> - The command to return the result to once it's done</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getInstance()"><!-- --></A><H3>
|
||
|
|
getInstance</H3>
|
||
|
|
<PRE>
|
||
|
|
java.lang.String <B>getInstance</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns a unique instance name of this endpoint, sort of a mailbox name for this
|
||
|
|
application.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>The unique instance name of this application</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getEnvironment()"><!-- --></A><H3>
|
||
|
|
getEnvironment</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/environment/Environment.html" title="class in rice.environment">Environment</A> <B>getEnvironment</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the environment. This allows the nodes to be virtualized within the JVM
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>the environment for this node/app.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="accept(rice.p2p.commonapi.appsocket.AppSocketReceiver)"><!-- --></A><H3>
|
||
|
|
accept</H3>
|
||
|
|
<PRE>
|
||
|
|
void <B>accept</B>(<A HREF="../../../rice/p2p/commonapi/appsocket/AppSocketReceiver.html" title="interface in rice.p2p.commonapi.appsocket">AppSocketReceiver</A> receiver)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Set's the acceptor for this application. If no acceptor is set, then when a remote
|
||
|
|
node's application opens a socket here, they will get an *Exception*
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>receiver</CODE> - calls receiveSocket() when a new AppSocket is opened to this application
|
||
|
|
from a remote node.
|
||
|
|
Note that you must call accept() again after each socket is received to properly handle
|
||
|
|
socket backlogging</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="connect(rice.p2p.commonapi.NodeHandle, rice.p2p.commonapi.appsocket.AppSocketReceiver, int)"><!-- --></A><H3>
|
||
|
|
connect</H3>
|
||
|
|
<PRE>
|
||
|
|
void <B>connect</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> handle,
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/appsocket/AppSocketReceiver.html" title="interface in rice.p2p.commonapi.appsocket">AppSocketReceiver</A> receiver,
|
||
|
|
int timeout)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Opens a connection to this application on a remote node.
|
||
|
|
If no acceptor is set, then receiver will get an *Exception*
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>receiver</CODE> - calls receiveSocket() when a new AppSocket is opened to this application
|
||
|
|
on a remote node.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setDeserializer(rice.p2p.commonapi.rawserialization.MessageDeserializer)"><!-- --></A><H3>
|
||
|
|
setDeserializer</H3>
|
||
|
|
<PRE>
|
||
|
|
void <B>setDeserializer</B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/MessageDeserializer.html" title="interface in rice.p2p.commonapi.rawserialization">MessageDeserializer</A> md)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>To use a more efficient serialization format than Java Serialization
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>md</CODE> - </DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getDeserializer()"><!-- --></A><H3>
|
||
|
|
getDeserializer</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/rawserialization/MessageDeserializer.html" title="interface in rice.p2p.commonapi.rawserialization">MessageDeserializer</A> <B>getDeserializer</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the deserializer. The default deserializer can deserialize rice.p2p.util.JavaSerializedMessage
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setConsistentRouting(boolean)"><!-- --></A><H3>
|
||
|
|
setConsistentRouting</H3>
|
||
|
|
<PRE>
|
||
|
|
void <B>setConsistentRouting</B>(boolean val)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>default value is true
|
||
|
|
|
||
|
|
Consistent routing causes RouteMessages to be dropped if we are not sure that we are
|
||
|
|
responsible for our current id range. If you set this to false, you will be delivered
|
||
|
|
messages to forward() and deliver() even if there is possible inconsistent routing.
|
||
|
|
|
||
|
|
(The overlay still does it's best to deliver the RouteMessage to the proper key,
|
||
|
|
but some protocols can guarantee consistency, for example by using leases between
|
||
|
|
nodes)
|
||
|
|
|
||
|
|
Note that when true, the overlay never purposely drops messages routed with a null
|
||
|
|
key:
|
||
|
|
endpoint.deliver(null, msg, targetNodeHandle) // will be delivered regardless of consistency
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>val</CODE> - </DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="routingConsistentFor(rice.p2p.commonapi.Id)"><!-- --></A><H3>
|
||
|
|
routingConsistentFor</H3>
|
||
|
|
<PRE>
|
||
|
|
boolean <B>routingConsistentFor</B>(<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> id)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Can we guarantee that this id is currently ours, and routing will be consistent?
|
||
|
|
Note that this has some real timing implications, so don't cache the returned value.
|
||
|
|
Note that it will always return always returns false if you are not the root of the id.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>the</CODE> - id to verify
|
||
|
|
<DT><B>Returns:</B><DD>true if routing consistency can currently be guaranteed for this</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="readId(rice.p2p.commonapi.rawserialization.InputBuffer, short)"><!-- --></A><H3>
|
||
|
|
readId</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.html" title="interface in rice.p2p.commonapi">Id</A> <B>readId</B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf,
|
||
|
|
short type)
|
||
|
|
throws java.io.IOException</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>To use a more efficient serialization format than Java Serialization
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>md</CODE> -
|
||
|
|
<DT><B>Throws:</B>
|
||
|
|
<DD><CODE>java.io.IOException</CODE></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="networkNeighbors(int)"><!-- --></A><H3>
|
||
|
|
networkNeighbors</H3>
|
||
|
|
<PRE>
|
||
|
|
java.util.List<<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A>> <B>networkNeighbors</B>(int num)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns an ordered list of the nearest known neighbors.
|
||
|
|
Note that proximity is usually an estimate, and can quickly become stale.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>num</CODE> -
|
||
|
|
<DT><B>Returns:</B><DD>List of NodeHandle</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="readIdRange(rice.p2p.commonapi.rawserialization.InputBuffer)"><!-- --></A><H3>
|
||
|
|
readIdRange</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/IdRange.html" title="interface in rice.p2p.commonapi">IdRange</A> <B>readIdRange</B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf)
|
||
|
|
throws java.io.IOException</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>To use Raw Serialization
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>buf</CODE> -
|
||
|
|
<DT><B>Returns:</B><DD>
|
||
|
|
<DT><B>Throws:</B>
|
||
|
|
<DD><CODE>java.io.IOException</CODE></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="readNodeHandleSet(rice.p2p.commonapi.rawserialization.InputBuffer, short)"><!-- --></A><H3>
|
||
|
|
readNodeHandleSet</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandleSet.html" title="interface in rice.p2p.commonapi">NodeHandleSet</A> <B>readNodeHandleSet</B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf,
|
||
|
|
short type)
|
||
|
|
throws java.io.IOException</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Throws:</B>
|
||
|
|
<DD><CODE>java.io.IOException</CODE></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="readNodeHandle(rice.p2p.commonapi.rawserialization.InputBuffer)"><!-- --></A><H3>
|
||
|
|
readNodeHandle</H3>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>readNodeHandle</B>(<A HREF="../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf)
|
||
|
|
throws java.io.IOException</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><B>Description copied from interface: <CODE><A HREF="../../../rice/p2p/commonapi/rawserialization/NodeHandleReader.html#readNodeHandle(rice.p2p.commonapi.rawserialization.InputBuffer)">NodeHandleReader</A></CODE></B></DD>
|
||
|
|
<DD>To use Raw Serialization
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../rice/p2p/commonapi/rawserialization/NodeHandleReader.html#readNodeHandle(rice.p2p.commonapi.rawserialization.InputBuffer)">readNodeHandle</A></CODE> in interface <CODE><A HREF="../../../rice/p2p/commonapi/rawserialization/NodeHandleReader.html" title="interface in rice.p2p.commonapi.rawserialization">NodeHandleReader</A></CODE></DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>
|
||
|
|
<DT><B>Throws:</B>
|
||
|
|
<DD><CODE>java.io.IOException</CODE></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="register()"><!-- --></A><H3>
|
||
|
|
register</H3>
|
||
|
|
<PRE>
|
||
|
|
void <B>register</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Call this after you have set up your Endpoint:
|
||
|
|
called setDeserializer(), called accept().
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="proximity(rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3>
|
||
|
|
proximity</H3>
|
||
|
|
<PRE>
|
||
|
|
int <B>proximity</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> nh)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>This replaces NodeHandle.proximity(), so that you don't have to have a "coalesced" NodeHandle.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>nh</CODE> -
|
||
|
|
<DT><B>Returns:</B><DD></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isAlive(rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3>
|
||
|
|
isAlive</H3>
|
||
|
|
<PRE>
|
||
|
|
boolean <B>isAlive</B>(<A HREF="../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> nh)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setSendOptions(java.util.Map)"><!-- --></A><H3>
|
||
|
|
setSendOptions</H3>
|
||
|
|
<PRE>
|
||
|
|
void <B>setSendOptions</B>(java.util.Map<java.lang.String,java.lang.Object> options)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Uses these options as defaults.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>options</CODE> - </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/Endpoint.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/commonapi/DeliveryNotification.html" title="interface in rice.p2p.commonapi"><B>PREV CLASS</B></A>
|
||
|
|
<A HREF="../../../rice/p2p/commonapi/Id.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/Endpoint.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="Endpoint.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>
|