📄 sipstack.html
字号:
CONFIRMED state.</li> </ul> </ul> <blockquote>The ability to turn of dialog support is motivated by dialog free servers (such as proxy servers) that do not want to pay the overhead of the dialog layer and user agents that may want to create multiple dialogs for a single INVITE (as a result of forking by proxy servers). The following behavior is defined when the configuration parameter is set to 'OFF'. <ul type="circle"> <li>The application is responsible to create the Dialog if desired.</li> <li>The application may create a Dialog and associate it with a response (provisional or final) of a dialog creating request. </li> </ul> </blockquote> <b>Since v1.2.</b> </td> </tr> <tr> <td align="left" valign="top"> <p class="table"> javax.sip.FORKABLE_EVENTS </p> </td> <td align="left" valign="top"> <p class="table"> Comma separated list of events for which the implementation should expect forked SUBSCRIBE dialogs. Each element of this list must have the syntax packagename.eventname This configuration parameter is provided in order to support the following behavior ( defined in RFC 3265): Successful SUBSCRIBE requests will normally receive only one 200-class response; however, due to forking, the subscription may have been accepted by multiple nodes. The subscriber MUST therefore be prepared to receive NOTIFY requests with "From:" tags which differ from the "To:" tag received in the SUBSCRIBE 200-class response. If multiple NOTIFY messages are received in different dialogs in response to a single SUBSCRIBE message, each dialog represents a different destination to which the SUBSCRIBE request was forked. Each event package MUST specify whether forked SUBSCRIBE requests are allowed to install multiple subscriptions.If such behavior is not allowed, the first potential dialog-establishing message will create a dialog. All subsequent NOTIFY messages which correspond to the SUBSCRIBE message (i.e., match "To","From", "From" header "tag" parameter, "Call-ID", "CSeq", "Event", and "Event" header "id" parameter) but which do not match the dialog would be rejected with a 481 response. This property is optional. <p> <b>Since v1.2</b> </p> </td> </tr> <tr> <td align="left" valign="top"> <p class="table"> javax.sip.USE_ROUTER_FOR_ALL_URIS </p> </td> <td align="left" valign="top"> <p class="table"> If set to <it>true</it> then the application installed Router is consulted for ALL routing decisions (ie. both out of dialog SIP and non-SIP request URI's -- identitcal to the behavior supported in v1.1 of this specification). If set to <it>false</it> the user installed router will only be consulted for routing of Non-SIP URIs. Implementations may thus provide support for sophisticated operations such as DNS lookup for SIP URI's using the proceedures defined in RFC 3263 (support for RFC 3263 is not mandatory for this specification). This property is optional. The default value for this parameter is <it>true</it>. <p> <b>Since v1.2.</b> </td> </tr> </table> </center>
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>BEA Systems, NIST</DD>
<DT><B>See Also:</B><DD><A HREF="../../javax/sip/SipFactory.html" title="class in javax.sip"><CODE>SipFactory</CODE></A>,
<A HREF="../../javax/sip/SipProvider.html" title="interface in javax.sip"><CODE>SipProvider</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#createListeningPoint(int, java.lang.String)">createListeningPoint</A></B>(int port,
java.lang.String transport)</CODE>
<BR>
<B>Deprecated.</B> <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></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#createListeningPoint(java.lang.String, int, java.lang.String)">createListeningPoint</A></B>(java.lang.String ipAddress,
int port,
java.lang.String transport)</CODE>
<BR>
Creates a ListeningPoint a given IP address, port and transport.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/sip/SipProvider.html" title="interface in javax.sip">SipProvider</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#createSipProvider(javax.sip.ListeningPoint)">createSipProvider</A></B>(<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A> listeningPoint)</CODE>
<BR>
Creates a new peer SipProvider on this SipStack on a specified ListeningPoint and returns a reference to the newly created SipProvider object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#deleteListeningPoint(javax.sip.ListeningPoint)">deleteListeningPoint</A></B>(<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A> listeningPoint)</CODE>
<BR>
Deletes the specified ListeningPoint attached to this SipStack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#deleteSipProvider(javax.sip.SipProvider)">deleteSipProvider</A></B>(<A HREF="../../javax/sip/SipProvider.html" title="interface in javax.sip">SipProvider</A> sipProvider)</CODE>
<BR>
Deletes the specified peer SipProvider attached to this SipStack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#getIPAddress()">getIPAddress</A></B>()</CODE>
<BR>
Gets the IP Address that identifies this SipStack instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Iterator</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#getListeningPoints()">getListeningPoints</A></B>()</CODE>
<BR>
Returns an Iterator of existing ListeningPoints created by this SipStack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/sip/address/Router.html" title="interface in javax.sip.address">Router</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#getRouter()">getRouter</A></B>()</CODE>
<BR>
Gets the Router object that identifies the default Router information of this SipStack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Iterator</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#getSipProviders()">getSipProviders</A></B>()</CODE>
<BR>
Returns an Iterator of existing SipProviders that have been created by this SipStack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#getStackName()">getStackName</A></B>()</CODE>
<BR>
Gets the user friendly name that identifies this SipStack instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#isRetransmissionFilterActive()">isRetransmissionFilterActive</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <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></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#start()">start</A></B>()</CODE>
<BR>
This method initiates the active processing of the stack.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/sip/SipStack.html#stop()">stop</A></B>()</CODE>
<BR>
This methods initiates the shutdown of the stack.</TD>
</TR>
</TABLE>
<P>
<!-- ============ 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="createSipProvider(javax.sip.ListeningPoint)"><!-- --></A><H3>
createSipProvider</H3>
<PRE>
<A HREF="../../javax/sip/SipProvider.html" title="interface in javax.sip">SipProvider</A> <B>createSipProvider</B>(<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A> listeningPoint)
throws <A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></PRE>
<DL>
<DD>Creates a new peer SipProvider on this SipStack on a specified ListeningPoint and returns a reference to the newly created SipProvider object. The newly created SipProvider is implicitly attached to this SipListener upon execution of this method, by adding the SipProvider to the list of SipProviders of this SipStack once it has been successfully created.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listeningPoint</CODE> - listening point for this SipProvider.
<DT><B>Returns:</B><DD>the newly created SipProvider been started.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></CODE> - if another SipProvider is already associated with this ListeningPoint.</DL>
</DD>
</DL>
<HR>
<A NAME="deleteSipProvider(javax.sip.SipProvider)"><!-- --></A><H3>
deleteSipProvider</H3>
<PRE>
void <B>deleteSipProvider</B>(<A HREF="../../javax/sip/SipProvider.html" title="interface in javax.sip">SipProvider</A> sipProvider)
throws <A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></PRE>
<DL>
<DD>Deletes the specified peer SipProvider attached to this SipStack. The specified SipProvider is implicitly detached from this SipStack upon execution of this method, by removing the SipProvider from the SipProviders list of this SipStack. Deletion of a SipProvider does not automatically delete the SipProvider's ListeningPoint from the SipStack.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sipProvider</CODE> - the peer 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 SipProvider cannot be deleted because the SipProvider is currently in use.</DL>
</DD>
</DL>
<HR>
<A NAME="getSipProviders()"><!-- --></A><H3>
getSipProviders</H3>
<PRE>
java.util.Iterator <B>getSipProviders</B>()</PRE>
<DL>
<DD>Returns an Iterator of existing SipProviders that have been created by this SipStack. All of the SipProviders of this SipStack will belong to the same stack vendor.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the list of Providers attached to this Sipstack.</DL>
</DD>
</DL>
<HR>
<A NAME="createListeningPoint(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>(int port,
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -