transaction.html

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

<DT><B>Returns:</B><DD>the dialog object of this transaction object or null if no 
 dialog exists.<DT><B>See Also:</B><DD><A HREF="../../javax/sip/Dialog.html" title="interface in javax.sip"><CODE>Dialog</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
<A HREF="../../javax/sip/TransactionState.html" title="class in javax.sip">TransactionState</A> <B>getState</B>()</PRE>
<DL>
<DD>Returns the current state of the transaction. Returns the current 
 TransactionState of this Transaction or null if a ClientTransaction has 
 yet been used to send a message.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a TransactionState object determining the current state of the 
 transaction.</DL>
</DD>
</DL>
<HR>

<A NAME="getRetransmitTimer()"><!-- --></A><H3>
getRetransmitTimer</H3>
<PRE>
int <B>getRetransmitTimer</B>()
                       throws java.lang.UnsupportedOperationException</PRE>
<DL>
<DD>Returns the current value of the retransmit timer in milliseconds used 
 to retransmit messages over unreliable transports for this transaction.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the integer value of the retransmit timer in milliseconds.
<DT><B>Throws:</B>
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if this method is not supported
 by the underlying implementation.</DL>
</DD>
</DL>
<HR>

<A NAME="setRetransmitTimer(int)"><!-- --></A><H3>
setRetransmitTimer</H3>
<PRE>
void <B>setRetransmitTimer</B>(int&nbsp;retransmitTimer)
                        throws java.lang.UnsupportedOperationException</PRE>
<DL>
<DD>Sets the value of the retransmit timer to the newly supplied timer value. 
 The retransmit timer is expressed in milliseconds and its default value 
 is 500ms. This method allows the application to change the transaction 
 retransmit behavior for different networks. For example the gateway proxy,  
 the internal intranet is likely to be relatively uncongested 
 and the endpoints will be relatively close. The external network is the 
 general Internet. This functionality allows different retransmit times 
 for either side.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>retransmitTimer</CODE> - - the new integer value of the retransmit timer 
 in milliseconds.
<DT><B>Throws:</B>
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if this method is not supported
 by the underlying implementation.</DL>
</DD>
</DL>
<HR>

<A NAME="getBranchId()"><!-- --></A><H3>
getBranchId</H3>
<PRE>
java.lang.String <B>getBranchId</B>()</PRE>
<DL>
<DD>Returns a unique branch identifer that identifies this transaction. The
 branch identifier is used in the ViaHeader. The uniqueness property of 
 the branch ID parameter to facilitate its use as a transaction ID, was 
 not part of RFC 2543. The branch ID inserted by an element compliant 
 with the RFC3261 specification MUST always begin with the characters 
 "z9hG4bK". These 7 characters are used as a magic cookie, so that 
 servers receiving the request can determine that the branch ID was 
 constructed to be globally unique. The precise format of the branch 
 token is implementation-defined. This method should always return the 
 same branch identifier for the same transaction.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the new branch that uniquely identifies this transaction.</DL>
</DD>
</DL>
<HR>

<A NAME="getRequest()"><!-- --></A><H3>
getRequest</H3>
<PRE>
<A HREF="../../javax/sip/message/Request.html" title="interface in javax.sip.message">Request</A> <B>getRequest</B>()</PRE>
<DL>
<DD>Returns the request that created this transaction. The transaction state 
 machine needs to keep the Request that resulted in the creation of this 
 transaction while the transaction is still alive. Applications also need 
 to access this information, e.g. a forking proxy server may wish to 
 retrieve the original Invite request to cancel branches of a fork when 
 a final Response has been received by one branch.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Request message that created this transaction.</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>This method allows applications to associate application context with 
 the transaction. This specification does not define the format of this 
 data, this the responsibility of the application and is dependent 
 on the application. This capability may be useful for proxy servers 
 to associate the transaction to some application state. The context of 
 this application data is un-interpreted by the stack.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>applicationData</CODE> - - un-interpreted application data.<DT><B>Since:</B></DT>
  <DD>v1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getApplicationData()"><!-- --></A><H3>
getApplicationData</H3>
<PRE>
java.lang.Object <B>getApplicationData</B>()</PRE>
<DL>
<DD>Returns the application data associated with the transaction.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>application data associated with the transaction by the application.<DT><B>Since:</B></DT>
  <DD>v1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="terminate()"><!-- --></A><H3>
terminate</H3>
<PRE>
void <B>terminate</B>()
               throws <A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></PRE>
<DL>
<DD>Terminate this transaction and immediately release all stack resources 
 associated with it. When a transaction is terminated using this method, 
 a transaction terminated event is sent to the listener. If the 
 transaction is already associated with a dialog, it cannot be terminated 
 using this method. Instead, the dialog should be deleted to remove the 
 transaction.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></CODE> - if the transaction cannot be terminated as 
 it is associated to a dialog.<DT><B>Since:</B></DT>
  <DD>v1.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/TimeoutEvent.html" title="class in javax.sip"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../javax/sip/TransactionAlreadyExistsException.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/Transaction.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Transaction.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>