Changes between Version 17 and Version 18 of pjsip-doc/intro_pjsua2

Timestamp:

May 4, 2016 9:58:01 AM (9 years ago)

Author:

ming

Comment:

--

pjsip-doc/intro_pjsua2

@@ -61 +61 @@
 Garbage collection (GC) exists in Java and Python (and other languages, but we don't support those for now), and there are some problems with it when it comes to PJSUA2 usage:
 
-- it delays the destruction of objects (including PJSUA2 objects), causing the code in object's destructor to be executed out of order
-- the GC operation may run on different thread not previously registered to PJLIB, causing assertion
-
-Due to problems above, application '''MUST immediately destroy PJSUA2 objects using object's delete() method (in Java)''', instead of relying on the GC to clean up the object.
-
+ 1. premature destruction of PJSUA2 objects which are created in Java and Python space and passed to the native space
+ 2. it delays the destruction of objects (including PJSUA2 objects), causing the code in object's destructor to be executed out of order
+ 3. the GC operation may run on different thread not previously registered to PJLIB, causing assertion
+
+Some examples for problem 1 are (these examples are by no means a complete list) when adding Buddy object to an account using Account.addBuddy() or setting LogWriter by calling EpConfig.LogConfig.setLogWriter(). To avoid this problem, application needs to maintain an explicit reference on objects created in its application, instead of relying on PJSUA2 native library to keep track of those objects, i.e. :
+
+.. code-block:: c++
+
+    class MyApp {
+        private MyLogWriter logWriter;
+   
+        public void init()
+        {
+            /* Maintain reference to log writer to avoid premature cleanup by GC */
+            logWriter = new MyLogWriter();
+            epConfig.getLogConfig.setWriter(logWriter);
+        }
+    }
+
+While for problems 2 and 3, application '''MUST immediately destroy PJSUA2 objects using object's delete() method (in Java)''', instead of relying on the GC to clean up the object.
 For example, to delete an Account, it's **NOT** enough to just let it go out of scope. Application MUST delete it manually like this (in Java):