relaytransport.html

jxta的api库

<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../net/jxta/service/Service.html" title="interface in net.jxta.service">Service</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#getInterface()">getInterface</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Service objects are not manipulated directly to protect usage
 of the service. A Service interface is returned to access the service
 methods.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static&nbsp;<A HREF="../../../../../net/jxta/protocol/RouteAdvertisement.html" title="class in net.jxta.protocol">RouteAdvertisement</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#getRouteAdvertisement(net.jxta.protocol.PeerAdvertisement)">getRouteAdvertisement</A></B>(<A HREF="../../../../../net/jxta/protocol/PeerAdvertisement.html" title="class in net.jxta.protocol">PeerAdvertisement</A>&nbsp;peerAdv)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convinence function for getting the RouteAdvertisement from a PeerAdvertisement</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#getServiceName()">getServiceName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#getString(net.jxta.endpoint.Message, java.lang.String)">getString</A></B>(<A HREF="../../../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;message,
          java.lang.String&nbsp;tag)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convinence function for getting a String from the element with the given
  tag and relay namespace</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#init(net.jxta.peergroup.PeerGroup, net.jxta.id.ID, net.jxta.document.Advertisement)">init</A></B>(<A HREF="../../../../../net/jxta/peergroup/PeerGroup.html" title="interface in net.jxta.peergroup">PeerGroup</A>&nbsp;group,
     <A HREF="../../../../../net/jxta/id/ID.html" title="class in net.jxta.id">ID</A>&nbsp;assignedID,
     <A HREF="../../../../../net/jxta/document/Advertisement.html" title="class in net.jxta.document">Advertisement</A>&nbsp;implAdv)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the module, passing it its peer group and advertisement.
 
 <p/>Note: when subclassing one of the existing PeerGroup implementations
 (which implement Module), it may not be recommended to overload the init
 method. See the documentation of the PeerGroup class being subclassed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#processIncomingMessage(net.jxta.endpoint.Message, net.jxta.endpoint.EndpointAddress, net.jxta.endpoint.EndpointAddress)">processIncomingMessage</A></B>(<A HREF="../../../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;message,
                       <A HREF="../../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A>&nbsp;srcAddr,
                       <A HREF="../../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A>&nbsp;dstAddr)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is invoked by the EndpointService for each incoming message
 which is addressed to this listener.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#setString(net.jxta.endpoint.Message, java.lang.String, java.lang.String)">setString</A></B>(<A HREF="../../../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;message,
          java.lang.String&nbsp;tag,
          java.lang.String&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convinence function for setting a string element with the relay namespace</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#startApp(java.lang.String[])">startApp</A></B>(java.lang.String[]&nbsp;args)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Some Modules will wait for this method being invoked, before
 completing their initializatino to the point that they are fully
 functional. That is also the opportunity to supply arbitrary arguments
 (mostly to applications).
 
 <p/>If this module is a <A HREF="../../../../../net/jxta/peergroup/PeerGroup.html" title="interface in net.jxta.peergroup"><CODE>PeerGroup</CODE></A> service, it may be invoked
 several times depending on its return value.
 
 <p/>Note: the name of this method is historical and no-longer adequate.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/jxta/impl/endpoint/relay/RelayTransport.html#stopApp()">stopApp</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;One can ask a Module to stop.
  The Module cannot be forced to comply, but in the future
  we might be able to deny it access to anything after some timeout.

  <p/>Note: the name of this method is no-longer adequate.</TD>
