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

Timestamp:

Oct 19, 2011 1:08:14 PM (12 years ago)

Author:

bennylp

Message:

Renamed enum names to comply with the spec in ticket (re #1216)

File:

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

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

@@ -1300 +1300 @@
 {
     /**
-     * Do not invoke any networking functions.
-     */
-    PJSUA_DESTROY_NO_NETWORK = 1
+     * Allow sending outgoing messages (such as unregistration, event
+     * unpublication, BYEs, unsubscription, etc.), but do not wait for
+     * responses. This is useful to perform "best effort" clean up
+     * without delaying the shutdown process waiting for responses.
+     */
+    PJSUA_DESTROY_NO_RX_MSG = 1,
+
+    /**
+     * If this flag is set, do not send any outgoing messages at all.
+     * This flag is useful if application knows that the network which
+     * the messages are to be sent on is currently down.
+     */
+    PJSUA_DESTROY_NO_TX_MSG = 2,
+
+    /**
+     * Do not send or receive messages during destroy. This flag is
+     * shorthand for  PJSUA_DESTROY_NO_RX_MSG + PJSUA_DESTROY_NO_TX_MSG.
+     */
+    PJSUA_DESTROY_NO_NETWORK = PJSUA_DESTROY_NO_RX_MSG |
+                               PJSUA_DESTROY_NO_TX_MSG
 
 } pjsua_destroy_flag;