mediaproxysession.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="MediaProxySession(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, java.lang.String, int, int, int)"><!-- --></A><H3>
MediaProxySession</H3>
<PRE>
public <B>MediaProxySession</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;id,
                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;creator,
                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;localAddress,
                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostA,
                         int&nbsp;portA,
                         <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;hostB,
                         int&nbsp;portB,
                         int&nbsp;minPort,
                         int&nbsp;maxPort)</PRE>
<DL>
<DD>Creates a new static UDP channel between Host A and Host B.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - of the Session (Could be a Jingle session ID)<DD><CODE>creator</CODE> - the session creator name or description<DD><CODE>localAddress</CODE> - the localhost IP that will listen for UDP packets<DD><CODE>hostA</CODE> - the hostname or IP of the point A of the Channel<DD><CODE>portA</CODE> - the port number point A of the Channel<DD><CODE>hostB</CODE> - the hostname or IP of the point B of the Channel<DD><CODE>portB</CODE> - the port number point B of the Channel<DD><CODE>minPort</CODE> - the minimal port value to be used by the server<DD><CODE>maxPort</CODE> - the maximun port value to be used by the server</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getFreePort()"><!-- --></A><H3>
getFreePort</H3>
<PRE>
protected int <B>getFreePort</B>()</PRE>
<DL>
<DD>Obtain a free port with a nested control port we can use.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A free port number.</DL>
</DD>
</DL>
<HR>

<A NAME="getSID()"><!-- --></A><H3>
getSID</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getSID</B>()</PRE>
<DL>
<DD>Get the ID of the Session
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#getSID()">getSID</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the ID of the session</DL>
</DD>
</DL>
<HR>

<A NAME="getPass()"><!-- --></A><H3>
getPass</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getPass</B>()</PRE>
<DL>
<DD>Get the pass of this Session
 A pass can be used to authorize an Session modification
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#getPass()">getPass</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getCreator()"><!-- --></A><H3>
getCreator</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getCreator</B>()</PRE>
<DL>
<DD>Get the agent creator.
 This field is open to MediaProxy users and just can be set in constructor.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the session creator name or description</DL>
</DD>
</DL>
<HR>

<A NAME="getTimestamp()"><!-- --></A><H3>
getTimestamp</H3>
<PRE>
public long <B>getTimestamp</B>()</PRE>
<DL>
<DD>Get last packet arrived timestamp
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>TimeStamp in Millis</DL>
</DD>
</DL>
<HR>

<A NAME="run()"><!-- --></A><H3>
run</H3>
<PRE>
public void <B>run</B>()</PRE>
<DL>
<DD>Thread override method
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Runnable.html#run()" title="class or interface in java.lang">run</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Runnable.html" title="class or interface in java.lang">Runnable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html#run()" title="class or interface in java.lang">run</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Thread.html" title="class or interface in java.lang">Thread</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="stopAgent()"><!-- --></A><H3>
stopAgent</H3>
<PRE>
public void <B>stopAgent</B>()</PRE>
<DL>
<DD>Stop the Session
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#stopAgent()">stopAgent</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLocalhost()"><!-- --></A><H3>
getLocalhost</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A> <B>getLocalhost</B>()</PRE>
<DL>
<DD>Get localhost of the Session
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#getLocalhost()">getLocalhost</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the localhost of the session</DL>
</DD>
</DL>
<HR>

<A NAME="getHostA()"><!-- --></A><H3>
getHostA</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A> <B>getHostA</B>()</PRE>
<DL>
<DD>Get the Host A IP
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#getHostA()">getHostA</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the host A ip</DL>
</DD>
</DL>
<HR>

<A NAME="getHostB()"><!-- --></A><H3>
getHostB</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A> <B>getHostB</B>()</PRE>
<DL>
<DD>Get the Host B IP
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#getHostB()">getHostB</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the host B ip</DL>
</DD>
</DL>
<HR>

<A NAME="setPortA(int)"><!-- --></A><H3>
setPortA</H3>
<PRE>
public void <B>setPortA</B>(int&nbsp;portA)</PRE>
<DL>
<DD>Set port A value
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#setPortA(int)">setPortA</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portA</CODE> - the port number for A</DL>
</DD>
</DL>
<HR>

<A NAME="setPortB(int)"><!-- --></A><H3>
setPortB</H3>
<PRE>
public void <B>setPortB</B>(int&nbsp;portB)</PRE>
<DL>
<DD>Set port B value
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#setPortB(int)">setPortB</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portB</CODE> - the port number for B</DL>
</DD>
</DL>
<HR>

<A NAME="setHostA(java.net.InetAddress)"><!-- --></A><H3>
setHostA</H3>
<PRE>
public void <B>setHostA</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/InetAddress.html" title="class or interface in java.net">InetAddress</A>&nbsp;hostA)</PRE>
<DL>
<DD>Set the Host A IP
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html#setHostA(java.net.InetAddress)">setHostA</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>hostA</CODE> - the host for A</DL>
</DD>
</DL>
<HR>

<A NAME="setHostB(java.net.InetAddress)"><!-- --></A><H3>
setHostB</H3>