pipeserviceimpl.html

jxta的api库

<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;pg,
                 <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)</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>pg</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.</DL>
</DD>
</DL>
<HR>

<A NAME="startApp(java.lang.String[])"><!-- --></A><H3>
startApp</H3>
<PRE>
public int <B>startApp</B>(java.lang.String[]&nbsp;args)</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/>Currently this service does not expect arguments.
<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>args</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="createInputPipe(net.jxta.protocol.PipeAdvertisement)"><!-- --></A><H3>
createInputPipe</H3>
<PRE>
public <A HREF="../../../../net/jxta/pipe/InputPipe.html" title="interface in net.jxta.pipe">InputPipe</A> <B>createInputPipe</B>(<A HREF="../../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;adv)
                          throws java.io.IOException</PRE>
<DL>
<DD>Create an InputPipe from a pipe Advertisement
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/pipe/PipeService.html#createInputPipe(net.jxta.protocol.PipeAdvertisement)">createInputPipe</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/pipe/PipeService.html" title="interface in net.jxta.pipe">PipeService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>adv</CODE> - is the advertisement of the PipeService.
<DT><B>Returns:</B><DD>InputPipe InputPipe object created
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - error creating input pipe</DL>
</DD>
</DL>
<HR>

<A NAME="createInputPipe(net.jxta.protocol.PipeAdvertisement, net.jxta.pipe.PipeMsgListener)"><!-- --></A><H3>
createInputPipe</H3>
<PRE>
public <A HREF="../../../../net/jxta/pipe/InputPipe.html" title="interface in net.jxta.pipe">InputPipe</A> <B>createInputPipe</B>(<A HREF="../../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;adv,
                                 <A HREF="../../../../net/jxta/pipe/PipeMsgListener.html" title="interface in net.jxta.pipe">PipeMsgListener</A>&nbsp;listener)
                          throws java.io.IOException</PRE>
<DL>
<DD>create an InputPipe from a pipe Advertisement
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/pipe/PipeService.html#createInputPipe(net.jxta.protocol.PipeAdvertisement, net.jxta.pipe.PipeMsgListener)">createInputPipe</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/pipe/PipeService.html" title="interface in net.jxta.pipe">PipeService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>adv</CODE> - is the advertisement of the PipeService.<DD><CODE>listener</CODE> - PipeMsgListener to receive msgs.
<DT><B>Returns:</B><DD>InputPipe InputPipe object created
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - error creating input pipe</DL>
</DD>
</DL>
<HR>

<A NAME="createOutputPipe(net.jxta.protocol.PipeAdvertisement, long)"><!-- --></A><H3>
createOutputPipe</H3>
<PRE>
public <A HREF="../../../../net/jxta/pipe/OutputPipe.html" title="interface in net.jxta.pipe">OutputPipe</A> <B>createOutputPipe</B>(<A HREF="../../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;pipeAdv,
                                   long&nbsp;timeout)
                            throws java.io.IOException</PRE>
<DL>
<DD>Attempt to ceate an OutputPipe using the specified Pipe Advertisement.
 The pipe will be be resolved within the provided timeout.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/pipe/PipeService.html#createOutputPipe(net.jxta.protocol.PipeAdvertisement, long)">createOutputPipe</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/pipe/PipeService.html" title="interface in net.jxta.pipe">PipeService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pipeAdv</CODE> - The advertisement of the pipe being resolved.<DD><CODE>timeout</CODE> - time duration in milliseconds to wait for a successful
 pipe resolution. <code>0</code> will wait indefinitely. All negative
 values will cause a wait of an inplementation defined non-infinite value.
 (this behaviour is deprecated and may eventually disappear).
<DT><B>Returns:</B><DD>OutputPipe the successfully resolved OutputPipe.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - If the pipe cannot be created or failed to resolve
 within the specified time.</DL>
</DD>
</DL>
<HR>

<A NAME="createOutputPipe(net.jxta.protocol.PipeAdvertisement, net.jxta.peer.PeerID, long)"><!-- --></A><H3>
createOutputPipe</H3>
<PRE>
public <A HREF="../../../../net/jxta/pipe/OutputPipe.html" title="interface in net.jxta.pipe">OutputPipe</A> <B>createOutputPipe</B>(<A HREF="../../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;pipeAdv,
                                   <A HREF="../../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer">PeerID</A>&nbsp;peerid,
                                   long&nbsp;timeout)
                            throws java.io.IOException</PRE>
<DL>
<DD>Attempt to ceate an OutputPipe using the specified Pipe Advertisement.
 The pipe will be be resolved to one of the peers in the set of peer ids
 provided within the provided timeout.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/pipe/PipeService.html#createOutputPipe(net.jxta.protocol.PipeAdvertisement, net.jxta.peer.PeerID, long)">createOutputPipe</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/pipe/PipeService.html" title="interface in net.jxta.pipe">PipeService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pipeAdv</CODE> - The advertisement of the pipe being resolved.<DD><CODE>peerid</CODE> - The peer id of the peer on which  on which the pipe may be
 resolved. All elements of the enumeration <strong>must</strong> must be
 of type <A HREF="../../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer"><CODE>PeerID</CODE></A>.<DD><CODE>timeout</CODE> - time duration in milliseconds to wait for a successful
 pipe resolution. <code>0</code> will wait indefinitely. All negative
 values will cause a wait of an inplementation defined non-infinite value.
 (this behaviour is deprecated and may eventually disappear).
<DT><B>Returns:</B><DD>OutputPipe the successfully resolved OutputPipe.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - If the pipe cannot be created or failed to resolve
 within the specified time.</DL>
</DD>
</DL>
<HR>

<A NAME="createOutputPipe(net.jxta.protocol.PipeAdvertisement, java.util.Enumeration, long)"><!-- --></A><H3>
createOutputPipe</H3>
<PRE>
public <A HREF="../../../../net/jxta/pipe/OutputPipe.html" title="interface in net.jxta.pipe">OutputPipe</A> <B>createOutputPipe</B>(<A HREF="../../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;adv,
                                   java.util.Enumeration&nbsp;resolvablePeers,
                                   long&nbsp;timeout)
                            throws java.io.IOException</PRE>
<DL>
<DD>Attempt to ceate an OutputPipe using the specified Pipe Advertisement.
 The pipe will be be resolved to one of the peers in the set of peer ids
 provided within the provided timeout.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/jxta/pipe/PipeService.html#createOutputPipe(net.jxta.protocol.PipeAdvertisement, java.util.Enumeration, long)">createOutputPipe</A></CODE> in interface <CODE><A HREF="../../../../net/jxta/pipe/PipeService.html" title="interface in net.jxta.pipe">PipeService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>adv</CODE> - The advertisement of the pipe being resolved.<DD><CODE>resolvablePeers</CODE> - The non-empty enumeration of peers on which the pipe may be
 resolved. All elements of the enumeration <strong>must</strong> must be
 of type <A HREF="../../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer"><CODE>PeerID</CODE></A>.<DD><CODE>timeout</CODE> - time duration in milliseconds to wait for a successful
 pipe resolution. <code>0</code> will wait indefinitely. All negative
 values will cause a wait of an inplementation defined non-infinite value.
 (this behaviour is deprecated and may eventually disappear).
<DT><B>Returns:</B><DD>OutputPipe the successfully resolved OutputPipe.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - If the pipe cannot be created or failed to resolve
 within the specified time.</DL>
</DD>
</DL>
<HR>

<A NAME="createOutputPipe(net.jxta.protocol.PipeAdvertisement, java.util.Set, long)"><!-- --></A><H3>
createOutputPipe</H3>
<PRE>
public <A HREF="../../../../net/jxta/pipe/OutputPipe.html" title="interface in net.jxta.pipe">OutputPipe</A> <B>createOutputPipe</B>(<A HREF="../../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;adv,
                                   java.util.Set&nbsp;resolvablePeers,