bytestream.html

开源项目smack的API文件

<A NAME="addStreamHost(java.lang.String, java.lang.String)"><!-- --></A><H3>
addStreamHost</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/smackx/packet/Bytestream.StreamHost.html" title="class in org.jivesoftware.smackx.packet">Bytestream.StreamHost</A> <B>addStreamHost</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;JID,
                                           <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;address)</PRE>
<DL>
<DD>Adds a potential stream host that the remote user can connect to to
 receive the file.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>JID</CODE> - The jabber ID of the stream host.<DD><CODE>address</CODE> - The internet address of the stream host.
<DT><B>Returns:</B><DD>The added stream host.</DL>
</DD>
</DL>
<HR>

<A NAME="addStreamHost(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
addStreamHost</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/smackx/packet/Bytestream.StreamHost.html" title="class in org.jivesoftware.smackx.packet">Bytestream.StreamHost</A> <B>addStreamHost</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;JID,
                                           <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;address,
                                           int&nbsp;port)</PRE>
<DL>
<DD>Adds a potential stream host that the remote user can connect to to
 receive the file.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>JID</CODE> - The jabber ID of the stream host.<DD><CODE>address</CODE> - The internet address of the stream host.<DD><CODE>port</CODE> - The port on which the remote host is seeking connections.
<DT><B>Returns:</B><DD>The added stream host.</DL>
</DD>
</DL>
<HR>

<A NAME="addStreamHost(org.jivesoftware.smackx.packet.Bytestream.StreamHost)"><!-- --></A><H3>
addStreamHost</H3>
<PRE>
public void <B>addStreamHost</B>(<A HREF="../../../../org/jivesoftware/smackx/packet/Bytestream.StreamHost.html" title="class in org.jivesoftware.smackx.packet">Bytestream.StreamHost</A>&nbsp;host)</PRE>
<DL>
<DD>Adds a potential stream host that the remote user can transfer the file
 through.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>host</CODE> - The potential stream host.</DL>
</DD>
</DL>
<HR>

<A NAME="getStreamHosts()"><!-- --></A><H3>
getStreamHosts</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/smackx/packet/Bytestream.StreamHost.html" title="class in org.jivesoftware.smackx.packet">Bytestream.StreamHost</A>&gt; <B>getStreamHosts</B>()</PRE>
<DL>
<DD>Returns the list of stream hosts contained in the packet.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Returns the list of stream hosts contained in the packet.</DL>
</DD>
</DL>
<HR>

<A NAME="getStreamHost(java.lang.String)"><!-- --></A><H3>
getStreamHost</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/smackx/packet/Bytestream.StreamHost.html" title="class in org.jivesoftware.smackx.packet">Bytestream.StreamHost</A> <B>getStreamHost</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;JID)</PRE>
<DL>
<DD>Returns the stream host related to the given jabber ID, or null if there
 is none.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>JID</CODE> - The jabber ID of the desired stream host.
<DT><B>Returns:</B><DD>Returns the stream host related to the given jabber ID, or null
         if there is none.</DL>
</DD>
</DL>
<HR>

<A NAME="countStreamHosts()"><!-- --></A><H3>
countStreamHosts</H3>
<PRE>
public int <B>countStreamHosts</B>()</PRE>
<DL>
<DD>Returns the count of stream hosts contained in this packet.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Returns the count of stream hosts contained in this packet.</DL>
</DD>
</DL>
<HR>

<A NAME="setUsedHost(java.lang.String)"><!-- --></A><H3>
setUsedHost</H3>
<PRE>
public void <B>setUsedHost</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;JID)</PRE>
<DL>
<DD>Upon connecting to the stream host the target of the stream replys to the
 initiator with the jabber id of the Socks5 host that they used.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>JID</CODE> - The jabber ID of the used host.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsedHost()"><!-- --></A><H3>
getUsedHost</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/smackx/packet/Bytestream.StreamHostUsed.html" title="class in org.jivesoftware.smackx.packet">Bytestream.StreamHostUsed</A> <B>getUsedHost</B>()</PRE>
<DL>
<DD>Returns the Socks5 host connected to by the remote user.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Returns the Socks5 host connected to by the remote user.</DL>
</DD>
</DL>
<HR>

<A NAME="getToActivate()"><!-- --></A><H3>
getToActivate</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/smackx/packet/Bytestream.Activate.html" title="class in org.jivesoftware.smackx.packet">Bytestream.Activate</A> <B>getToActivate</B>()</PRE>
<DL>
<DD>Returns the activate element of the packet sent to the proxy host to
 verify the identity of the initiator and match them to the appropriate
 stream.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Returns the activate element of the packet sent to the proxy host
         to verify the identity of the initiator and match them to the
         appropriate stream.</DL>
</DD>
</DL>
<HR>

<A NAME="setToActivate(java.lang.String)"><!-- --></A><H3>
setToActivate</H3>
<PRE>
public void <B>setToActivate</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;targetID)</PRE>
<DL>
<DD>Upon the response from the target of the used host the activate packet is
 sent to the Socks5 proxy. The proxy will activate the stream or return an
 error after verifying the identity of the initiator, using the activate
 packet.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>targetID</CODE> - The jabber ID of the target of the file transfer.</DL>
</DD>
</DL>
<HR>

<A NAME="getChildElementXML()"><!-- --></A><H3>
getChildElementXML</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getChildElementXML</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/smack/packet/IQ.html#getChildElementXML()">IQ</A></CODE></B></DD>
<DD>Returns the sub-element XML section of the IQ packet, or <tt>null</tt> if there
 isn't one. Packet extensions <b>must</b> be included, if any are defined.<p>

 Extensions of this class must override this method.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/smack/packet/IQ.html#getChildElementXML()">getChildElementXML</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/smack/packet/IQ.html" title="class in org.jivesoftware.smack.packet">IQ</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the child element section of the IQ XML.</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=2 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="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 CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Smack</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/smackx/packet/Bytestream.Activate.html" title="class in org.jivesoftware.smackx.packet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/smackx/packet/Bytestream.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Bytestream.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.jivesoftware.smack.packet.Packet">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2007 Jive Software. </i>
</BODY>
</HTML>