CThread.h

[詳解]

//=============================================================================
/// @file
/// スレッドクラスヘッダファイル
///
/// スレッドクラスヘッダファイルです。
///
/// $Id: CThread.h 245 2019-03-20 15:03:41Z admin $
/// $Date: 2019-03-21 00:03:41 +0900 (2019/03/21 (木)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

//=============================================================================
// インクルードファイル
#include <CSync.h>

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// スレッドクラス
    ///
    /// スレッドクラスです。
    ///
    /// @attention なし
    ///
    class LIB_COMMON_API CThread: public CSync {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CThread() noexcept;

        //---------------------------------------------------------------------
        /// デストラクタ
        ///
        /// デストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual ~CThread() noexcept;

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// スレッドID取得関数
        ///
        /// スレッドID取得関数です。
        ///
        /// @param     なし
        /// @return    スレッドID
        /// @attention なし
        ///
        inline virtual DWORD GetThreadId() const noexcept { return m_dwThreadId; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// クローズ関数
        ///
        /// クローズ関数です。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention オーバライド関数です。
        ///
        virtual void Close() noexcept override;

        //---------------------------------------------------------------------
        /// リリース関数
        ///
        /// リリース関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool Release() noexcept override;

        //---------------------------------------------------------------------
        /// 作成関数
        ///
        /// 作成関数です。
        ///
        /// @param[in] pfnFunc 関数アドレス
        /// @param[in] lpParam 引数アドレス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Create( LPTHREAD_START_ROUTINE pfnFunc, LPVOID lpParam ) noexcept;

        //---------------------------------------------------------------------
        /// オープン関数
        ///
        /// オープン関数です。
        ///
        /// @param[in] dwThreadId スレッドID
        /// @param[in] dwAccess   アクセスフラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Open( DWORD dwThreadId, DWORD dwAccess = THREAD_ALL_ACCESS ) noexcept;

        //---------------------------------------------------------------------
        /// 強制終了関数
        ///
        /// 強制終了関数です。
        ///
        /// @param[in] dwExitCode 終了コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Terminate( DWORD dwExitCode = 0 ) noexcept;

        //---------------------------------------------------------------------
        /// 終了コード取得関数
        ///
        /// 終了コード取得関数です。
        ///
        /// @param     なし
        /// @return    スレッド終了コード
        /// @attention なし
        ///
        virtual DWORD GetExitCode() const noexcept;

        //---------------------------------------------------------------------
        /// サスペンド関数
        ///
        /// サスペンド関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Suspend() noexcept;

        //---------------------------------------------------------------------
        /// リジューム関数
        ///
        /// リジューム関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Resume() noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        DWORD m_dwThreadId; ///< スレッドID

        //=====================================================================
        // 削除関数
    private:
        CThread( CThread const& ) = delete;
        CThread& operator=( CThread const& ) = delete;
    };
}

#pragma managed( pop )