mirror of
https://github.com/ChronosX88/FreePastry.git
synced 2025-01-16 09:36:27 +00:00
483 lines
22 KiB
HTML
483 lines
22 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>
|
||
|
|
ScribeMessage (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="ScribeMessage (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/ScribeMessage.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
</TD>
|
||
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||
|
|
Rice Pastry API</EM>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../rice/p2p/scribe/messaging/PublishRequestMessage.html" title="class in rice.p2p.scribe.messaging"><B>PREV CLASS</B></A>
|
||
|
|
<A HREF="../../../../rice/p2p/scribe/messaging/SubscribeAckMessage.html" title="class in rice.p2p.scribe.messaging"><B>NEXT CLASS</B></A></FONT></TD>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../index.html?rice/p2p/scribe/messaging/ScribeMessage.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="ScribeMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||
|
|
<SCRIPT type="text/javascript">
|
||
|
|
<!--
|
||
|
|
if(window==top) {
|
||
|
|
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
</SCRIPT>
|
||
|
|
<NOSCRIPT>
|
||
|
|
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||
|
|
</NOSCRIPT>
|
||
|
|
|
||
|
|
|
||
|
|
</FONT></TD>
|
||
|
|
</TR>
|
||
|
|
<TR>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
<A NAME="skip-navbar_top"></A>
|
||
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
|
<H2>
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
rice.p2p.scribe.messaging</FONT>
|
||
|
|
<BR>
|
||
|
|
Class ScribeMessage</H2>
|
||
|
|
<PRE>
|
||
|
|
java.lang.Object
|
||
|
|
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>rice.p2p.scribe.messaging.ScribeMessage</B>
|
||
|
|
</PRE>
|
||
|
|
<DL>
|
||
|
|
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A>, <A HREF="../../../../rice/p2p/commonapi/rawserialization/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A>, <A HREF="../../../../rice/p2p/commonapi/rawserialization/RawSerializable.html" title="interface in rice.p2p.commonapi.rawserialization">RawSerializable</A></DD>
|
||
|
|
</DL>
|
||
|
|
<DL>
|
||
|
|
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../rice/p2p/scribe/messaging/AnycastFailureMessage.html" title="class in rice.p2p.scribe.messaging">AnycastFailureMessage</A>, <A HREF="../../../../rice/p2p/scribe/messaging/AnycastMessage.html" title="class in rice.p2p.scribe.messaging">AnycastMessage</A>, <A HREF="../../../../rice/p2p/scribe/messaging/DropMessage.html" title="class in rice.p2p.scribe.messaging">DropMessage</A>, <A HREF="../../../../rice/p2p/scribe/messaging/PublishMessage.html" title="class in rice.p2p.scribe.messaging">PublishMessage</A>, <A HREF="../../../../rice/p2p/scribe/messaging/PublishRequestMessage.html" title="class in rice.p2p.scribe.messaging">PublishRequestMessage</A></DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
<DL>
|
||
|
|
<DT><PRE>public abstract class <B>ScribeMessage</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../rice/p2p/commonapi/rawserialization/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A></DL>
|
||
|
|
</PRE>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>Version:</B></DT>
|
||
|
|
<DD>$Id: ScribeMessage.java 3613 2007-02-15 14:45:14Z jstewart $</DD>
|
||
|
|
<DT><B>Author:</B></DT>
|
||
|
|
<DD>Alan Mislove</DD>
|
||
|
|
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#rice.p2p.scribe.messaging.ScribeMessage">Serialized Form</A></DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
|
|
||
|
|
<A NAME="field_summary"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||
|
|
<B>Field Summary</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>protected <A HREF="../../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#source">source</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/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#topic">topic</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
<A NAME="fields_inherited_from_class_rice.p2p.commonapi.Message"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||
|
|
<TH ALIGN="left"><B>Fields inherited from interface rice.p2p.commonapi.<A HREF="../../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A></B></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD><CODE><A HREF="../../../../rice/p2p/commonapi/Message.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</A>, <A HREF="../../../../rice/p2p/commonapi/Message.html#HIGH_PRIORITY">HIGH_PRIORITY</A>, <A HREF="../../../../rice/p2p/commonapi/Message.html#LOW_PRIORITY">LOW_PRIORITY</A>, <A HREF="../../../../rice/p2p/commonapi/Message.html#LOWEST_PRIORITY">LOWEST_PRIORITY</A>, <A HREF="../../../../rice/p2p/commonapi/Message.html#MAX_PRIORITY">MAX_PRIORITY</A>, <A HREF="../../../../rice/p2p/commonapi/Message.html#MEDIUM_HIGH_PRIORITY">MEDIUM_HIGH_PRIORITY</A>, <A HREF="../../../../rice/p2p/commonapi/Message.html#MEDIUM_LOW_PRIORITY">MEDIUM_LOW_PRIORITY</A>, <A HREF="../../../../rice/p2p/commonapi/Message.html#MEDIUM_PRIORITY">MEDIUM_PRIORITY</A></CODE></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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>protected </CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#ScribeMessage(rice.p2p.commonapi.rawserialization.InputBuffer, rice.p2p.commonapi.Endpoint)">ScribeMessage</A></B>(<A HREF="../../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf,
|
||
|
|
<A HREF="../../../../rice/p2p/commonapi/Endpoint.html" title="interface in rice.p2p.commonapi">Endpoint</A> endpoint)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Protected because it should only be called from an extending class, to get version
|
||
|
|
numbers correct.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>protected </CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#ScribeMessage(rice.p2p.commonapi.NodeHandle, rice.p2p.scribe.Topic)">ScribeMessage</A></B>(<A HREF="../../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> source,
|
||
|
|
<A HREF="../../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Constructor which takes a unique integer Id</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> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#getPriority()">getPriority</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Method which should return the priority level of this message.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#getSource()">getSource</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Method which returns this messages' source address</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#getTopic()">getTopic</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Method which returns this messages' topic</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> void</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#serialize(rice.p2p.commonapi.rawserialization.OutputBuffer)">serialize</A></B>(<A HREF="../../../../rice/p2p/commonapi/rawserialization/OutputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">OutputBuffer</A> buf)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> void</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../rice/p2p/scribe/messaging/ScribeMessage.html#setSource(rice.p2p.commonapi.NodeHandle)">setSource</A></B>(<A HREF="../../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> source)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Method which set this messages' source address</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>
|
||
|
|
<A NAME="methods_inherited_from_class_rice.p2p.commonapi.rawserialization.RawMessage"><!-- --></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/RawMessage.html" title="interface in rice.p2p.commonapi.rawserialization">RawMessage</A></B></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD><CODE><A HREF="../../../../rice/p2p/commonapi/rawserialization/RawMessage.html#getType()">getType</A></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="source"><!-- --></A><H3>
|
||
|
|
source</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <A HREF="../../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>source</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="topic"><!-- --></A><H3>
|
||
|
|
topic</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <A HREF="../../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> <B>topic</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<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="ScribeMessage(rice.p2p.commonapi.NodeHandle, rice.p2p.scribe.Topic)"><!-- --></A><H3>
|
||
|
|
ScribeMessage</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <B>ScribeMessage</B>(<A HREF="../../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> source,
|
||
|
|
<A HREF="../../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> topic)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Constructor which takes a unique integer Id
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The source address<DD><CODE>topic</CODE> - The topic</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="ScribeMessage(rice.p2p.commonapi.rawserialization.InputBuffer, rice.p2p.commonapi.Endpoint)"><!-- --></A><H3>
|
||
|
|
ScribeMessage</H3>
|
||
|
|
<PRE>
|
||
|
|
protected <B>ScribeMessage</B>(<A HREF="../../../../rice/p2p/commonapi/rawserialization/InputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">InputBuffer</A> buf,
|
||
|
|
<A HREF="../../../../rice/p2p/commonapi/Endpoint.html" title="interface in rice.p2p.commonapi">Endpoint</A> endpoint)
|
||
|
|
throws java.io.IOException</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Protected because it should only be called from an extending class, to get version
|
||
|
|
numbers correct.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
|
||
|
|
<DT><B>Throws:</B>
|
||
|
|
<DD><CODE>java.io.IOException</CODE></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="getPriority()"><!-- --></A><H3>
|
||
|
|
getPriority</H3>
|
||
|
|
<PRE>
|
||
|
|
public int <B>getPriority</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Method which should return the priority level of this message. The messages
|
||
|
|
can range in priority from 0 (highest priority) to Integer.MAX_VALUE (lowest) -
|
||
|
|
when sending messages across the wire, the queue is sorted by message priority.
|
||
|
|
If the queue reaches its limit, the lowest priority messages are discarded. Thus,
|
||
|
|
applications which are very verbose should have LOW_PRIORITY or lower, and
|
||
|
|
applications which are somewhat quiet are allowed to have MEDIUM_PRIORITY or
|
||
|
|
possibly even HIGH_PRIORITY.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/Message.html#getPriority()">getPriority</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/Message.html" title="interface in rice.p2p.commonapi">Message</A></CODE></DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>This message's priority</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getSource()"><!-- --></A><H3>
|
||
|
|
getSource</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> <B>getSource</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Method which returns this messages' source address
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>The source of this message</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setSource(rice.p2p.commonapi.NodeHandle)"><!-- --></A><H3>
|
||
|
|
setSource</H3>
|
||
|
|
<PRE>
|
||
|
|
public void <B>setSource</B>(<A HREF="../../../../rice/p2p/commonapi/NodeHandle.html" title="class in rice.p2p.commonapi">NodeHandle</A> source)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Method which set this messages' source address
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The source of this message</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getTopic()"><!-- --></A><H3>
|
||
|
|
getTopic</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../rice/p2p/scribe/Topic.html" title="class in rice.p2p.scribe">Topic</A> <B>getTopic</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Method which returns this messages' topic
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>The topic of this message</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="serialize(rice.p2p.commonapi.rawserialization.OutputBuffer)"><!-- --></A><H3>
|
||
|
|
serialize</H3>
|
||
|
|
<PRE>
|
||
|
|
public void <B>serialize</B>(<A HREF="../../../../rice/p2p/commonapi/rawserialization/OutputBuffer.html" title="interface in rice.p2p.commonapi.rawserialization">OutputBuffer</A> buf)
|
||
|
|
throws java.io.IOException</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../rice/p2p/commonapi/rawserialization/RawSerializable.html#serialize(rice.p2p.commonapi.rawserialization.OutputBuffer)">serialize</A></CODE> in interface <CODE><A HREF="../../../../rice/p2p/commonapi/rawserialization/RawSerializable.html" title="interface in rice.p2p.commonapi.rawserialization">RawSerializable</A></CODE></DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Throws:</B>
|
||
|
|
<DD><CODE>java.io.IOException</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/ScribeMessage.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
</TD>
|
||
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||
|
|
Rice Pastry API</EM>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../rice/p2p/scribe/messaging/PublishRequestMessage.html" title="class in rice.p2p.scribe.messaging"><B>PREV CLASS</B></A>
|
||
|
|
<A HREF="../../../../rice/p2p/scribe/messaging/SubscribeAckMessage.html" title="class in rice.p2p.scribe.messaging"><B>NEXT CLASS</B></A></FONT></TD>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../index.html?rice/p2p/scribe/messaging/ScribeMessage.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="ScribeMessage.html" target="_top"><B>NO FRAMES</B></A>
|
||
|
|
<SCRIPT type="text/javascript">
|
||
|
|
<!--
|
||
|
|
if(window==top) {
|
||
|
|
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
</SCRIPT>
|
||
|
|
<NOSCRIPT>
|
||
|
|
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||
|
|
</NOSCRIPT>
|
||
|
|
|
||
|
|
|
||
|
|
</FONT></TD>
|
||
|
|
</TR>
|
||
|
|
<TR>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
<A NAME="skip-navbar_bottom"></A>
|
||
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
<i>Copyright © 2001-2005 - Rice Pastry.</i>
|
||
|
|
</BODY>
|
||
|
|
</HTML>
|