Changeset 2661

Timestamp:

Apr 28, 2009 10:19:49 PM (15 years ago)

Author:

bennylp

Message:

Ticket #760: Enhancements to PUBLISH management (thanks Johan Lantz for the suggestion)

• Changes in PJSUA-LIB
  • retry with fresh request on 412/Conditional Request Failed response
  • changed default Expires in PUBLISH request to none (we will not put Expires), to avoid getting 423/Interval Too Brief response
  • if the PUBLISH fails for any reason, it will be retried on every PJSUA_PRES_TIMER (default 300 seconds), similar to how failed SUBSCRIBE will be retried
• Changes to publish.h:
  • added API to add headers in every PUBLISH request
• Added test scenario in Python unit tests

Location:

pjproject/trunk

Files:

• pjsip/include/pjsip-simple/publish.h (modified) (2 diffs)
• pjsip/include/pjsua-lib/pjsua.h (modified) (2 diffs)
• pjsip/src/pjsip-simple/publishc.c (modified) (6 diffs)
• pjsip/src/pjsua-lib/pjsua_pres.c (modified) (5 diffs)
• tests/pjsua/scripts-recvfrom/240_publish_scenarios.py (added)

pjproject/trunk/pjsip/include/pjsip-simple/publish.h

@@ -79 +79 @@
     pj_str_t             reason;    /**< SIP reason phrase received.        */
     pjsip_rx_data       *rdata;     /**< The complete received response.    */
-    int                  expiration;/**< Next expiration interval.          */
+    int                  expiration;/**< Next expiration interval. If the
+                                         value is -1, it means the session
+                                         will not renew itself.             */
 };
 
@@ -191 +193 @@
 
 /**
+ * Set list of headers to be added to each PUBLISH request generated by
+ * the client publication session. Note that application can also add
+ * the headers to the request after calling #pjsip_publishc_publish()
+ * or #pjsip_publishc_unpublish(), but the benefit of this function is
+ * the headers will also be added to requests generated internally by
+ * the session, such as during session renewal/refresh.
+ *
+ * Note that calling this function will clear the previously added list
+ * of headers.
+ *
+ * @param pubc      The client publication structure.
+ * @param hdr_list  The list of headers.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_publishc_set_headers(pjsip_publishc *pubc,
+                                                const pjsip_hdr *hdr_list);
+
+/**
  * Create PUBLISH request for the specified client publication structure.
  * Application can use this function to both create initial publication

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

@@ -2038 +2038 @@
  */
 #ifndef PJSUA_PUBLISH_EXPIRATION
-#   define PJSUA_PUBLISH_EXPIRATION 600
+#   define PJSUA_PUBLISH_EXPIRATION PJSIP_PUBC_EXPIRATION_NOT_SPECIFIED
 #endif
 
@@ -3494 +3494 @@
 /**
  * This specifies how long the library should retry resending SUBSCRIBE
- * if the previous SUBSCRIBE failed.
+ * if the previous SUBSCRIBE failed. This also controls the duration 
+ * before failed PUBLISH request will be retried.
  *
  * Default: 300 seconds

pjproject/trunk/pjsip/src/pjsip-simple/publishc.c

@@ -82 +82 @@
     pj_uint32_t                  expires;
     pjsip_route_hdr              route_set;
+    pjsip_hdr                    usr_hdr;
 
     /* Authorization sessions. */
@@ -158 +159 @@
 
     pj_list_init(&pubc->route_set);
+    pj_list_init(&pubc->usr_hdr);
 
     /* Done */
