LibCommon::CSync クラス

同期クラス [詳解]

#include "CSync.h"

LibCommon::CSync の継承関係図

LibCommon::CSync 連携図

公開メンバ関数
	CSync () noexcept
	コンストラクタ [詳解]
virtual	~CSync () noexcept
	デストラクタ [詳解]
virtual HANDLE	GetHandle () const noexcept
	オブジェクトハンドル取得関数 [詳解]
virtual bool	IsCreate () const noexcept
	新規作成状態取得関数 [詳解]
virtual void	Close () noexcept
	クローズ関数 [詳解]
virtual bool	Wait (DWORD dwTime=INFINITE) noexcept
	ウェイト関数 [詳解]
virtual bool	Release () noexcept=0
	リリース関数 [詳解]
virtual bool	Lock (DWORD dwTime=INFINITE) noexcept
	ロック関数 [詳解]
virtual bool	Unlock () noexcept
	ロック解除関数 [詳解]

限定公開変数類
HANDLE	m_hObject
	オブジェクトハンドル [詳解]
bool	m_bIsCreate
	新規作成フラグ [詳解]

非公開メンバ関数
	CSync (CSync const &)=delete
CSync &	operator= (CSync const &)=delete

詳解

同期クラス

同期クラスです。

注意

抽象クラスです。

CSync.h の 30 行目に定義があります。

構築子と解体子

LibCommon::CSync::CSync ( )

explicitnoexcept

コンストラクタ

コンストラクタです。

引数

なし

戻り値

なし

注意

なし

CSync.cpp の 28 行目に定義があります。

        : m_hObject( nullptr )
        , m_bIsCreate( false )
    {}

LibCommon::CSync::~CSync ( )

virtualnoexcept

デストラクタ

デストラクタです。

引数

なし

戻り値

なし

注意

なし

CSync.cpp の 36 行目に定義があります。

参照先 Close().

                           {
        // クローズする
        Close();
    }

呼び出し関係図:

LibCommon::CSync::CSync ( CSync const &  )

privatedelete

関数詳解

virtual HANDLE LibCommon::CSync::GetHandle ( ) const

inlinevirtualnoexcept

オブジェクトハンドル取得関数

オブジェクトハンドル取得関数です。

引数

なし

戻り値

オブジェクトハンドル

注意

なし

LibCommon::CMappingで再実装されています。

CSync.h の 68 行目に定義があります。

参照元 LibCommon::CConsole::ClearInputBuffer().

{ return m_hObject; }

被呼び出し関係図:

virtual bool LibCommon::CSync::IsCreate ( ) const

inlinevirtualnoexcept

新規作成状態取得関数

新規作成状態取得関数です。

引数

なし

戻り値

新規作成フラグ

• true 新規作成
• false 非新規作成

注意

なし

CSync.h の 81 行目に定義があります。

参照元 LibLogOut::CLibLogOut::CLibLogOut().

{ return m_bIsCreate; }

被呼び出し関係図:

void LibCommon::CSync::Close ( )

virtualnoexcept

クローズ関数

クローズ関数です。

引数

なし

戻り値

なし

注意

なし

LibCommon::CTimer, LibCommon::CMapping, LibCommon::CProcess, LibCommon::CThread, LibCommon::CMutexで再実装されています。

CSync.cpp の 45 行目に定義があります。

参照先 m_bIsCreate, m_hObject.

参照元 LibCommon::CMutex::Close(), LibCommon::CProcess::Close(), LibCommon::CThread::Close(), LibCommon::CTimer::Close(), LibCommon::CSemaphore::Create(), LibCommon::CEvent::Create(), LibCommon::CEvent::Open(), LibCommon::CSemaphore::Open(), ~CSync().

                               {
        // オブジェクトハンドルを調べる
        if ( nullptr != m_hObject ) {
            // オブジェクトハンドルをクローズする
            ::CloseHandle( m_hObject );
        }

        // メンバ変数をクリアする
        m_hObject   = nullptr;
        m_bIsCreate = false;
    }

被呼び出し関係図:

bool LibCommon::CSync::Wait ( DWORD  dwTime = INFINITE )

virtualnoexcept

ウェイト関数

ウェイト関数です。

引数

[in]

dwTime

