Changeset 2942

Timestamp:

Oct 13, 2009 2:01:59 PM (15 years ago)

Author:

bennylp

Message:

Ticket #364: Upon unregistration, (un)REGISTER should be sent only after (un)PUBLISH has completed successfully

• wait for unpublication to complete or some delay expires, before sending unregistration
• added unpublish_max_wait_time_msec field in account config to control how long to wait

Location:

pjproject/trunk/pjsip

Files:

• include/pjsua-lib/pjsua.h (modified) (2 diffs)
• src/pjsua-lib/pjsua_core.c (modified) (3 diffs)
• src/pjsua-lib/pjsua_pres.c (modified) (2 diffs)

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -1752 +1752 @@
 
 /**
+ * Maximum time to wait for unpublication transaction(s) to complete
+ * during shutdown process, before sending unregistration. The library
+ * tries to wait for the unpublication (un-PUBLISH) to complete before
+ * sending REGISTER request to unregister the account, during library
+ * shutdown process. If the value is set too short, it is possible that
+ * the unregistration is sent before unpublication completes, causing
+ * unpublication request to fail.
+ *
+ * Default: 2000 (2 seconds)
+ */
+#ifndef PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC
+#   define PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC   2000
+#endif
+
+
+/**
  * This structure describes account configuration to be specified when
  * adding a new account with #pjsua_acc_add(). Application MUST initialize
@@ -1801 +1817 @@
      */
     pjsip_publishc_opt  publish_opt;
+
+    /**
+     * Maximum time to wait for unpublication transaction(s) to complete
+     * during shutdown process, before sending unregistration. The library
+     * tries to wait for the unpublication (un-PUBLISH) to complete before
+     * sending REGISTER request to unregister the account, during library
+     * shutdown process. If the value is set too short, it is possible that
+     * the unregistration is sent before unpublication completes, causing
+     * unpublication request to fail.
+     *
+     * Default: PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC
+     */
+    unsigned        unpublish_max_wait_time_msec;
 
     /**

pjproject/trunk/pjsip/src/pjsua-lib/pjsua_core.c

@@ -163 +163 @@
     cfg->reg_timeout = PJSUA_REG_INTERVAL;
     pjsip_publishc_opt_default(&cfg->publish_opt);
+    cfg->unpublish_max_wait_time_msec = PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC;
     cfg->transport_id = PJSUA_INVALID_ID;
     cfg->allow_contact_rewrite = PJ_TRUE;
@@ -1229 +1230 @@
     
     if (pjsua_var.endpt) {
+        unsigned max_wait;
+
         /* Terminate all calls. */
         pjsua_call_hangup_all();
@@ -1242 +1245 @@
         /* Terminate all presence subscriptions. */
         pjsua_pres_shutdown();
+
+        /* Wait for sometime until all publish client sessions are done
+         * (ticket #364)
+         */
+        /* First stage, get the maximum wait time */
+        max_wait = 100;
+        for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.acc); ++i) {
+            if (!pjsua_var.acc[i].valid)
+                continue;
+            if (pjsua_var.acc[i].cfg.unpublish_max_wait_time_msec > max_wait)
+                max_wait = pjsua_var.acc[i].cfg.unpublish_max_wait_time_msec;
+        }
+        
+        /* Second stage, wait for unpublications to complete */
+        for (i=0; i<(int)(max_wait/50); ++i) {
+            unsigned j;
+            for (j=0; j<PJ_ARRAY_SIZE(pjsua_var.acc); ++j) {
+                if (!pjsua_var.acc[j].valid)
+                    continue;
+
+                if (pjsua_var.acc[j].publish_sess)
+                    break;
+            }
+            if (j != PJ_ARRAY_SIZE(pjsua_var.acc))
+                busy_sleep(50);
+            else
+                break;
+        }
+
+        /* Third stage, forcefully destroy unfinished unpublications */
+        for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.acc); ++i) {
+            if (pjsua_var.acc[i].publish_sess) {
+                pjsip_publishc_destroy(pjsua_var.acc[i].publish_sess);
+                pjsua_var.acc[i].publish_sess = NULL;
+            }
+        }
 
         /* Unregister all accounts */

pjproject/trunk/pjsip/src/pjsua-lib/pjsua_pres.c

@@ -993 +993 @@
 
     } else {
-        if (param->expiration == -1) {
+        if (param->expiration < 1) {
             /* Could happen if server "forgot" to include Expires header
              * in the response. We will not renew, so destroy the pubc.
@@ -1202 +1202 @@
         acc->online_status = PJ_FALSE;
         send_publish(acc_id, PJ_FALSE);
+        /* By ticket #364, don't destroy the session yet (let the callback
+           destroy it)
         if (acc->publish_sess) {
             pjsip_publishc_destroy(acc->publish_sess);
             acc->publish_sess = NULL;
         }
+        */
         acc_cfg->publish_enabled = PJ_FALSE;
     }