</TR>
</TABLE>
&nbsp;<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">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="protocolName"><!-- --></A><H3>
protocolName</H3>
<PRE>
protected static final java.lang.String <B>protocolName</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.protocolName">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RELAY_NS"><!-- --></A><H3>
RELAY_NS</H3>
<PRE>
protected static final java.lang.String <B>RELAY_NS</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.RELAY_NS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="REQUEST_ELEMENT"><!-- --></A><H3>
REQUEST_ELEMENT</H3>
<PRE>
protected static final java.lang.String <B>REQUEST_ELEMENT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.REQUEST_ELEMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RESPONSE_ELEMENT"><!-- --></A><H3>
RESPONSE_ELEMENT</H3>
<PRE>
protected static final java.lang.String <B>RESPONSE_ELEMENT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.RESPONSE_ELEMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="PEERID_ELEMENT"><!-- --></A><H3>
PEERID_ELEMENT</H3>
<PRE>
protected static final java.lang.String <B>PEERID_ELEMENT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.PEERID_ELEMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="LEASE_ELEMENT"><!-- --></A><H3>
LEASE_ELEMENT</H3>
<PRE>
protected static final java.lang.String <B>LEASE_ELEMENT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.LEASE_ELEMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RELAY_ADV_ELEMENT"><!-- --></A><H3>
RELAY_ADV_ELEMENT</H3>
<PRE>
protected static final java.lang.String <B>RELAY_ADV_ELEMENT</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.RELAY_ADV_ELEMENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="CONNECT_REQUEST"><!-- --></A><H3>
CONNECT_REQUEST</H3>
<PRE>
protected static final java.lang.String <B>CONNECT_REQUEST</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.CONNECT_REQUEST">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DISCONNECT_REQUEST"><!-- --></A><H3>
DISCONNECT_REQUEST</H3>
<PRE>
protected static final java.lang.String <B>DISCONNECT_REQUEST</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.DISCONNECT_REQUEST">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="PID_REQUEST"><!-- --></A><H3>
PID_REQUEST</H3>
<PRE>
protected static final java.lang.String <B>PID_REQUEST</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.PID_REQUEST">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="CONNECTED_RESPONSE"><!-- --></A><H3>
CONNECTED_RESPONSE</H3>
<PRE>
protected static final java.lang.String <B>CONNECTED_RESPONSE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.CONNECTED_RESPONSE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DISCONNECTED_RESPONSE"><!-- --></A><H3>
DISCONNECTED_RESPONSE</H3>
<PRE>
protected static final java.lang.String <B>DISCONNECTED_RESPONSE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.DISCONNECTED_RESPONSE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="PID_RESPONSE"><!-- --></A><H3>
PID_RESPONSE</H3>
<PRE>
protected static final java.lang.String <B>PID_RESPONSE</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.relay.RelayTransport.PID_RESPONSE">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="RelayTransport()"><!-- --></A><H3>
RelayTransport</H3>
<PRE>
public <B>RelayTransport</B>()</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getInterface()"><!-- --></A><H3>
getInterface</H3>
<PRE>
public <A HREF="../../../../../net/jxta/service/Service.html" title="interface in net.jxta.service">Service</A> <B>getInterface</B>()</PRE>
<DL>
<DD>Service objects are not manipulated directly to protect usage
 of the service. A Service interface is returned to access the service
 methods.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/service/Service.html#getInterface()">getInterface</A></CODE> in interface <CODE><A HREF="../../../../../net/jxta/service/Service.html" title="interface in net.jxta.service">Service</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Service public interface of the service</DL>
</DD>
</DL>
<HR>

<A NAME="getImplAdvertisement()"><!-- --></A><H3>
getImplAdvertisement</H3>
<PRE>
public <A HREF="../../../../../net/jxta/document/Advertisement.html" title="class in net.jxta.document">Advertisement</A> <B>getImplAdvertisement</B>()</PRE>
<DL>
<DD>Returns the advertisment for this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/service/Service.html#getImplAdvertisement()">getImplAdvertisement</A></CODE> in interface <CODE><A HREF="../../../../../net/jxta/service/Service.html" title="interface in net.jxta.service">Service</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Advertisement the advertisement.</DL>
</DD>
</DL>
<HR>

<A NAME="init(net.jxta.peergroup.PeerGroup, net.jxta.id.ID, net.jxta.document.Advertisement)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(<A HREF="../../../../../net/jxta/peergroup/PeerGroup.html" title="interface in net.jxta.peergroup">PeerGroup</A>&nbsp;group,
                 <A HREF="../../../../../net/jxta/id/ID.html" title="class in net.jxta.id">ID</A>&nbsp;assignedID,
                 <A HREF="../../../../../net/jxta/document/Advertisement.html" title="class in net.jxta.document">Advertisement</A>&nbsp;implAdv)
          throws <A HREF="../../../../../net/jxta/exception/PeerGroupException.html" title="class in net.jxta.exception">PeerGroupException</A></PRE>
<DL>
<DD>Initialize the module, passing it its peer group and advertisement.
 
 <p/>Note: when subclassing one of the existing PeerGroup implementations
 (which implement Module), it may not be recommended to overload the init
 method. See the documentation of the PeerGroup class being subclassed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/platform/Module.html#init(net.jxta.peergroup.PeerGroup, net.jxta.id.ID, net.jxta.document.Advertisement)">init</A></CODE> in interface <CODE><A HREF="../../../../../net/jxta/platform/Module.html" title="interface in net.jxta.platform">Module</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - The PeerGroup from which this Module can obtain services.
  If this module is a service, this is also the PeerGroup of which this