Changeset 4678 for pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/endpoint.hpp

Timestamp:

Dec 5, 2013 3:03:36 AM (11 years ago)

Author:

bennylp

Message:

Re #1519: fixed threading issues on Python. On Python, only threads created by Python can call Python. This creates problem with calling callback from worker thread. The SIP worker thread can be disabled, but we have other worker threads such as the sound device that cannot be disabled. The solution in this patch is to create small framework to post a job to "main thread" during libHandleEvents(). The main thread is thread that calls libCreate().

File:

• pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/endpoint.hpp (modified) (8 diffs)

pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/endpoint.hpp

@@ -27 +27 @@
 #include <pjsua2/media.hpp>
 #include <pjsua2/siptypes.hpp>
+#include <list>
 
 /** PJSUA2 API is inside pj namespace */
@@ -184 +185 @@
      */
     unsigned            threadCnt;
+
+    /**
+     * When this flag is non-zero, all callbacks that come from thread
+     * other than main thread will be posted to the main thread and
+     * to be executed by Endpoint::libHandleEvents() function. This
+     * includes the logging callback. Note that this will only work if
+     * threadCnt is set to zero and Endpoint::libHandleEvents() is
+     * performed by main thread. By default, the main thread is set
+     * from the thread that invoke Endpoint::libCreate()
+     *
+     * Default: false
+     */
+    bool                mainThreadOnly;
 
     /**
@@ -635 +649 @@
 };
 
+/* This represents posted job */
+struct PendingJob
+{
+    /** Perform the job */
+    virtual void execute(bool is_pending) = 0;
+
+    /** Virtual destructor */
+    virtual ~PendingJob() {}
+};
+
 //////////////////////////////////////////////////////////////////////////////
 
@@ -717 +741 @@
      * structure, because polling then will be done by these worker threads
      * instead.
+     *
+     * If EpConfig::UaConfig::mainThreadOnly is enabled and this function
+     * is called from the main thread (by default the main thread is thread
+     * that calls libCreate()), this function will also scan and run any
+     * pending jobs in the list.
      *
      * @param msec_timeout Maximum time to wait, in miliseconds.
@@ -765 +794 @@
 
     /**
+     * Write a log entry.
+     *
+     * @param e                 The log entry.
+     */
+    void utilLogWrite(LogEntry &e);
+
+    /**
      * This is a utility function to verify that valid SIP url is given. If the
      * URL is a valid SIP/SIPS scheme, PJ_SUCCESS will be returned.
@@ -814 +850 @@
      */
     void utilTimerCancel(Token prmToken);
+
+    /**
+     * Utility to register a pending job to be executed by main thread.
+     * If EpConfig::UaConfig::mainThreadOnly is false, the job will be
+     * executed immediately.
+     *
+     * @param job               The job class.
+     */
+    void utilAddPendingJob(PendingJob *job);
 
     /**
@@ -1122 +1167 @@
     { PJ_UNUSED_ARG(prm); }
 
-
 private:
     static Endpoint             *instance_;     // static instance
@@ -1129 +1173 @@
     AudDevManager                audioDevMgr;
     CodecInfoVector              codecInfoList;
+
+    /* Pending logging */
+    bool                         mainThreadOnly;
+    void                        *mainThread;
+    unsigned                     pendingJobSize;
+    std::list<PendingJob*>       pendingJobs;
+
+    void performPendingJobs();
 
     /* Endpoint static callbacks */