dialog.html

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

 the Contact header of received Responses for target refresh Requests in
 this dialog when acting as an User Agent Client.
 <p>
 This is the value of the Contact header of received target refresh
 Requests Requests in this dialog when acting as an User Agent Server.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the address object of the remote target.</DL>
</DD>
</DL>
<HR>

<A NAME="getDialogId()"><!-- --></A><H3>
getDialogId</H3>
<PRE>
java.lang.String <B>getDialogId</B>()</PRE>
<DL>
<DD>Get the dialog identifier of this dialog. A dialog Id is associated with
 all responses and with any request that contains a tag in the To field.
 The rules for computing the dialog Id of a message depends on whether the
 SIP element is a User Agent Client or User Agent Server and applies to
 both requests and responses.
 <ul>
 <li>User Agent Client - the Call-Id value of the dialog Id is set to the
 Call-Id of the message, the remote tag is set to the tag in the To field
 of the message, and the local tag is set to the tag in the From field of
 the message.
 <li>User Agent Server - the Call-Id value of the dialog Id is set to the
 Call-Id of the message, the remote tag is set to the tag in the From
 field of the message, and the local tag is set to the tag in the To field
 of the message.
 </ul>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the string identifier for this dialog.</DL>
</DD>
</DL>
<HR>

<A NAME="getCallId()"><!-- --></A><H3>
getCallId</H3>
<PRE>
<A HREF="../../javax/sip/header/CallIdHeader.html" title="interface in javax.sip.header">CallIdHeader</A> <B>getCallId</B>()</PRE>
<DL>
<DD>Returns the Call-Id for this dialog. This is the value of the Call-Id
 header for all messages belonging to this session.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Call-Id for this dialog</DL>
</DD>
</DL>
<HR>

<A NAME="getLocalSequenceNumber()"><!-- --></A><H3>
getLocalSequenceNumber</H3>
<PRE>
int <B>getLocalSequenceNumber</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>This method is replaced with <A HREF="../../javax/sip/Dialog.html#getLocalSeqNumber()"><CODE>getLocalSeqNumber()</CODE></A> with 
 type long.</I>
<P>
<DD>The local sequence number is used to order requests from this User Agent
 Client to its peer User Agent Server. The local sequence number MUST be
 set to the value of the sequence number in the CSeq header field of the
 request. The remote sequence number MUST be empty as it is established
 when the remote User Agent sends a request within the dialog.
 <p>
 Requests within a dialog MUST contain strictly monotonically increasing
 and contiguous CSeq sequence numbers (increasing-by-one) in each
 direction (excepting ACK and CANCEL, whose numbers equal the requests
 being acknowledged or cancelled). Therefore, if the local sequence number
 is not empty, the value of the local sequence number MUST be incremented
 by one, and this value MUST be placed into the CSeq header field. If the
 local sequence number is empty, an initial value MUST be chosen.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the integer value of the local sequence number, returns zero if
         not set.<DT><B>See Also:</B><DD><A HREF="../../javax/sip/Dialog.html#getLocalSeqNumber()"><CODE>getLocalSeqNumber()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getLocalSeqNumber()"><!-- --></A><H3>
getLocalSeqNumber</H3>
<PRE>
long <B>getLocalSeqNumber</B>()</PRE>
<DL>
<DD>The local sequence number is used to order requests from this User Agent
 Client to its peer User Agent Server. The local sequence number MUST be
 set to the value of the sequence number in the CSeq header field of the
 request. The remote sequence number MUST be empty as it is established
 when the remote User Agent sends a request within the dialog.
 <p>
 Requests within a dialog MUST contain strictly monotonically increasing
 and contiguous CSeq sequence numbers (increasing-by-one) in each
 direction (excepting ACK and CANCEL, whose numbers equal the requests
 being acknowledged or cancelled). Therefore, if the local sequence number
 is not empty, the value of the local sequence number MUST be incremented
 by one, and this value MUST be placed into the CSeq header field. If the
 local sequence number is empty, an initial value MUST be chosen.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the value of the local sequence number, returns zero if
         not set.<DT><B>Since:</B></DT>
  <DD>v1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getRemoteSequenceNumber()"><!-- --></A><H3>
getRemoteSequenceNumber</H3>
<PRE>
int <B>getRemoteSequenceNumber</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>This method is replaced with <A HREF="../../javax/sip/Dialog.html#getRemoteSeqNumber()"><CODE>getRemoteSeqNumber()</CODE></A> with 
 type long.</I>
