Changeset 5241 for pjproject/trunk/pjsip/include/pjsip/sip_dialog.h

Timestamp:

Feb 5, 2016 4:29:17 AM (9 years ago)

Author:

nanang

Message:

Fixed #1902:

• Crash when endpoint has multiple worker threads and SIP TCP transport is disconnected during incoming call handling.
• Deprecated pjsip_dlg_create_uas(), replaced by pjsip_dlg_create_uas_and_inc_lock().
• Serialized transaction state notifications (of 'terminated' and 'destroyed') in case of transport error.

File:

• pjproject/trunk/pjsip/include/pjsip/sip_dialog.h (modified) (4 diffs)

pjproject/trunk/pjsip/include/pjsip/sip_dialog.h

@@ -61 +61 @@
 PJ_BEGIN_DECL
 
+
+/* Deprecated API pjsip_dlg_create_uas() due to a fatal bug of possible
+ * premature dialog destroy. Application should not change this setting,
+ * unless it uses single worker thread.
+ * See also https://trac.pjsip.org/repos/ticket/1902.
+ */
+#ifndef DEPRECATED_FOR_TICKET_1902
+#  define DEPRECATED_FOR_TICKET_1902      1
+#endif
 
 /**
@@ -241 +250 @@
 
 
+#if !DEPRECATED_FOR_TICKET_1902
 /**
  * Initialize UAS dialog from the information found in the incoming request 
@@ -280 +290 @@
                                             const pj_str_t *contact,
                                             pjsip_dialog **p_dlg);
+#endif
+
+
+/**
+ * Initialize UAS dialog from the information found in the incoming request 
+ * that creates a dialog (such as INVITE, REFER, or SUBSCRIBE), and set the 
+ * local Contact to contact. If contact is not specified, the local contact 
+ * is initialized from the URI in the To header in the request. 
+ *
+ * This function will also create UAS transaction for the incoming request,
+ * and associate the transaction to the rdata. Application can query the
+ * transaction used to handle this request by calling #pjsip_rdata_get_tsx()
+ * after this function returns.
+ *
+ * Note that initially, the session count in the dialog will be initialized 
+ * to 1 (one), and the dialog is locked. Application needs to explicitly call
+ * #pjsip_dlg_dec_lock() to release the lock and decrease the session count.
+ *
+ *
+ * @param ua                The user agent module instance.
+ * @param rdata             The incoming request that creates the dialog,
+ *                          such as INVITE, SUBSCRIBE, or REFER.
+ * @param contact           Optional dialog local Contact to be put as Contact
+ *                          header value, hence the format must follow
+ *                          RFC 3261 Section 20.10:
+ *                          When the header field value contains a display 
+ *                          name, the URI including all URI parameters is 
+ *                          enclosed in "<" and ">".  If no "<" and ">" are 
+ *                          present, all parameters after the URI are header
+ *                          parameters, not URI parameters.  The display name 
+ *                          can be tokens, or a quoted string, if a larger 
+ *                          character set is desired.
+ *                          If this argument is NULL, the local contact will be
+ *                          initialized from the value of To header in the
+ *                          request.
+ * @param p_dlg             Pointer to receive the dialog.
+ *
+ * @return                  PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t)
+pjsip_dlg_create_uas_and_inc_lock(    pjsip_user_agent *ua,
+                                      pjsip_rx_data *rdata,
+                                      const pj_str_t *contact,
+                                      pjsip_dialog **p_dlg);
 
 
@@ -362 +416 @@
  * established, the route set can not be changed.
  *
- * For UAS dialog,the route set will be initialized in pjsip_dlg_create_uas()
- * from the Record-Route headers in the incoming request.
+ * For UAS dialog, the route set will be initialized in
+ * pjsip_dlg_create_uas_and_inc_lock() from the Record-Route headers in
+ * the incoming request.
  *
  * The route_set argument is standard list of Route headers (i.e. with