Changeset 2661 for pjproject/trunk/pjsip/include/pjsip-simple/publish.h

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

File:

• pjproject/trunk/pjsip/include/pjsip-simple/publish.h (modified) (2 diffs)

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