MFCの基礎 - マルチスレッド

概要

MFCアプリケーションにおいて、マルチスレッドを使用する方法について記述する。

作成手順

1. ワーカースレッド制御関数の定義

   まず、クラスに静的なワーカースレッド制御関数を定義する。

   
   

   ワーカースレッド制御関数は静的であるため、クラスのメンバ変数およびメンバ関数を直接使用することができない。

   ただし、void*型の引数を渡して特定のキャストを行うことにより、ワーカースレッド制御関数下でクラスのメンバを使用することができる。

   
   

2. ワーカースレッド本体の関数の定義

   次に、同じクラスに静的ではないワーカースレッド本体の関数を定義する。

   ワーカースレッド本体の関数では、静的でないメンバ変数およびメンバ関数が使用できる。

サンプルコード

 // CFileView.hファイル
 
 class CFileView
 {
    private:
       CWinThread *m_pLoadXMLThread
 
    public:
       static UINT LoadXMLThreadFunc(void *pParam);	 // 静的なワーカースレッド制御関数
       void        LoadXMLThreadFunc();              // ワーカースレッド本体
 };

 // CFileView.cppファイル
 
 void CFileView::OnButtonClick()
 {
    // XML読み込み処理スレッド関数を実行
    m_pLoadXMLThread = ::AfxBeginThread(LoadXMLThreadFunc, this, THREAD_PRIORITY_NORMAL, 0, CREATE_SUSPENDED, NULL);
 
    ASSERT(m_pLoadXMLThread);
 
    if(m_pLoadXMLThread) {
       m_pLoadXMLThread->m_pMainWnd	= this;
       m_pLoadXMLThread->m_bAutoDelete	= FALSE;
 
       // スレッド処理の開始
       m_pLoadXMLThread->ResumeThread();
       while (WaitForSingleObject(m_pLoadXMLThread->m_hThread, 100) == WAIT_TIMEOUT) {
          // ワーカースレッドが終了するまで待機
          MSG msg;
          while (::PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
             ::TranslateMessage(&msg);
             ::DispatchMessage(&msg);
          }
       }
 
       delete m_pLoadXMLThread;
    }

    // マルチスレッドの応用(ウェイトウィンドウを表示する)
    //m_pLoadXMLThread = ::AfxBeginThread(LoadXMLThreadFunc, this, THREAD_PRIORITY_NORMAL, 0, CREATE_SUSPENDED, NULL);
 
    //if(m_pLoadXMLThread) {
    //   CRect rc;
    //   HWND hNotifyWnd = CreateDialog(AfxGetInstanceHandle(), MAKEINTRESOURCE(IDD_PROCESSING), this->m_hWnd, (DLGPROC)YCommonProc);
    //   ::ShowWindow(hNotifyWnd, SW_SHOW);
    //   ::GetClientRect(&rc);
    //   ::MoveWindow(hNotifyWnd, (rc.right - rc.left) / 2 - 100, (rc.bottom - rc.top) / 2 - 25, 200, 50, TRUE);
 
    //   m_pLoadXMLThread->m_pMainWnd	 = this;
    //   m_pLoadXMLThread->m_bAutoDelete = FALSE;
 
    //   m_pLoadXMLThread->ResumeThread();
    //   while(::WaitForSingleObject(m_pLoadXMLThread->m_hThread, 100) == WAIT_TIMEOUT) {
    //      // ワーカースレッドが終了するまで待機
    //      MSG msg;
    //      while(::PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
    //         ::TranslateMessage(&msg);
    //         ::DispatchMessage(&msg);
    //      }
    //   }
    //   delete m_pLoadXMLThread;
 
    //   ::DestroyWindow(hNotifyWnd);
    //}
 }
 
 // 静的なワーカースレッド制御関数
 // 引数 : この制御関数が定義されているクラスへのポインタ
 // 実処理はワーカースレッド本体の関数で行う
 UINT CFileView::LoadXMLThreadFunc(void *pParam)
 {
    CFileView *pFileView = dynamic_cast<CFileView*>(reinterpret_cast<CWnd*>(pParam));
    if(pFileView) {
       pFileView->LoadXMLThreadFunc();
    }
 
    return THREAD_EXIT_CODE;
 }
 
 // ワーカースレッド本体の関数
 // スレッドの開始
 void CFileView::LoadXMLThreadFunc()
 {
    // ワーカースレッドで実行する処理
    // ...略
 }

画面の更新

ワーカースレッド内において、UpdateData関数等の画面を描画するような関数は実行することができない。

AfxGetMainWnd関数の戻り値は、m_pLoadXMLThread->m_pMainWndに渡したウィンドウである。
設定しない場合はNULLとなり、また、ダイアログのCreate関数も呼ぶことができない。

そのため、ワーカースレッドの処理と同期して画面を更新する場合 (UpdateData(TRUE)をスレッドから同期して実行する場合) は、
以下に示すようにワーカースレッド内からメインウィンドウにメッセージを送信する。
メインウインドウは、メッセージを受信して任意の処理を行う。

 // stdafx.hファイル
 
 //------------------------------------------------------------------------
 // USER_MESSAGE
 //------------------------------------------------------------------------
 #define WM_USER_COMPLETE_LOAD_XML   (WM_USER + 1)   // XMLデータの読み込みの完了メッセージ

 // CFileView.cppファイル
 
 // まず、ワーカースレッドからメイン処理にメッセージを送信する
 // 次に、メッセージを受信して任意の処理を行う
 BEGIN_MESSAGE_MAP(CFileView, CDockablePane)
    // UserMessage
    ON_MESSAGE(WM_USER_COMPLETE_LOAD_XML, &CFileView::OnCompleteLoadXML)
 END_MESSAGE_MAP()
 
 // ワーカースレッド関数の本体にて
 // XMLファイルの読み込みが完了したメッセージを送信
 AfxGetMainWnd()->SendMessage(WM_USER_COMPLETE_LOAD_XML, (WPARAM)&firstIndex, (LPARAM)firstFilePath.GetString());

 // CFileView.hファイル
 
 class CFileView
 {
    // 追加
    afx_msg LRESULT OnCompleteLoadXML(WPARAM wParam, LPARAM lParam );
 }

後は、SendMessage関数を受け取った側で処理を行えばよい。
受信側では、UpdateData(TRUE)、および、UpdateData(FALSE)等を呼ぶことができる。

この時、スレッドの終了を待機するWaitForSingleObject関数を使用する場合、デッドロックになることに注意する。
スレッドの終了時に何らかの処理を行うのであれば、上記のようにスレッド終了時に"メッセージをメインウィンドウへ送信する"ことにより解決できる。