Changeset 2942 for pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

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

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (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;
 
     /**