mediaproxy.html

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

</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the host that listens for incomming packets.</DL>
</DD>
</DL>
<HR>

<A NAME="getIdleTime()"><!-- --></A><H3>
getIdleTime</H3>
<PRE>
public long <B>getIdleTime</B>()</PRE>
<DL>
<DD>Returns the max time (in millis) that a session can remain open without
 receiving any packets. After this time period elapses, the session is
 automatically closed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the max idle time (in millis).</DL>
</DD>
</DL>
<HR>

<A NAME="setIdleTime(long)"><!-- --></A><H3>
setIdleTime</H3>
<PRE>
public void <B>setIdleTime</B>(long&nbsp;idleTime)</PRE>
<DL>
<DD>Sets the max time (in millis) that a session can remain open without
 receiving any packets. After this time period elapses, the session is
 automatically closed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>idleTime</CODE> - the max idle time in millis.</DL>
</DD>
</DL>
<HR>

<A NAME="getSessions()"><!-- --></A><H3>
getSessions</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/mediaproxy/MediaProxySession.html" title="class in org.jivesoftware.openfire.mediaproxy">MediaProxySession</A>&gt; <B>getSessions</B>()</PRE>
<DL>
<DD>Returns the list of all currently active and running sessions.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>List of the Agents</DL>
</DD>
</DL>
<HR>

<A NAME="getMinPort()"><!-- --></A><H3>
getMinPort</H3>
<PRE>
public int <B>getMinPort</B>()</PRE>
<DL>
<DD>Returns the minimum port value to listen for incoming packets.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the minimum port value.</DL>
</DD>
</DL>
<HR>

<A NAME="setMinPort(int)"><!-- --></A><H3>
setMinPort</H3>
<PRE>
public void <B>setMinPort</B>(int&nbsp;minPort)</PRE>
<DL>
<DD>Sets the minimum port value to listen from incoming packets.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>minPort</CODE> - the minimum port value.</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxPort()"><!-- --></A><H3>
getMaxPort</H3>
<PRE>
public int <B>getMaxPort</B>()</PRE>
<DL>
<DD>Returns the maximum port value to listen for incoming packets.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the maximun port value.</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxPort(int)"><!-- --></A><H3>
setMaxPort</H3>
<PRE>
public void <B>setMaxPort</B>(int&nbsp;maxPort)</PRE>
<DL>
<DD>Sets the maximum port value to listen for incoming packets.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>maxPort</CODE> - the maximun port value.</DL>
</DD>
</DL>
<HR>

<A NAME="getLifetime()"><!-- --></A><H3>
getLifetime</H3>
<PRE>
public long <B>getLifetime</B>()</PRE>
<DL>
<DD>Returns the maximum lifetime (in seconds) of a session. After the time period
 elapses, the session will be destroyed even if currently active.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the max lifetime of a session (in seconds).</DL>
</DD>
</DL>
<HR>

<A NAME="setLifetime(long)"><!-- --></A><H3>
setLifetime</H3>
<PRE>
public void <B>setLifetime</B>(long&nbsp;lifetime)</PRE>
<DL>
<DD>Sets the maximum lifetime (in seconds) of a session. After the time period
 elapses, the session will be destroyed even if currently active.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lifetime</CODE> - the max lifetime of a session (in seconds).</DL>
</DD>
</DL>
<HR>

<A NAME="getSession(java.lang.String)"><!-- --></A><H3>
getSession</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/mediaproxy/MediaProxySession.html" title="class in org.jivesoftware.openfire.mediaproxy">MediaProxySession</A> <B>getSession</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;sid)</PRE>
<DL>
<DD>Returns a media proxy session with the specified ID.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sid</CODE> - the session ID.
<DT><B>Returns:</B><DD>the session or <tt>null</tt> if the session doesn't exist.</DL>
</DD>
</DL>
<HR>

<A NAME="sessionClosed(org.jivesoftware.openfire.mediaproxy.MediaProxySession)"><!-- --></A><H3>
sessionClosed</H3>
<PRE>
public void <B>sessionClosed</B>(<A HREF="../../../../org/jivesoftware/openfire/mediaproxy/MediaProxySession.html" title="class in org.jivesoftware.openfire.mediaproxy">MediaProxySession</A>&nbsp;session)</PRE>
<DL>
<DD>Implements Session Listener stopAgent event.
 Remove the stopped session from the sessions list.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/SessionListener.html#sessionClosed(org.jivesoftware.openfire.mediaproxy.MediaProxySession)">sessionClosed</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/mediaproxy/SessionListener.html" title="interface in org.jivesoftware.openfire.mediaproxy">SessionListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>session</CODE> - the session that stopped</DL>
</DD>
</DL>
<HR>

<A NAME="addRelayAgent(java.lang.String, java.lang.String, java.lang.String, int, java.lang.String, int)"><!-- --></A><H3>
addRelayAgent</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A> <B>addRelayAgent</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;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)</PRE>
<DL>
<DD>Add a new Dynamic Session to the mediaproxy for defined IPs and ports.
 The IP and port pairs can change depending of the Senders IP and port.
 Which means that the IP and port values of the points can dynamic change after the Channel is opened.
 When the agent receives a packet from Point A, the channel set the point A IP and port according to
 the received packet sender IP and port.
 Every packet received from Point B will be relayed to the new Point A IP and port.
 When the agent receives a packet from Point B, the channel set the point B IP and port according to
 the received packet sender IP and port.
 Every packet received from Point A will be relayed to the new Point B IP and port.
 Create a dynamic channel between two IPs. ( Dynamic Point A - Dynamic Point B )
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - id of the candidate returned (Could be a Jingle session ID)<DD><CODE>creator</CODE> - the agent creator name or description<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
<DT><B>Returns:</B><DD>the added ProxyCandidate</DL>
</DD>
</DL>
<HR>

<A NAME="addRelayAgent(java.lang.String, java.lang.String)"><!-- --></A><H3>
addRelayAgent</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/mediaproxy/ProxyCandidate.html" title="interface in org.jivesoftware.openfire.mediaproxy">ProxyCandidate</A> <B>addRelayAgent</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)</PRE>
<DL>
<DD>Add a new Dynamic Session to the mediaproxy WITHOUT defined IPs and ports.
 The IP and port pairs WILL change depending of the Senders IP and port.
 Which means that the IP and port values of the points will dynamic change after the Channel is opened
 and received packet from both points.
 When the agent receives a packet from Point A, the channel set the point A IP and port according to
 the received packet sender IP and port.
 Every packet received from Point B will be relayed to the new Point A IP and port.
 When the agent receives a packet from Point B, the channel set the point B IP and port according to
 the received packet sender IP and port.
 Every packet received from Point A will be relayed to the new Point B IP and port.
 Create a dynamic channel between two IPs. ( Dynamic Point A - Dynamic Point B )
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - id of the candidate returned (Could be a Jingle session ID)<DD><CODE>creator</CODE> - the agent creator name or description
<DT><B>Returns:</B><DD>the added ProxyCandidate</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>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/mediaproxy/Echo.html" title="class in org.jivesoftware.openfire.mediaproxy"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/mediaproxy/MediaProxyService.html" title="class in org.jivesoftware.openfire.mediaproxy"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/mediaproxy/MediaProxy.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="MediaProxy.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;NESTED&nbsp;|&nbsp;FIELD&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-2008 Jive Software.</i>
</BODY>
</HTML>