sipstack.html

jsip开发文档,对于开发SIP软电话和presence服务很有用

                                    java.lang.String transport)
                                    throws <A HREF="../../javax/sip/TransportNotSupportedException.html" title="class in javax.sip">TransportNotSupportedException</A>,
                                           <A HREF="../../javax/sip/InvalidArgumentException.html" title="class in javax.sip">InvalidArgumentException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since v1.2. This has been replaced by 
  <A HREF="../../javax/sip/SipStack.html#createListeningPoint(java.lang.String, int, java.lang.String)"><CODE>createListeningPoint(String, int, String)</CODE></A> 
 For backwards compatibility with v1.1 implementations should support this method.
 Implementations should throw <it>TransportNotSupportedException</it>
 if the Properties specified during stack creation do not include an IP Address.</I>
<P>
<DD>Creates a new ListeningPoint on this SipStack on a specified port and
 transport and the default IP address of this stack as specified by the
 SipStack IP address configuration parameter, and returns a reference to
 the newly created ListeningPoint object. The newly created ListeningPoint
 is implicitly attached to this SipStack upon execution of this method, by
 adding the ListeningPoint to the List of ListeningPoints of this SipStack
 once it has been successfully created.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>port</CODE> - the port of the new ListeningPoint.<DD><CODE>transport</CODE> - the transport of the new ListeningPoint.
<DT><B>Returns:</B><DD>the ListeningPoint attached to this SipStack.
<DT><B>Throws:</B>
<DD><CODE>TansportNotSupportedException</CODE> - if the specified transport is not supported by this SipStack.
<DD><CODE><A HREF="../../javax/sip/InvalidArgumentException.html" title="class in javax.sip">InvalidArgumentException</A></CODE> - if the specified port is invalid.
<DD><CODE><A HREF="../../javax/sip/TransportNotSupportedException.html" title="class in javax.sip">TransportNotSupportedException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="createListeningPoint(java.lang.String, int, java.lang.String)"><!-- --></A><H3>
createListeningPoint</H3>
<PRE>
<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A> <B>createListeningPoint</B>(java.lang.String&nbsp;ipAddress,
                                    int&nbsp;port,
                                    java.lang.String&nbsp;transport)
                                    throws <A HREF="../../javax/sip/TransportNotSupportedException.html" title="class in javax.sip">TransportNotSupportedException</A>,
                                           <A HREF="../../javax/sip/InvalidArgumentException.html" title="class in javax.sip">InvalidArgumentException</A></PRE>
<DL>
<DD>Creates a ListeningPoint a given IP address, port and transport. If this
 method is used, the IP address of the stack is ignored and a listening
 point is created with the given parameters. This support is useful for
 multi-homed hosts which may have to listen at multiple IP addresses and
 have different dialogs for each IP address.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>ListeningPoint that uses the IP address port and transport.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/SipException.html" title="class in javax.sip">SipException</A></CODE> - if the Listening point cannot be created for any reason or if the 
 stack has specified a default IP address that differs from the IP address specified 
 for this method.
<DD><CODE><A HREF="../../javax/sip/InvalidArgumentException.html" title="class in javax.sip">InvalidArgumentException</A></CODE>
<DD><CODE><A HREF="../../javax/sip/TransportNotSupportedException.html" title="class in javax.sip">TransportNotSupportedException</A></CODE><DT><B>Since:</B></DT>
  <DD>1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="deleteListeningPoint(javax.sip.ListeningPoint)"><!-- --></A><H3>
deleteListeningPoint</H3>
<PRE>
void <B>deleteListeningPoint</B>(<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A>&nbsp;listeningPoint)
                          throws <A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></PRE>
<DL>
<DD>Deletes the specified ListeningPoint attached to this SipStack. The
 specified ListeningPoint is implicitly detached from this SipStack upon
 execution of this method, by removing the ListeningPoint from the
 ListeningPoints list of this SipStack.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listeningPoint</CODE> - the SipProvider to be deleted from this SipStack.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></CODE> - if the specified ListeningPoint cannot be deleted because the
             ListeningPoint is currently in use.</DL>
</DD>
</DL>
<HR>

<A NAME="getListeningPoints()"><!-- --></A><H3>
getListeningPoints</H3>
<PRE>
java.util.Iterator <B>getListeningPoints</B>()</PRE>
<DL>
<DD>Returns an Iterator of existing ListeningPoints created by this SipStack.
 All of the ListeningPoints of this SipStack belong to the same stack
 vendor.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an Iterator containing all existing ListeningPoints created by
         this SipStack. Returns an empty Iterator if no ListeningPoints
         exist.</DL>
</DD>
</DL>
<HR>

<A NAME="getStackName()"><!-- --></A><H3>
getStackName</H3>
<PRE>
java.lang.String <B>getStackName</B>()</PRE>
<DL>
<DD>Gets the user friendly name that identifies this SipStack instance. This
 value is set using the Properties object passed to the
 <A HREF="../../javax/sip/SipFactory.html#createSipStack(java.util.Properties)"><CODE>SipFactory.createSipStack(Properties)</CODE></A>method upon creation of the
 SipStack object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a string identifing the stack instance</DL>
