jxtabidipipe.html

jxta的api库

<DL>
<DD>attempts to create a bidirectional connection to remote peer within default
 timeout of 1 minutes, and intiates a connection
<P>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context<DD><CODE>listener</CODE> - application PipeMsgListener
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an io error occurs</DL>
<HR>

<A NAME="JxtaBiDiPipe(net.jxta.peergroup.PeerGroup, net.jxta.protocol.PipeAdvertisement, int, net.jxta.pipe.PipeMsgListener, boolean)"><!-- --></A><H3>
JxtaBiDiPipe</H3>
<PRE>
public <B>JxtaBiDiPipe</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;pipeAd,
                    int&nbsp;timeout,
                    <A HREF="../../../net/jxta/pipe/PipeMsgListener.html" title="interface in net.jxta.pipe">PipeMsgListener</A>&nbsp;listener,
                    boolean&nbsp;reliable)
             throws java.io.IOException</PRE>
<DL>
<DD>attempts to create a bidirectional connection to remote peer within default
 timeout of 60,000ms, and intiates a connection
<P>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context<DD><CODE>listener</CODE> - application PipeMsgListener
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an io error occurs</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="connect(net.jxta.peergroup.PeerGroup, net.jxta.protocol.PipeAdvertisement)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</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;pipeAd)
             throws java.io.IOException</PRE>
<DL>
<DD>Connect to JxtaBiDiPipe with default timeout
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context<DD><CODE>pipeAd</CODE> - PipeAdvertisement
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an io error occurs</DL>
</DD>
</DL>
<HR>

<A NAME="connect(net.jxta.peergroup.PeerGroup, net.jxta.protocol.PipeAdvertisement, int)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</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;pipeAd,
                    int&nbsp;timeout)
             throws java.io.IOException</PRE>
<DL>
<DD>Connects to a remote JxtaBiDiPipe
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context<DD><CODE>pipeAd</CODE> - PipeAdvertisement<DD><CODE>timeout</CODE> - timeout in ms, also reset object default timeout
                               to that of timeout
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an io error occurs</DL>
</DD>
</DL>
<HR>

<A NAME="connect(net.jxta.peergroup.PeerGroup, net.jxta.peer.PeerID, net.jxta.protocol.PipeAdvertisement, int, net.jxta.pipe.PipeMsgListener)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</B>(<A HREF="../../../net/jxta/peergroup/PeerGroup.html" title="interface in net.jxta.peergroup">PeerGroup</A>&nbsp;group,
                    <A HREF="../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer">PeerID</A>&nbsp;peerid,
                    <A HREF="../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;pipeAd,
                    int&nbsp;timeout,
                    <A HREF="../../../net/jxta/pipe/PipeMsgListener.html" title="interface in net.jxta.pipe">PipeMsgListener</A>&nbsp;listener)
             throws java.io.IOException</PRE>
<DL>
<DD>Connects to a remote JxtaBiDiPipe
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context<DD><CODE>peerid</CODE> - peer to connect to<DD><CODE>timeout</CODE> - timeout in ms, also reset object default timeout to that of timeout
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an io error occurs</DL>
</DD>
</DL>
<HR>

<A NAME="connect(net.jxta.peergroup.PeerGroup, net.jxta.peer.PeerID, net.jxta.protocol.PipeAdvertisement, int, net.jxta.pipe.PipeMsgListener, boolean)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</B>(<A HREF="../../../net/jxta/peergroup/PeerGroup.html" title="interface in net.jxta.peergroup">PeerGroup</A>&nbsp;group,
                    <A HREF="../../../net/jxta/peer/PeerID.html" title="class in net.jxta.peer">PeerID</A>&nbsp;peerid,
                    <A HREF="../../../net/jxta/protocol/PipeAdvertisement.html" title="class in net.jxta.protocol">PipeAdvertisement</A>&nbsp;pipeAd,
                    int&nbsp;timeout,
                    <A HREF="../../../net/jxta/pipe/PipeMsgListener.html" title="interface in net.jxta.pipe">PipeMsgListener</A>&nbsp;listener,
                    boolean&nbsp;reliable)
             throws java.io.IOException</PRE>
