dialog.html

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

<DL>
<DD>Sends ACK Request to the remote party of this dialog. This method implies
 that the application is functioning as User Agent Client hence the
 underlying SipProvider acts statefully. This method does not increment
 the local sequence number.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ackRequest</CODE> - -
            the new ACK Request message to send.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/SipException.html" title="class in javax.sip">SipException</A></CODE> - if implementation cannot send the ACK Request for any reason</DL>
</DD>
</DL>
<HR>

<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
<A HREF="../../javax/sip/DialogState.html" title="class in javax.sip">DialogState</A> <B>getState</B>()</PRE>
<DL>
<DD>Returns the current DialogState of the dialog or null. A dialog that is
 created but not yet mapped to any state must return null, multiple
 requests can be generated on the Dialog in a null state. The dialog
 states for INVITE transaction are:
 <ul>
 <li> Early - A dialog is in the "early" state, which occurs when it is
 created when a provisional response is recieved to the INVITE Request.
 <li> Confirmed - A dialog transitions to the "confirmed" state when a 2xx
 final response is received to the INVITE Request.
 <li> Terminated - A dialog transitions to the "terminated" state for all
 other reasons or if no response arrives at all on the dialog.
 </ul>
 
 A Subscibe/Refer dialog has the following states:
 <ul>
 <li> Null - refers to a state that is not terminated.
 <li> Terminated - when the Application deletes the Dialog or if no
 response arrives at all.
 </ul>
 
 Independent of the method, if a request outside of a dialog generates a
 non-2xx final response, any early dialogs created through provisional
 responses to that request are "terminated". If no response arrives at all
 on the early dialog it is also "terminated".
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a DialogState determining the current state of the dialog.<DT><B>See Also:</B><DD><A HREF="../../javax/sip/DialogState.html" title="class in javax.sip"><CODE>DialogState</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="delete()"><!-- --></A><H3>
delete</H3>
<PRE>
void <B>delete</B>()</PRE>
<DL>
<DD>This method will release all resources associated with this dialog that
 are tracked by the SipProvider. Further references to the dialog by
 incoming messages will result in a mismatch. This delete method is
 provided methods that do not expect a BYE to terminate a dialog. Such is
 the case with SUBSCRIBE/NOTIFY within a Dialog that is created with an
 INIVTE.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFirstTransaction()"><!-- --></A><H3>
getFirstTransaction</H3>
<PRE>
<A HREF="../../javax/sip/Transaction.html" title="interface in javax.sip">Transaction</A> <B>getFirstTransaction</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since v1.2. Reduces the amount of state that 
 the stack needs to keep track of.</I>
<P>
<DD>This method retrieves the transaction which resulted in the creation of
 this Dialog. The transaction type either server or client can be
 determined based on whether this is a server or client Dialog, see
 <A HREF="../../javax/sip/Dialog.html#isServer()"><CODE>isServer()</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Transaction that created the Dialog.</DL>
</DD>
</DL>
<HR>

<A NAME="getLocalTag()"><!-- --></A><H3>
getLocalTag</H3>
<PRE>
java.lang.String <B>getLocalTag</B>()</PRE>
<DL>
<DD>Get the Local Tag of this Dialog. On the client side, this tag is
 assigned to outgoing From headers for Requests within the dialog and To
 headers for responses within the dialog. On the server side, this tag is
 associated with outgoing To headers for responses within the dialog.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getRemoteTag()"><!-- --></A><H3>
getRemoteTag</H3>
<PRE>
java.lang.String <B>getRemoteTag</B>()</PRE>
<DL>
<DD>Gets the Remote Tag of this Dialog. On the client side, this tag is
 associated with outgoing To headers for Requests within the dialog. On
 the server side, this tag is associated with incoming From headers for
 requests within the dialog.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setApplicationData(java.lang.Object)"><!-- --></A><H3>
setApplicationData</H3>
<PRE>
void <B>setApplicationData</B>(java.lang.Object&nbsp;applicationData)</PRE>
<DL>
<DD>Sets application specific data to this dialog. This specification does
 not define the format of this data. This is the responsibility of the
 application and is dependent upon the application. This method can be
 used to link the call state of this dialog to other state, SIP or
 otherwise in the system. For example this method could be used by a
 SIP-to-H323 interworking node that would associate the H323 call state
 associated with a call on the H323 side with this dialog that represents
 this call on the SIP side. Or a dialog stateful proxy can associate the
 UAS dialog to the UAC dialog and vice versa.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>applicationData</CODE> - the new object containing application specific data.</DL>
</DD>
</DL>
<HR>

<A NAME="getApplicationData()"><!-- --></A><H3>
getApplicationData</H3>
<PRE>
java.lang.Object <B>getApplicationData</B>()</PRE>
<DL>
<DD>Gets the application specific data specific to this dialog. This
 specification does not define the format of this application specific
 data. This is the responsibility of the application.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the object representation of the application specific data.</DL>
</DD>
</DL>
<HR>

<A NAME="terminateOnBye(boolean)"><!-- --></A><H3>
terminateOnBye</H3>
<PRE>
void <B>terminateOnBye</B>(boolean&nbsp;terminateFlag)
                    throws <A HREF="../../javax/sip/SipException.html" title="class in javax.sip">SipException</A></PRE>
<DL>
<DD>Terminate Dialog on BYE. If this flag is set to true then the stack will
 Terminate the dialog automatically when BYE is received. This is the
 default behavior. This method is useful for SUBSCRIBE/NOTIFY processing
 within a Dialog. In the case that several subscriptions are associated
 with a single Dialog, the Dialog does not terminate until all the
 subscriptions in it are destroyed. Hence, if the application is aware of
 active subscriptions in a dialog it should set this flag to false. In
 this case when BYE is received the dialog will not be terminated and it
 will be the application抯 responsibility to call the
 <A HREF="../../javax/sip/Dialog.html#delete()"><CODE>delete()</CODE></A> function when all active subscriptions are
 terminated.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>terminateFlag</CODE> - --
            if true then the dialog is terminated when a BYE is received.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/SipException.html" title="class in javax.sip">SipException</A></CODE> - --
            if the dialog is already terminated.<DT><B>Since:</B></DT>
  <DD>1.2</DD>
</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/ClientTransaction.html" title="interface in javax.sip"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../javax/sip/DialogDoesNotExistException.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/Dialog.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Dialog.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>