cbjxtransport.html

jxta的api库

</DL>
<HR>

<A NAME="cbjxServiceName"><!-- --></A><H3>
cbjxServiceName</H3>
<PRE>
static final java.lang.String <B>cbjxServiceName</B></PRE>
<DL>
<DD>the cbjx service name
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.jxta.impl.endpoint.cbjx.CbJxTransport.cbjxServiceName">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="localPeerID"><!-- --></A><H3>
localPeerID</H3>
<PRE>
static <A HREF="../../../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer">PeerID</A> <B>localPeerID</B></PRE>
<DL>
<DD>the local peer ID
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="localPeerAddr"><!-- --></A><H3>
localPeerAddr</H3>
<PRE>
static <A HREF="../../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A> <B>localPeerAddr</B></PRE>
<DL>
<DD>the endpoint address of this peer
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="group"><!-- --></A><H3>
group</H3>
<PRE>
<A HREF="../../../../../net/jxta/peergroup/PeerGroup.html" title="interface in net.jxta.peergroup">PeerGroup</A> <B>group</B></PRE>
<DL>
<DD>the peer group to which this module belongs
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="endpoint"><!-- --></A><H3>
endpoint</H3>
<PRE>
<A HREF="../../../../../net/jxta/endpoint/EndpointService.html" title="interface in net.jxta.endpoint">EndpointService</A> <B>endpoint</B></PRE>
<DL>
<DD>the endpoint service in my group
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="membership"><!-- --></A><H3>
membership</H3>
<PRE>
<A HREF="../../../../../net/jxta/impl/membership/pse/PSEMembershipService.html" title="class in net.jxta.impl.membership.pse">PSEMembershipService</A> <B>membership</B></PRE>
<DL>
<DD>the membership service in my group
<P>
<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">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="CbJxTransport()"><!-- --></A><H3>
CbJxTransport</H3>
<PRE>
public <B>CbJxTransport</B>()</PRE>
<DL>
<DD>Default constructor
<P>
</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="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;impl)
          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
  module is a service.<DD><CODE>assignedID</CODE> - Identity of Module within group.
  modules can use it as a the root of their namespace to create
  names that are unique within the group but predictible by the
  same module on another peer. This is normaly the ModuleClassID
  which is also the name under which the module is known by other
  modules. For a group it is the PeerGroupID itself.
  The parameters of a service, in the Peer configuration, are indexed
  by the assignedID of that service, and a Service must publish its
  run-time parameters in the Peer Advertisement under its assigned ID.<DD><CODE>impl</CODE> - The implementation advertisement for this
  Module. It is permissible to pass null if no implementation
  advertisement is available. This may happen if the
  implementation was selected by explicit class name rather than
  by following an implementation advertisement. Modules are not
  required to support that style of loading, but if they do, then
  their documentation should mention it.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/jxta/exception/PeerGroupException.html" title="class in net.jxta.exception">PeerGroupException</A></CODE> - This module failed to initialize.</DL>
</DD>
</DL>
<HR>

<A NAME="startApp(java.lang.String[])"><!-- --></A><H3>
startApp</H3>
<PRE>
public int <B>startApp</B>(java.lang.String[]&nbsp;arg)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/platform/Module.html#startApp(java.lang.String[])">startApp</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>arg</CODE> - An array of Strings forming the parameters for this
 Module.
<DT><B>Returns:</B><DD>int A status indication which may be one of 
 <A HREF="../../../../../net/jxta/platform/Module.html#START_OK"><CODE>Module.START_OK</CODE></A>, <A HREF="../../../../../net/jxta/platform/Module.html#START_AGAIN_PROGRESS"><CODE>Module.START_AGAIN_PROGRESS</CODE></A>,
 <A HREF="../../../../../net/jxta/platform/Module.html#START_AGAIN_STALLED"><CODE>Module.START_AGAIN_STALLED</CODE></A>, which indicates partial or complete
 success, or any other value (negative values are
 recommended for future compatibility), which indicates failure.</DL>
</DD>
</DL>
<HR>

<A NAME="stopApp()"><!-- --></A><H3>
stopApp</H3>
<PRE>
public void <B>stopApp</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/platform/Module.html#stopApp()">stopApp</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>
</DL>
</DD>
</DL>
<HR>

<A NAME="getPublicAddress()"><!-- --></A><H3>
getPublicAddress</H3>
<PRE>
public <A HREF="../../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint">EndpointAddress</A> <B>getPublicAddress</B>()</PRE>
<DL>
<DD>Returns the <A HREF="../../../../../net/jxta/endpoint/EndpointAddress.html" title="class in net.jxta.endpoint"><CODE>EndpointAddress</CODE></A> which will be used as the source
  address for all messages sent by this message sender. This is the
  "prefered" address to which replies may be sent. This address is not
  necessarily the best or only address by which the peer may be reached.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/endpoint/MessageSender.html#getPublicAddress()">getPublicAddress</A></CODE> in interface <CODE><A HREF="../../../../../net/jxta/endpoint/MessageSender.html" title="interface in net.jxta.endpoint">MessageSender</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an EndpointAddress containing the public address for this
 message receiver.</DL>
</DD>
</DL>
<HR>

<A NAME="isConnectionOriented()"><!-- --></A><H3>
isConnectionOriented</H3>
<PRE>
public boolean <B>isConnectionOriented</B>()</PRE>
<DL>
<DD>Returns true if the endpoint protocol can establish
 connection to the remote host (like TCP).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/endpoint/MessageSender.html#isConnectionOriented()">isConnectionOriented</A></CODE> in interface <CODE><A HREF="../../../../../net/jxta/endpoint/MessageSender.html" title="interface in net.jxta.endpoint">MessageSender</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>boolean true if the protocol is connection oriented.</DL>
</DD>
</DL>
<HR>

<A NAME="allowsRouting()"><!-- --></A><H3>
allowsRouting</H3>
<PRE>
public boolean <B>allowsRouting</B>()</PRE>
<DL>
<DD>Returns true if the endpoint protocol can be used by the EndpointRouter.

 <p/>More specifically, this protocol will be used to route messages who's
 final destination is <b>not</b> one of the endpoint addresses available
 from getReachableEndpointAddresses.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/endpoint/MessageSender.html#allowsRouting()">allowsRouting</A></CODE> in interface <CODE><A HREF="../../../../../net/jxta/endpoint/MessageSender.html" title="interface in net.jxta.endpoint">MessageSender</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>boolean true if the protocol can be used by the EndpointRouter</DL>
</DD>
</DL>
<HR>

<A NAME="getEndpointService()"><!-- --></A><H3>
getEndpointService</H3>
<PRE>
public <A HREF="../../../../../net/jxta/endpoint/EndpointService.html" title="interface in net.jxta.endpoint">EndpointService</A> <B>getEndpointService</B>()</PRE>
<DL>
<DD>Returns the endpoint service with which this MessageTransport is
  registered. If it is unregistered then null will be returned.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/jxta/endpoint/MessageTransport.html#getEndpointService()">getEndpointService</A></CODE> in interface <CODE><A HREF="../../../../../net/jxta/endpoint/MessageTransport.html" title="interface in net.jxta.endpoint">MessageTransport</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the EndpointService with which this MessageTransport is
  registered.</DL>