ウェイト時間

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

LibCommon::CTimerで再実装されています。

CSync.cpp の 59 行目に定義があります。

参照先 m_hObject.

参照元 LibCommon::CConsoleMenu::ExecMenu(), LibCommon::CConsoleMenu::ExecSubThread(), LibLogOut::CLibLogOut::Flush(), LibCommon::CConsole::InputChar(), LibCommon::CConsole::InputRecord(), LibCommon::CMutex::Lock(), Lock(), LibCommon::CConsoleMenu::StopMenu(), LibLogOut::CLibLogOut::SubThreadProc(), LibNewDel::CLibNewDel::UpdateProcessInfo(), LibLogOut::CLibLogOut::UpdateProcessInfo(), LibCommon::CTimer::Wait().

                                            {
        // 処理ブウェイト
        bool result = false;
        do {
            // シグナルがセットされるまで待機する
            if ( WAIT_OBJECT_0 != ::WaitForSingleObject( m_hObject, dwTime ) ) {
                // 失敗！
                break;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

被呼び出し関係図:

virtual bool LibCommon::CSync::Release ( )

pure virtualnoexcept

リリース関数

リリース関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

純粋仮想関数です。

LibCommon::CTimer, LibCommon::CProcess, LibCommon::CThread, LibCommon::CMutex, LibCommon::CEvent, LibCommon::CSemaphoreで実装されています。

参照元 Unlock().

被呼び出し関係図:

bool LibCommon::CSync::Lock ( DWORD  dwTime = INFINITE )

virtualnoexcept

ロック関数

ロック関数です。

引数

[in]

dwTime

待機時間

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

LibCommon::CMutexで再実装されています。

CSync.cpp の 79 行目に定義があります。

参照先 Wait().

                                            {
        // ウェイトする
        return Wait( dwTime );
    }

呼び出し関係図:

bool LibCommon::CSync::Unlock ( )

virtualnoexcept

ロック解除関数

ロック解除関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

LibCommon::CMutexで再実装されています。

CSync.cpp の 86 行目に定義があります。

参照先 Release().

参照元 LibCommon::CSyncAuto::~CSyncAuto().

                                {
        // リリースする
        return Release();
    }

呼び出し関係図:

被呼び出し関係図:

CSync& LibCommon::CSync::operator= ( CSync const &  )

privatedelete

メンバ詳解

HANDLE LibCommon::CSync::m_hObject

protected

オブジェクトハンドル

CSync.h の 152 行目に定義があります。

参照元 LibCommon::CSemaphore::AddCount(), LibCommon::CTimer::Cancel(), Close(), LibCommon::CEvent::Create(), LibCommon::CSemaphore::Create(), LibCommon::CProcess::Create(), LibCommon::CThread::Create(), LibCommon::CMutex::Create(), LibCommon::CTimer::Create(), LibCommon::CThread::GetExitCode(), LibCommon::CProcess::GetExitCode(), LibCommon::CEvent::Open(), LibCommon::CSemaphore::Open(), LibCommon::CThread::Open(), LibCommon::CProcess::Open(), LibCommon::CMutex::Open(), LibCommon::CTimer::Open(), LibCommon::CEvent::Pulse(), LibCommon::CMutex::Release(), LibCommon::CEvent::Reset(), LibCommon::CThread::Resume(), LibCommon::CEvent::Set(), LibCommon::CTimer::Set(), LibCommon::CTimer::SetNano100(), LibCommon::CThread::Suspend(), LibCommon::CProcess::Terminate(), LibCommon::CThread::Terminate(), LibCommon::CMutex::Unlock(), Wait() (計29項目).

bool LibCommon::CSync::m_bIsCreate

protected

新規作成フラグ

CSync.h の 153 行目に定義があります。

参照元 Close(), LibCommon::CEvent::Create(), LibCommon::CSemaphore::Create(), LibCommon::CMapping::Create(), LibCommon::CMutex::Create(), LibCommon::CTimer::Create().

---

このクラス詳解は次のファイルから抽出されました:

• C:/Work/VisualStudio2017/Solution46/Include/Library/LibCommon/CSync.h
• C:/Work/VisualStudio2017/Solution46/Source/Library/LibCommon/CSync.cpp