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

Timestamp:

Oct 20, 2009 1:56:26 PM (15 years ago)

Author:

bennylp

Message:

Initial commit for ticket #937: Revamping of presence management to make it more efficient

Presence enhancements:

• finer grained buddy lock object, instead of using global PJSUA-LIB's mutex
• individual resubscription timer for buddies and also add random delay interval so that resubscriptions don't happen simultaneously (may hog processing and bandwidth).
• in general reduced the use of global PJSUA-LIB's mutex for more efficiency
• added last termination code in buddy info
• use the RPID note's text for buddy's offline status rather than the default "offline" status, if available
• resubscribe automatically on several termination causes as explained in the ticket (still untested)

General enhancements:

• added pjsua_schedule_timer() and pjsua_cancel_timer() APIs

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (modified) (2 diffs)

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

@@ -1398 +1398 @@
 
 /**
+ * Schedule a timer entry. Note that the timer callback may be executed
+ * by different thread, depending on whether worker thread is enabled or
+ * not.
+ *
+ * @param entry         Timer heap entry.
+ * @param delay     The interval to expire.
+ *
+ * @return              PJ_SUCCESS on success, or the appropriate error code.
+ *
+ * @see pjsip_endpt_schedule_timer()
+ */
+PJ_DECL(pj_status_t) pjsua_schedule_timer(pj_timer_entry *entry,
+                                          const pj_time_val *delay);
+
+
+/**
+ * Cancel the previously scheduled timer.
+ *
+ * @param entry         Timer heap entry.
+ *
+ * @see pjsip_endpt_cancel_timer()
+ */
+PJ_DECL(void) pjsua_cancel_timer(pj_timer_entry *entry);
+
+
+/**
  * This is a utility function to display error message for the specified 
  * error code. The error message will be sent to the log.
@@ -3129 +3155 @@
 
     /**
-     * Specifies the last presence subscription terminatino reason. If 
+     * Specifies the last presence subscription termination code. This would
+     * return the last status of the SUBSCRIBE request. If the subscription
+     * is terminated with NOTIFY by the server, this value will be set to
+     * 200, and subscription termination reason will be given in the
+     * \a sub_term_reason field.
+     */
+    unsigned            sub_term_code;
+
+    /**
+     * Specifies the last presence subscription termination reason. If 
      * presence subscription is currently active, the value will be empty.
      */