Changeset 4639 for pjproject/branches/projects/pjsua2/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Nov 1, 2013 7:11:48 AM (10 years ago)

Author:

bennylp

Message:

Re #1519: Major change in pjsua2.i and etc after actual test in Python:

• Major changes in SWIG interface file (pjsua2.i).
  • The "ignore" and "unignore" approach caused link error with vector (duplicate symbols because SWIG generates two identical vector functions in the wrapper) so it cannot be used (tried with many combinations and still doesn't work).
  • So scrap that, and now we use "importing" approach, where needed symbols must be listed in symbols.lst file, then use importsym.py to import the symbol declarations to symbols.i. Then include symbols.i in pjsua.i
  • Due to the way importsym.py work, some macros and naked constants need to be placed into a named enumeration, for example:
    • #define PJ_SUCCESS 0 ==> enum pj_constants_ { PJ_SUCCESS=0 }; [types.h]
    • enum { PJMEDIA_VID_DEFAULT_CAPTURE_DEV = -1 } ==> enum pjmedia_vid_dev_std_index { PJMEDIA_VID_DEFAULT_CAPTURE_DEV = -1 }; [videodev.h]
  • Makefile was changed so that symbols.i would be generated if symbols.lst has changed
• Added "make install" and "make uninstall" targets for swig. Only implemented on Python. This will install to user's lib dir so doesn't need sudo.
• Deleted approachX.hpp files
• Added libVersion() method to Endpoint along with Version struct.
• Fix pjsua2.i to make exception (or redirection?) works in Python
• Add polling and worker thread related API:
  • PJSUA-LIB: pjsua_register_worker_thread(), pjsua_stop_worker_threads()
  • Endpoint: libRegisterWorkerThread(), libStopWorkerThreads(), libHandleEvents();

File:

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

pjproject/branches/projects/pjsua2/pjsip/include/pjsua-lib/pjsua.h

@@ -252 +252 @@
 
 /** Constant to identify invalid ID for all sorts of IDs. */
-#define PJSUA_INVALID_ID            (-1)
+enum pjsua_invalid_id_const_
+{
+    PJSUA_INVALID_ID = -1
+};
 
 /** Disabled features temporarily for media reorganization */
@@ -1881 +1884 @@
 
 /**
+ * Register a thread to poll for events. This function should be
+ * called by an external worker thread, and it will block polling
+ * for events until the library is destroyed.
+ *
+ * @return              PJ_SUCCESS if things are working correctly
+ *                      or an error polling cannot be done for some
+ *                      reason.
+ */
+PJ_DECL(pj_status_t) pjsua_register_worker_thread(const char *name);
+
+
+/**
+ * Signal all worker threads to quit. This will only wait until internal
+ * threads are done. For external threads, application must perform
+ * its own waiting for the external threads to quit from
+ * pjsua_register_worker_thread() function.
+ */
+PJ_DECL(void) pjsua_stop_worker_threads(void);
+
+/**
  * Create memory pool to be used by the application. Once application
  * finished using the pool, it must be released with pj_pool_release().