<DL>
<DD>Connects to a remote JxtaBiDiPipe
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context<DD><CODE>peerid</CODE> - peer to connect to<DD><CODE>timeout</CODE> - timeout in ms, also reset object default timeout to that of timeout<DD><CODE>reliable</CODE> - Reliable connection
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an io error occurs</DL>
</DD>
</DL>
<HR>

<A NAME="setReliable(boolean)"><!-- --></A><H3>
setReliable</H3>
<PRE>
public void <B>setReliable</B>(boolean&nbsp;reliable)
                 throws java.io.IOException</PRE>
<DL>
<DD>Toggles reliability
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>IOEXecption</CODE> - if pipe is bound
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getCredDoc(net.jxta.peergroup.PeerGroup)"><!-- --></A><H3>
getCredDoc</H3>
<PRE>
protected static <A HREF="../../../net/jxta/document/StructuredDocument.html" title="interface in net.jxta.document">StructuredDocument</A> <B>getCredDoc</B>(<A HREF="../../../net/jxta/peergroup/PeerGroup.html" title="interface in net.jxta.peergroup">PeerGroup</A>&nbsp;group)</PRE>
<DL>
<DD>obtain the cred doc from the group object
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context
<DT><B>Returns:</B><DD>The credDoc value</DL>
</DD>
</DL>
<HR>

<A NAME="createOpenMessage(net.jxta.peergroup.PeerGroup, net.jxta.protocol.PipeAdvertisement)"><!-- --></A><H3>
createOpenMessage</H3>
<PRE>
protected <A HREF="../../../net/jxta/endpoint/Message.html" title="class in net.jxta.endpoint">Message</A> <B>createOpenMessage</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;pipeAd)</PRE>
<DL>
<DD>Create a connection request message
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>group</CODE> - group context<DD><CODE>pipeAd</CODE> - pipe advertisement
<DT><B>Returns:</B><DD>the Message  object</DL>
</DD>
</DL>
<HR>

<A NAME="accept(net.jxta.util.JxtaBiDiPipe)"><!-- --></A><H3>
accept</H3>
<PRE>
protected void <B>accept</B>(<A HREF="../../../net/jxta/util/JxtaBiDiPipe.html" title="class in net.jxta.util">JxtaBiDiPipe</A>&nbsp;s)
               throws java.io.IOException</PRE>
<DL>
<DD>Accepts a connection
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - the accepted connection.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an I/O error occurs when accepting the
      connection.</DL>
</DD>
</DL>
<HR>

<A NAME="setBound()"><!-- --></A><H3>
setBound</H3>
<PRE>
void <B>setBound</B>()</PRE>
<DL>
<DD>Sets the bound attribute of the JxtaServerPipe object
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isBound()"><!-- --></A><H3>
isBound</H3>
<PRE>
public boolean <B>isBound</B>()</PRE>
<DL>
<DD>Returns the binding state of the JxtaServerPipe.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the ServerSocket succesfuly bound to an address</DL>
</DD>
</DL>
<HR>

<A NAME="getInputPipe()"><!-- --></A><H3>
getInputPipe</H3>
<PRE>
public <A HREF="../../../net/jxta/pipe/InputPipe.html" title="interface in net.jxta.pipe">InputPipe</A> <B>getInputPipe</B>()
                       throws java.io.IOException</PRE>
<DL>
<DD>Returns an input stream for this socket.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a stream for reading from this socket.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an I/O error occurs when creating the
      input stream.</DL>
</DD>
</DL>
<HR>

<A NAME="getMessenger()"><!-- --></A><H3>
getMessenger</H3>
<PRE>
public <A HREF="../../../net/jxta/endpoint/Messenger.html" title="interface in net.jxta.endpoint">Messenger</A> <B>getMessenger</B>()
                       throws java.io.IOException</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use sendMessage instead</I>
<P>
<DD>Returns the messenger to the remote pipe
 Note that this method will block until a messenger is created.
 This is especially likely when this is a server and are waiting 
 to connect to a client.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the pipe messenger
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if an I/O error occurs when</DL>
</DD>
</DL>
<HR>

<A NAME="waiter(int)"><!-- --></A><H3>
waiter</H3>
<PRE>
protected void <B>waiter</B>(int&nbsp;timeMilisecs)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

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

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