@@ -187 +189 @@
 static void set_expires( pjsip_publishc *pubc, pj_uint32_t expires)
 {
-    if (expires != pubc->expires) {
+    if (expires != pubc->expires && 
+        expires != PJSIP_PUBC_EXPIRATION_NOT_SPECIFIED) 
+    {
         pubc->expires_hdr = pjsip_expires_hdr_create(pubc->pool, expires);
     } else {
@@ -277 +281 @@
         pj_list_push_back(&pubc->route_set, pjsip_hdr_clone(pubc->pool, chdr));
         chdr = chdr->next;
+    }
+
+    return PJ_SUCCESS;
+}
+
+PJ_DEF(pj_status_t) pjsip_publishc_set_headers( pjsip_publishc *pubc,
+                                                const pjsip_hdr *hdr_list)
+{
+    const pjsip_hdr *h;
+
+    PJ_ASSERT_RETURN(pubc && hdr_list, PJ_EINVAL);
+
+    pj_list_init(&pubc->usr_hdr);
+    h = hdr_list->next;
+    while (h != hdr_list) {
+        pj_list_push_back(&pubc->usr_hdr, pjsip_hdr_clone(pubc->pool, h));
+        h = h->next;
     }
 
@@ -346 +367 @@
     }
 
+    /* Add user headers */
+    if (!pj_list_empty(&pubc->usr_hdr)) {
+        const pjsip_hdr *hdr;
+
+        hdr = pubc->usr_hdr.next;
+        while (hdr != &pubc->usr_hdr) {
+            pjsip_hdr *new_hdr = (pjsip_hdr*)
+                                 pjsip_hdr_shallow_clone(tdata->pool, hdr);
+            pjsip_msg_add_hdr(tdata->msg, new_hdr);
+            hdr = hdr->next;
+        }
+    }
+
 
     /* Done. */
@@ -531 +565 @@
                       pjsip_msg_find_hdr(msg, PJSIP_H_EXPIRES, NULL);
 
-            if (expires)
+            if (pubc->auto_refresh && expires)
                 expiration = expires->ivalue;
             

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

@@ -962 +962 @@
 
     if (param->code/100 != 2 || param->status != PJ_SUCCESS) {
+
+        pjsip_publishc_destroy(param->pubc);
+        acc->publish_sess = NULL;
+
         if (param->status != PJ_SUCCESS) {
             char errmsg[PJ_ERR_MSG_SIZE];
@@ -969 +973 @@
                       "Client publication (PUBLISH) failed, status=%d, msg=%s",
                        param->status, errmsg));
+        } else if (param->code == 412) {
+            /* 412 (Conditional Request Failed)
+             * The PUBLISH refresh has failed, retry with new one.
+             */
+            pjsua_pres_init_publish_acc(acc->index);
+            
         } else {
             PJ_LOG(1,(THIS_FILE, 
@@ -976 +986 @@
         }
 
-        pjsip_publishc_destroy(param->pubc);
-        acc->publish_sess = NULL;
+    } else {
+        if (param->expiration == -1) {
+            /* Could happen if server "forgot" to include Expires header
+             * in the response. We will not renew, so destroy the pubc.
+             */
+            pjsip_publishc_destroy(param->pubc);
+            acc->publish_sess = NULL;
+        }
     }
 }
@@ -1092 +1108 @@
                                      &acc_cfg->id, &acc_cfg->id,
                                      &acc_cfg->id, 
-                                     PJSUA_PRES_TIMER);
+                                     PJSUA_PUBLISH_EXPIRATION);
         if (status != PJ_SUCCESS) {
             acc->publish_sess = NULL;
@@ -1607 +1623 @@
                           pj_timer_entry *entry)
 {
+    unsigned i;
     pj_time_val delay = { PJSUA_PRES_TIMER, 0 };
+
+    /* Retry failed PUBLISH requests */
+    for (i=0; i<PJ_ARRAY_SIZE(pjsua_var.acc); ++i) {
+        pjsua_acc *acc = &pjsua_var.acc[i];
+        if (acc->cfg.publish_enabled && acc->publish_sess==NULL)
+            pjsua_pres_init_publish_acc(acc->index);
+    }
 
     entry->id = PJ_FALSE;