</DD>
</DL>
<HR>

<A NAME="getIPAddress()"><!-- --></A><H3>
getIPAddress</H3>
<PRE>
java.lang.String <B>getIPAddress</B>()</PRE>
<DL>
<DD>Gets the IP Address that identifies this SipStack instance. Every
 SipStack object may have an IP Address. This specification recommends 
 associating the IP address with the <A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip"><CODE>ListeningPoint</CODE></A>. 
 For backwards compatability if an IP address is specified in the 
 Properties object passed to the 
 <A HREF="../../javax/sip/SipFactory.html#createSipStack(java.util.Properties)"><CODE>SipFactory.createSipStack(Properties)</CODE></A> method upon creation of 
 the SipStack object then this becomes the default IP address of the 
 SipStack object, ListeningPoints can then be created on this IP Address.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a string identifing the IP Address. Null if there is no default 
 IP address associated with the stack instance.</DL>
</DD>
</DL>
<HR>

<A NAME="getRouter()"><!-- --></A><H3>
getRouter</H3>
<PRE>
<A HREF="../../javax/sip/address/Router.html" title="interface in javax.sip.address">Router</A> <B>getRouter</B>()</PRE>
<DL>
<DD>Gets the Router object that identifies the default Router information of
 this SipStack. This value is set using the Properties object passed to
 the <A HREF="../../javax/sip/SipFactory.html#createSipStack(java.util.Properties)"><CODE>SipFactory.createSipStack(Properties)</CODE></A>method upon creation of
 the SipStack object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the Router object identifying the Router information.</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
void <B>stop</B>()</PRE>
<DL>
<DD>This methods initiates the shutdown of the stack. The stack will 
 terminate all ongoing transactions, without providing
 notificatin to the listener, close all listening points and release all
 resources associated with this stack. Note that this is a hard stop and
 should be used with care. The application may build graceful stop 
 measures if needed, however the implementation is expected to
 immediately release any resources such as threads sockets and buffers
 that are allocated to this stack.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
  <DD>1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
void <B>start</B>()
           throws <A HREF="../../javax/sip/SipException.html" title="class in javax.sip">SipException</A></PRE>
<DL>
<DD>This method initiates the active processing of the stack. This method is 
 used to start the stack. After calling this method, the stack can handle 
 incoming requests and responses on the ListeningPoints associated to the 
 SipProviders.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/SipException.html" title="class in javax.sip">SipException</A></CODE> - if the stack cannot be started due to some system 
 level failure.<DT><B>Since:</B></DT>
  <DD>1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="isRetransmissionFilterActive()"><!-- --></A><H3>
isRetransmissionFilterActive</H3>
<PRE>
boolean <B>isRetransmissionFilterActive</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since v1.2. This retransmission filter property has been deprecated 
 as a SIP Stack property. Applications can enable retransmission alerts by using the 
 <A HREF="../../javax/sip/ServerTransaction.html#enableRetransmissionAlerts()"><CODE>ServerTransaction.enableRetransmissionAlerts()</CODE></A> method.</I>
<P>
<DD>This method returns the value of the retransmission filter helper
 function for User Agent applications. This value is set using the
 Properties object passed to the
 <A HREF="../../javax/sip/SipFactory.html#createSipStack(java.util.Properties)"><CODE>SipFactory.createSipStack(Properties)</CODE></A>method upon creation of the
 SipStack object.
 <p>
 The default value of the retransmission filter boolean is <var>false
 </var>. When this value is set to <code>true</code>, retransmissions
 of ACK's and 2xx responses to an INVITE transaction are handled by the
 SipProvider, hence the application will not receive
 <A HREF="../../javax/sip/Timeout.html#RETRANSMIT"><CODE>Timeout.RETRANSMIT</CODE></A>notifications encapsulated in
 <A HREF="../../javax/sip/TimeoutEvent.html" title="class in javax.sip"><CODE>TimeoutEvent</CODE></A>'s, however an application will be
 notified if the underlying transaction expires with a
 <A HREF="../../javax/sip/Timeout.html#TRANSACTION"><CODE>Timeout.TRANSACTION</CODE></A>notification encapsulated in a TimeoutEvent.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the value of the retransmission filter, <code>true</code> if
         the filter is set, <code>false</code> otherwise.</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>JSIP API v1.2<br><font size=-1>November 2006</font></b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../javax/sip/SipProvider.html" title="interface in javax.sip"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../javax/sip/Timeout.html" title="class in javax.sip"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html?javax/sip/SipStack.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="SipStack.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<center>If you have any comments, please mail them to <a href=mailto:[e-mail]>[e-mail]</a> after subscribing at <a href=http://archives.java.sun.com>http://archives.java.sun.com</a><br><a href=../../copyright.html>Copyright</a> - 2006 BEA Systems and Sun Microsystems</center>
</BODY>
</HTML>