CSync.h

[詳解]

//=============================================================================
/// @file
/// 同期クラスヘッダファイル
///
/// 同期クラスヘッダファイルです。
///
/// $Id: CSync.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 <LibCommonDef.h>

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

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// オブジェクトハンドル取得関数
        ///
        /// オブジェクトハンドル取得関数です。
        ///
        /// @param     なし
        /// @return    オブジェクトハンドル
        /// @attention なし
        ///
        inline virtual HANDLE GetHandle() const noexcept { return m_hObject; }

        //---------------------------------------------------------------------
        /// 新規作成状態取得関数
        ///
        /// 新規作成状態取得関数です。
        ///
        /// @param     なし
        /// @return    新規作成フラグ
        /// -          true  新規作成
        /// -          false 非新規作成
        /// @attention なし
        ///
        inline virtual bool IsCreate() const noexcept { return m_bIsCreate; }

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

        //---------------------------------------------------------------------
        /// ウェイト関数
        ///
        /// ウェイト関数です。
        ///
        /// @param[in] dwTime ウェイト時間
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Wait( DWORD dwTime = INFINITE ) noexcept;

        //---------------------------------------------------------------------
        /// リリース関数
        ///
        /// リリース関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention 純粋仮想関数です。
        ///
        virtual bool Release() noexcept = 0;

        //---------------------------------------------------------------------
        /// ロック関数
        ///
        /// ロック関数です。
        ///
        /// @param[in] dwTime 待機時間
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Lock( DWORD dwTime = INFINITE ) noexcept;

        //---------------------------------------------------------------------
        /// ロック解除関数
        ///
        /// ロック解除関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Unlock() noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        HANDLE m_hObject;   ///< オブジェクトハンドル
        bool   m_bIsCreate; ///< 新規作成フラグ

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

#pragma managed( pop )