SOUI中TaskLoop組件介紹

SOUI是一套開源（MIT協議）的Windows平台下的DirectUI框架，它提供了大量的高效控件，也提供了很多擴展組件，目前已經持續維護近10年，在大量的項目中證明穩定可靠。

GIT地址：

國內：https://gitee.com/setoutsoft/soui

國外：https://github.com/soui2/soui

 

下面介紹一個最近增加的組件：TaskLoop.

TaskLoop是一個異步任務模塊。對於有網絡請求的情況，異步任務是常規需求。

和使用其它SOUI組件一樣，要使用異步任務模塊，先完成組件的編譯，然后就可以通過SComMgr來創建TaskLoop對象。

 

打開soui.08.sln可以看到上面工程組織結構。使用其它版本VS的朋友，可以用build.bat來生成自己需要的VS版本。

我們先看一看staskloop-i.h中的接口定義。

#pragma once
#include <unknown/obj-ref-i.h>

namespace SOUI
{
    struct IRunnable
    {
        virtual ~IRunnable() {}
        virtual IRunnable* clone() const = 0;
        virtual void run() = 0;
        virtual void *getObject() = 0;
        virtual const char *getClassInfo() const = 0;
    };

    struct ITaskLoop : public IObjRef
    {
        enum Priority
        {
            High = 1,
            Normal = 0,
            Low = -1,
        };

        virtual bool getName(char *pszBuf, int nBufLen) = 0;

        /**
        * Start a thread to run.
        * @param priority the thread priority
        */
        virtual void start(const char * pszName,Priority priority) = 0;

        /**
        * Stop thread synchronized.
        */
        virtual void stop() = 0;

        /**
        * postTask post or send a tasks to this task manager.
        * @param runnable the to be run task object.
        * @param waitUntilDone, true for send and false for post.
        * @param priority, the task priority.
        * @return the task id, can be used by cancelTask.
        */
        virtual long postTask(const IRunnable *runnable, bool waitUntilDone, int priority=0) = 0;

        /**
        * Remove tasks for a specific object from task loop pending task list
        * @param object the specific object wants pending functors to be removed
        */
        virtual void cancelTasksForObject(void *object) = 0;

        /**
        * Cancel tasks for a specific task ID list
        * @param taskList the task ID list to be canceled
        * @return the removed task list.
        */
        virtual bool cancelTask(long taskId) = 0;

        /**
        * get the total task number in the task loop queue.
        * @return total task number in task loop queue
        */
        virtual int getTaskCount() const = 0;

        /**
        * get the run loop status.
        * @return the running status
        */
        virtual bool isRunning() = 0;

        /**
        * get the running task info.
        * @param buf, to receive task info buf.
        * @param bufLen, buffer length
        * @return false - no task is running; true - succeed.
        */
        virtual bool getRunningTaskInfo(char *buf, int bufLen) = 0;
    };
}

 

  創建出ITaskLoop接口后，先調用start來啟動，再調用postTask來添加一個異步任務。添加到同一個TaskLoop對象中的任務順序在同一個線程中執行。

任務的優先級默認是0，如果很多任務在排除，新加入的任務希望優先執行，則將nPriority這個參數設置為一個更大的值，任務插入隊列的時候，自動根據nPriority排序，nPriority越大，排序越前。

postTask需要提供一個IRunnable對象來運行。

使用SOUI/helper/sfunctor.hpp可以方便的將一個對象的成員函數或者全局函數轉換成為一個IRunnable對象。

下面看一下demo中如何使用ITaskLoop.

//演示異步任務。
class CAsyncTaskObj
{
public:
    void task1(int a)
    {
        SLOG_INFO("task1,a:" << a);
    }

    void task2(int a, const std::string & b)
    {
        SLOG_INFO("task2,a:" << a<<" b:"<<b.c_str());
    }
};

int WINAPI _tWinMain(HINSTANCE hInstance, HINSTANCE /*hPrevInstance*/, LPTSTR /*lpstrCmdLine*/, int /*nCmdShow*/)
{
    
    //必須要調用OleInitialize來初始化運行環境
    HRESULT hRes = OleInitialize(NULL);
    SASSERT(SUCCEEDED(hRes));


    //使用imgdecoder-png圖片解碼模塊演示apng動畫
    SComMgr2 *pComMgr = new SComMgr2(_T("imgdecoder-png"));
    


    {

  
        //演示異步任務。
        CAutoRefPtr<ITaskLoop>  pTaskLoop;
        if (pComMgr->CreateTaskLoop((IObjRef**)&pTaskLoop))
        {
            CAsyncTaskObj obj;
            pTaskLoop->start("test", ITaskLoop::Low);
            STaskHelper::post(pTaskLoop, &obj, &CAsyncTaskObj::task1, 100,true);
            STaskHelper::post(pTaskLoop, &obj, &CAsyncTaskObj::task2, 100,"abc", true);
            pTaskLoop->stop();
            pTaskLoop = NULL;
        }
      }
     //....
     return 0;
}

注：

demo為了方便演示實際上是在工作線程中使用了同步等待。

使用TaskLoop最好結合SOUI的NotifyCenter對象一起使用，在異步任務中需要通知UI層，使用NotifyCenter是最簡單有效的。

更多用法參考SOUI的壁紙demo: https://github.com/soui-demo/SouiWallPaper

 

啟程軟件 2019-02-03