Changeset 3829 for pjproject/branches/1.x/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Oct 19, 2011 12:45:05 PM (13 years ago)

Author:

bennylp

Message:

Fixed #1216: New pjsua_destroy2() API to allow shutting down the library without sending any outgoing messages

File:

• pjproject/branches/1.x/pjsip/include/pjsua-lib/pjsua.h (modified) (2 diffs)

pjproject/branches/1.x/pjsip/include/pjsua-lib/pjsua.h

@@ -1295 +1295 @@
 
 /**
+ * Flags to be given to pjsua_destroy2()
+ */
+typedef enum pjsua_destroy_flag
+{
+    /**
+     * Do not invoke any networking functions.
+     */
+    PJSUA_DESTROY_NO_NETWORK = 1
+
+} pjsua_destroy_flag;
+
+/**
  * Use this function to initialize pjsua config.
  *
@@ -1430 +1442 @@
  * keep track of it's state.
  *
+ * @see pjsua_destroy2()
+ *
  * @return              PJ_SUCCESS on success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pjsua_destroy(void);
+
+
+/**
+ * Variant of destroy with additional flags.
+ *
+ * @param flags         Combination of pjsua_destroy_flag enumeration.
+ *
+ * @return              PJ_SUCCESS on success, or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pjsua_destroy2(unsigned flags);