jxtabidipipe.html

jxta的api库

<A NAME="getRemotePipeAdvertisement()"><!-- --></A><H3>
getRemotePipeAdvertisement</H3>
<PRE>
public <A HREF="../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A> <B>getRemotePipeAdvertisement</B>()</PRE>
<DL>
<DD>Returns remote PipeAdvertisement
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>remote PipeAdvertisement</DL>
</DD>
</DL>
<HR>

<A NAME="setRemotePeerAdvertisement(net.jxta.protocol.PeerAdvertisement)"><!-- --></A><H3>
setRemotePeerAdvertisement</H3>
<PRE>
protected void <B>setRemotePeerAdvertisement</B>(<A HREF="../../../net/jxta/protocol/PeerAdvertisement.html" title="class in net.jxta.protocol">PeerAdvertisement</A>&nbsp;peer)</PRE>
<DL>
<DD>Sets the remote PeerAdvertisement
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>peer</CODE> - Remote PeerAdvertisement</DL>
</DD>
</DL>
<HR>

<A NAME="setRemotePipeAdvertisement(net.jxta.protocol.PipeAdvertisement)"><!-- --></A><H3>
setRemotePipeAdvertisement</H3>
<PRE>
protected void <B>setRemotePipeAdvertisement</B>(<A HREF="../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;pipe)</PRE>
<DL>
<DD>Sets the remote PipeAdvertisement
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pipe</CODE> - PipeAdvertisement</DL>
</DD>
</DL>
<HR>

<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()
           throws java.io.IOException</PRE>
<DL>
<DD>Closes this pipe.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an I/O error occurs when closing this
      socket.</DL>
</DD>
</DL>
<HR>

<A NAME="closePipe()"><!-- --></A><H3>
closePipe</H3>
<PRE>
protected void <B>closePipe</B>()
                  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="setInputPipe(net.jxta.pipe.InputPipe)"><!-- --></A><H3>
setInputPipe</H3>
<PRE>
protected void <B>setInputPipe</B>(<A HREF="../../../net/jxta/pipe/InputPipe.html" title="interface in net.jxta.pipe">InputPipe</A>&nbsp;in)</PRE>
<DL>
<DD>Sets the inputPipe attribute of the JxtaBiDiPipe object
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>in</CODE> - The new inputPipe value</DL>
</DD>
</DL>
<HR>

<A NAME="pipeMsgEvent(net.jxta.pipe.PipeMsgEvent)"><!-- --></A><H3>
pipeMsgEvent</H3>
<PRE>
public void <B>pipeMsgEvent</B>(<A HREF="../../../net/jxta/pipe/PipeMsgEvent.html" title="class in net.jxta.pipe">PipeMsgEvent</A>&nbsp;event)</PRE>
<DL>
<DD>Called for each pipe message event that occurs.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/jxta/pipe/PipeMsgListener.html#pipeMsgEvent(net.jxta.pipe.PipeMsgEvent)">pipeMsgEvent</A></CODE> in interface <CODE><A HREF="../../../net/jxta/pipe/PipeMsgListener.html" title="interface in net.jxta.pipe">PipeMsgListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>event</CODE> - The event being received.</DL>
</DD>
</DL>
<HR>

<A NAME="processIncomingMessage(net.jxta.endpoint.Message)"><!-- --></A><H3>
processIncomingMessage</H3>
<PRE>
public void <B>processIncomingMessage</B>(<A HREF="../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;message)</PRE>
<DL>
<DD>Called for each message received.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/jxta/impl/util/pipe/reliable/ReliableInputStream.MsgListener.html#processIncomingMessage(net.jxta.endpoint.Message)">processIncomingMessage</A></CODE> in interface <CODE><A HREF="../../../net/jxta/impl/util/pipe/reliable/ReliableInputStream.MsgListener.html" title="interface in net.jxta.impl.util.pipe.reliable">ReliableInputStream.MsgListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="sendMessage(net.jxta.endpoint.Message)"><!-- --></A><H3>
sendMessage</H3>
<PRE>
public boolean <B>sendMessage</B>(<A HREF="../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A>&nbsp;msg)
                    throws java.io.IOException</PRE>
<DL>
<DD>Send a message
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - Message to send to the remote side
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="outputPipeEvent(net.jxta.pipe.OutputPipeEvent)"><!-- --></A><H3>
outputPipeEvent</H3>
<PRE>
public void <B>outputPipeEvent</B>(<A HREF="../../../net/jxta/pipe/OutputPipeEvent.html" title="class in net.jxta.pipe">OutputPipeEvent</A>&nbsp;event)</PRE>
<DL>
<DD>Called when a input pipe has been located for a previously registered
 pipe. The event contains an <A HREF="../../../net/jxta/pipe/OutputPipe.html" title="interface in net.jxta.pipe"><CODE>OutputPipe</CODE></A> which can
 be used to communicate with the remote peer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../net/jxta/pipe/OutputPipeListener.html#outputPipeEvent(net.jxta.pipe.OutputPipeEvent)">outputPipeEvent</A></CODE> in interface <CODE><A HREF="../../../net/jxta/pipe/OutputPipeListener.html" title="interface in net.jxta.pipe">OutputPipeListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>event</CODE> - the event</DL>
</DD>
</DL>
<HR>

<A NAME="lightweightOutputPipe(net.jxta.peergroup.PeerGroup, net.jxta.protocol.PipeAdvertisement, net.jxta.protocol.PeerAdvertisement)"><!-- --></A><H3>
lightweightOutputPipe</H3>
<PRE>
protected static <A HREF="../../../net/jxta/endpoint/Messenger.html" title="interface in net.jxta.endpoint">Messenger</A> <B>lightweightOutputPipe</B>(<A HREF="../../../net/jxta/peergroup/PeerGroup.html" title="interface in net.jxta.peergroup">PeerGroup</A>&nbsp;group,
                                                 <A HREF="../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;pipeAdv,
                                                 <A HREF="../../../net/jxta/protocol/PeerAdvertisement.html" title="class in net.jxta.protocol">PeerAdvertisement</A>&nbsp;peer)</PRE>
<DL>
<DD>A lightweight output pipe constructor, note the return type
 Since all the info needed is available, there's no need for to 
 use the pipe service to resolve the pipe we have all we need
 to construct a messenger.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context<DD><CODE>pipeAdv</CODE> - Remote Pipe Advertisement<DD><CODE>peer</CODE> - Remote Peer Advertisment
<DT><B>Returns:</B><DD>Messenger</DL>
</DD>
</DL>
<HR>

<A NAME="checkCred(net.jxta.document.StructuredDocument)"><!-- --></A><H3>
checkCred</H3>
<PRE>
protected boolean <B>checkCred</B>(<A HREF="../../../net/jxta/document/StructuredDocument.html" title="interface in net.jxta.document">StructuredDocument</A>&nbsp;cred)</PRE>
<DL>
<DD>Not implemented yet
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getListener()"><!-- --></A><H3>
getListener</H3>
<PRE>
public <A HREF="../../../net/jxta/pipe/PipeMsgListener.html" title="interface in net.jxta.pipe">PipeMsgListener</A> <B>getListener</B>()</PRE>
<DL>
<DD>Returns the message listener for this pipe
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>PipeMsgListener</DL>
</DD>
</DL>
<HR>

<A NAME="setListener(net.jxta.pipe.PipeMsgListener)"><!-- --></A><H3>
setListener</H3>
<PRE>
public void <B>setListener</B>(<A HREF="../../../net/jxta/pipe/PipeMsgListener.html" title="interface in net.jxta.pipe">PipeMsgListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Sets message listener for a pipe spawned by the JxtaServerPipe.
 There is a window where a message could arrive prior to listener being registered
 threrefore a message queue is created to queue messages, once a listener is registered
 these messages will be dequeued by calling the listener until the queue is empty
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - New value of property listener.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessage(int)"><!-- --></A><H3>
getMessage</H3>
<PRE>
public <A HREF="../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A> <B>getMessage</B>(int&nbsp;timeout)
                   throws java.lang.InterruptedException</PRE>
<DL>
<DD>Gets a message from the queue. If no Object is immediately available,
 then wait the specified amount of time for a message to be inserted.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - Amount of time to wait in milliseconds for an object to
 be available. Per Java convention, a timeout of zero (0) means wait an
 infinite amount of time. Negative values mean do not wait at all.
<DT><B>Returns:</B><DD>The next message in the queue., if a listener is registered calls 
 to this method will return null
<DT><B>Throws:</B>
<DD><CODE>java.lang.InterruptedException</CODE> - if the operation is interrupted before
 the timeout interval is completed.</DL>
</DD>
</DL>
<HR>

<A NAME="getPipeAdvertisement()"><!-- --></A><H3>
getPipeAdvertisement</H3>
<PRE>
public <A HREF="../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A> <B>getPipeAdvertisement</B>()</PRE>
<DL>
<DD>Returns the Assigned PipeAdvertisement
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Assigned PipeAdvertisement</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=3 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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JxtaBiDiPipe.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT