Changeset 2646 for pjproject

Timestamp:

Apr 26, 2009 11:02:04 AM (16 years ago)

Author:

bennylp

Message:

Fixed ticket #503: Handle the case when CANCEL is responded with 200/OK but 487 is not sent

• added new API pjsip_tsx_set_timeout()
• set 64*T1 timeout after CANCEL is initiated
• also added SIPp scenario to simulate the UAS

Location:

pjproject/trunk

Files:

• pjsip/include/pjsip/sip_transaction.h (modified) (2 diffs)
• pjsip/src/pjsip-ua/sip_inv.c (modified) (1 diff)
• pjsip/src/pjsip/sip_transaction.c (modified) (1 diff)
• tests/pjsua/scripts-sipp/uas-cancel-no-final.xml (added)

pjproject/trunk/pjsip/include/pjsip/sip_transaction.h

@@ -312 +312 @@
                                            const pjsip_rx_data *rdata );
 
-
 /**
  * Force terminate transaction.
@@ -331 +330 @@
  * the transaction is cancelled before any provisional response has been
  * received.
+ *
+ * @param tsx       The transaction.
+ *
+ * @return          PJ_SUCCESS or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjsip_tsx_stop_retransmit(pjsip_transaction *tsx);
+
+
+/**
+ * Start a timer to terminate transaction after the specified time
+ * has elapsed. This function is only valid for INVITE transaction,
+ * and only before final response is received for the INVITE transaction.
+ * It is normally called after the UAC has sent CANCEL for this
+ * INVITE transaction. 
+ *
+ * The purpose of this function is to terminate the transaction if UAS 
+ * does not send final response to this INVITE transaction even after 
+ * it sends 200/OK to CANCEL (for example when the UAS complies to RFC
+ * 2543).
+ *
+ * Once this timer is set, the transaction will be terminated either when
+ * a final response is received or the timer expires.
+ *
+ * @param tsx       The transaction.
+ * @param millisec  Timeout value in milliseconds.
+ *
+ * @return          PJ_SUCCESS or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pjsip_tsx_set_timeout(pjsip_transaction *tsx,
+                                           unsigned millisec);
 
 

pjproject/trunk/pjsip/src/pjsip-ua/sip_inv.c

@@ -1887 +1887 @@
                                                inv->invite_tsx->last_tx,
                                                &tdata);
+            if (status != PJ_SUCCESS)
+                return status;
+
+            /* Set timeout for the INVITE transaction, in case UAS is not
+             * able to respond the INVITE with 487 final response. The 
+             * timeout value is 64*T1.
+             */
+            pjsip_tsx_set_timeout(inv->invite_tsx, 64 * pjsip_cfg()->tsx.t1);
 
         } else {

pjproject/trunk/pjsip/src/pjsip/sip_transaction.c

@@ -1504 +1504 @@
 
 /*
+ * Start a timer to terminate transaction after the specified time
+ * has elapsed. 
+ */
+PJ_DEF(pj_status_t) pjsip_tsx_set_timeout( pjsip_transaction *tsx,
+                                           unsigned millisec)
+{
+    struct tsx_lock_data lck;
+    pj_time_val timeout;
+
+    PJ_ASSERT_RETURN(tsx != NULL, PJ_EINVAL);
+    PJ_ASSERT_RETURN(tsx->role == PJSIP_ROLE_UAC &&
+                     tsx->method.id == PJSIP_INVITE_METHOD,
+                     PJ_EINVALIDOP);
+
+    lock_tsx(tsx, &lck);
+
+    /* Transaction must not have got final response */
+    PJ_ASSERT_ON_FAIL(tsx->status_code < 200,
+                    { unlock_tsx(tsx, &lck); return PJ_EINVALIDOP; });
+
+    if (tsx->timeout_timer.id != 0) {
+        pjsip_endpt_cancel_timer(tsx->endpt, &tsx->timeout_timer);
+        tsx->timeout_timer.id = 0;
+    }
+
+    timeout.sec = 0;
+    timeout.msec = millisec;
+    pj_time_val_normalize(&timeout);
+
+    tsx->timeout_timer.id = TIMER_ACTIVE;
+    pjsip_endpt_schedule_timer(tsx->endpt, &tsx->timeout_timer,
+                               &timeout);
+
+
+    unlock_tsx(tsx, &lck);
+
+    return PJ_SUCCESS;
+}
+
+
+/*
  * This function is called by TU to send a message.
  */