<P>
<DD>The remote sequence number is used to order requests from its peer User
 Agent Client to this User Agent Server. When acting an User Agent Server
 the remote sequence number MUST be set to the value of the sequence
 number in the CSeq header field of the request from the User Agent
 Client. The local sequence number MUST be empty.
 <p>
 If the remote sequence number is empty, it MUST be set to the value of
 the sequence number in the CSeq header field value in the request. If the
 remote sequence number was not empty, but the sequence number of the
 request is lower than the remote sequence number, the request is out of
 order and MUST be rejected with a 500 (Server Internal Error) response.
 If the remote sequence number was not empty, and the sequence number of
 the request is greater than the remote sequence number, the request is in
 order.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the integer value of the remote sequence number, return zero if
         not set.<DT><B>See Also:</B><DD><A HREF="../../javax/sip/Dialog.html#getRemoteSeqNumber()"><CODE>getRemoteSeqNumber()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getRemoteSeqNumber()"><!-- --></A><H3>
getRemoteSeqNumber</H3>
<PRE>
long <B>getRemoteSeqNumber</B>()</PRE>
<DL>
<DD>The remote sequence number is used to order requests from its peer User
 Agent Client to this User Agent Server. When acting an User Agent Server
 the remote sequence number MUST be set to the value of the sequence
 number in the CSeq header field of the request from the User Agent
 Client. The local sequence number MUST be empty.
 <p>
 If the remote sequence number is empty, it MUST be set to the value of
 the sequence number in the CSeq header field value in the request. If the
 remote sequence number was not empty, but the sequence number of the
 request is lower than the remote sequence number, the request is out of
 order and MUST be rejected with a 500 (Server Internal Error) response.
 If the remote sequence number was not empty, and the sequence number of
 the request is greater than the remote sequence number, the request is in
 order.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the value of the remote sequence number, return zero if
         not set.<DT><B>Since:</B></DT>
  <DD>v1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getRouteSet()"><!-- --></A><H3>
getRouteSet</H3>
<PRE>
java.util.Iterator <B>getRouteSet</B>()</PRE>
<DL>
<DD>When acting as an User Agent Server the routeset MUST be set to the list
 of URIs in the Record-Route header field from the request, taken in order
 and preserving all URI parameters. When acting as an User Agent Client
 the route set MUST be set to the list of URIs in the Record-Route header
 field from the response, taken in reverse order and preserving all URI
 parameters. If no Record-Route header field is present in the request or
 response, the route set MUST be set to the empty set. This route set,
 even if empty, overrides any pre-existing route set for future requests
 in this dialog.
 <p>
 Requests within a dialog MAY contain Record-Route and Contact header
 fields. However, these requests do not cause the dialog's route set to be
 modified.
 <p>
 The User Agent Client uses the remote target and route set to build the
 Request-URI and Route header field of the request.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an Iterator over a list of route headers to be used for
         forwarding.</DL>
</DD>
</DL>
<HR>

<A NAME="isSecure()"><!-- --></A><H3>
isSecure</H3>
<PRE>
boolean <B>isSecure</B>()</PRE>
<DL>
<DD>Returns true if this Dialog is secure, for example if the request was sent over a
 "sips:" scheme, or a "sip:" scheme over TLS.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if this dialog was secure, and
         <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="isServer()"><!-- --></A><H3>
isServer</H3>
<PRE>
boolean <B>isServer</B>()</PRE>
<DL>
<DD>Returns whether this Dialog is a server dialog, for example this side 
 was initially acting as a UAS.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if this is a server dialog and
         <code>false</code> if it is a client dialog.</DL>
</DD>
</DL>
<HR>

<A NAME="incrementLocalSequenceNumber()"><!-- --></A><H3>
incrementLocalSequenceNumber</H3>
<PRE>
void <B>incrementLocalSequenceNumber</B>()</PRE>
<DL>
<DD>This method may be used to increment the local sequence number of the
 dialog when an application wishes to switch from dialog stateful mode to
 transaction stateful mode for client transactions and back again to
 dialog stateful mode. Note, the Dialog layer automatically increments the
 local sequence number when a request is sent out via the Dialog. However
 in special circumstances applications may wish to send a request (from a