LibCommon::CMutex クラス

ミューテックスクラス [詳解]

#include "CMutex.h"

LibCommon::CMutex の継承関係図

LibCommon::CMutex 連携図

公開メンバ関数
	CMutex () noexcept
	コンストラクタ [詳解]
virtual	~CMutex () noexcept
	デストラクタ [詳解]
virtual void	Close () noexcept override
	クローズ関数 [詳解]
virtual bool	Release () noexcept override
	リリース関数 [詳解]
virtual bool	Lock (DWORD dwTime=INFINITE) noexcept override
	ロック関数 [詳解]
virtual bool	Unlock () noexcept override
	ロック解除関数 [詳解]
virtual bool	Create (wchar_t const *pszObjectName=nullptr) noexcept
	作成関数 [詳解]
virtual bool	Open (wchar_t const *pszObjectName) noexcept
	オープン関数 [詳解]
基底クラス LibCommon::CSync に属する継承公開メンバ関数
	CSync () noexcept
	コンストラクタ [詳解]
virtual	~CSync () noexcept
	デストラクタ [詳解]
virtual HANDLE	GetHandle () const noexcept
	オブジェクトハンドル取得関数 [詳解]
virtual bool	IsCreate () const noexcept
	新規作成状態取得関数 [詳解]
virtual bool	Wait (DWORD dwTime=INFINITE) noexcept
	ウェイト関数 [詳解]

限定公開変数類
DWORD	m_dwLockCount
	ロックカウント [詳解]
基底クラス LibCommon::CSync に属する継承限定公開変数類
HANDLE	m_hObject
	オブジェクトハンドル [詳解]
bool	m_bIsCreate
	新規作成フラグ [詳解]

静的限定公開変数類
static wchar_t const *const	OBJECT_NAME_EXT = L".CMutex"
	オブジェクト名拡張子 [詳解]

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

詳解

ミューテックスクラス

ミューテックスクラスです。

注意

なし

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

構築子と解体子

LibCommon::CMutex::CMutex ( )

explicitnoexcept

コンストラクタ

コンストラクタです。

引数

なし

戻り値

なし

注意

なし

CMutex.cpp の 29 行目に定義があります。

        : CSync()
        // メンバ変数初期化
        , m_dwLockCount( 0 )
    {}

LibCommon::CMutex::~CMutex ( )

virtualnoexcept

デストラクタ

デストラクタです。

引数

なし

戻り値

なし

注意

なし

CMutex.cpp の 38 行目に定義があります。

参照先 Close().

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

呼び出し関係図:

LibCommon::CMutex::CMutex ( CMutex const &  )

privatedelete

関数詳解

void LibCommon::CMutex::Close ( )

overridevirtualnoexcept

クローズ関数

クローズ関数です。

引数

なし

戻り値

なし

注意

オーバライド関数です。

LibCommon::CSyncを再実装しています。

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

CMutex.cpp の 47 行目に定義があります。

参照先 LibCommon::CSync::Close(), m_dwLockCount.

参照元 LibCommon::CMapping::Close(), LibCommon::CMapping::Create(), Create(), LibCommon::CMapping::Open(), Open(), ~CMutex().

                                {
        // 基底クラスの関数を実行する
        CSync::Close();

        // メンバ変数をクリアする
        m_dwLockCount = 0;
    }

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CMutex::Release ( )

overridevirtualnoexcept

リリース関数

リリース関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

オーバライド関数です。

LibCommon::CSyncを実装しています。

CMutex.cpp の 57 行目に定義があります。

参照先 LibCommon::CSync::m_hObject, NotifyFatalError.

                                  {
        // 処理ブロック
        bool result = false;
        do {
            // ミューテックス所有権を解放する
            if ( 0 == ::ReleaseMutex( m_hObject ) ) {
                // 致命的エラー！
                NotifyFatalError();
                break;
            }

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

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

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

overridevirtualnoexcept

ロック関数

ロック関数です。

引数

[in]

dwTime

待機時間

戻り値

実行結果

• true 成功
• false 失敗

注意

オーバライド関数です。

LibCommon::CSyncを再実装しています。

CMutex.cpp の 78 行目に定義があります。

参照先 m_dwLockCount, NotifyFatalError, LibCommon::CSync::Wait().

                                             {
        // 処理ブロック
        bool result = false;
        do {
            // ロックカウントを調べる
            if ( UINT_MAX == m_dwLockCount ) {
                // 致命的エラー！
                NotifyFatalError();
                break;
            }
            // ウェイトする
            else if ( !Wait( dwTime ) ) {
                // 待機時間を調べる
                if ( INFINITE == dwTime ) {
                    // 致命的エラー！
                    NotifyFatalError();
                }

                // 失敗！
                break;
            }

            // ロックカウントをインクリメントする
            ++m_dwLockCount;

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

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

呼び出し関係図:

bool LibCommon::CMutex::Unlock ( )

overridevirtualnoexcept

ロック解除関数

ロック解除関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

オーバライド関数です。

LibCommon::CSyncを再実装しています。

CMutex.cpp の 113 行目に定義があります。

参照先 m_dwLockCount, LibCommon::CSync::m_hObject, NotifyFatalError.

                                 {
        // 処理ブロック
        bool result = false;
        do {
            // ロックカウントを調べる
            if ( 0 == m_dwLockCount ) {
                // 致命的エラー！
                NotifyFatalError();
                break;
            }
            // リリースする
            else if ( 0 == ::ReleaseMutex( m_hObject ) ) {
                // 致命的エラー！
                NotifyFatalError();
                break;
            }

            // ロックカウントをデクリメントする
            --m_dwLockCount;

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

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

bool LibCommon::CMutex::Create ( wchar_t const *  pszObjectName = nullptr )

virtualnoexcept

作成関数

作成関数です。

引数

[in]

pszObjectName

オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CMutex.cpp の 143 行目に定義があります。

参照先 Close(), LibCommon::CSync::m_bIsCreate, LibCommon::CSync::m_hObject, OBJECT_NAME_EXT.

参照元 LibCommon::CConsole::CConsole(), LibCommon::CMapping::Create().

                                                               {
        // 処理ブロック
        bool result = false;
        do {
            // オブジェクトハンドルを調べる
            if ( nullptr != m_hObject ) {
                // クローズする
                Close();
            }

            // オブジェクト名を調べる
            wchar_t szBuffer[ MAX_PATH ];
            if ( nullptr != pszObjectName ) {
                // オブジェクト名に拡張子を追加する
                ::wcscpy_s( szBuffer, pszObjectName );
                ::wcscat_s( szBuffer, OBJECT_NAME_EXT );
                pszObjectName = szBuffer;
            }

            // ミューテックスを作成する
            m_hObject = ::CreateMutexW( nullptr, false, pszObjectName );
            if ( nullptr == m_hObject ) {
                // 失敗！
                break;
            }
            // エラーコードを調べる
            else if ( ERROR_ALREADY_EXISTS != ::GetLastError() ) {
                // 新規作成フラグをセットする
                m_bIsCreate = true;
            }

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

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CMutex::Open ( wchar_t const *  pszObjectName )

virtualnoexcept

オープン関数

オープン関数です。

引数

[in]

pszObjectName

オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

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

CMutex.cpp の 184 行目に定義があります。

参照先 Close(), LibCommon::CSync::m_hObject, OBJECT_NAME_EXT.

参照元 LibCommon::CMapping::Open().

                                                             {
        // 処理ブロック
        bool result = false;
        do {
            // オブジェクト名を調べる
            if ( nullptr == pszObjectName ) {
                // 失敗！
                break;
            }
            // オブジェクトハンドルを調べる
            else if ( nullptr != m_hObject ) {
                // クローズする
                Close();
            }

            // オブジェクト名に拡張子を追加する
            wchar_t szBuffer[ MAX_PATH ];
            ::wcscpy_s( szBuffer, pszObjectName );
            ::wcscat_s( szBuffer, OBJECT_NAME_EXT );
            pszObjectName = szBuffer;

            // ミューテックスをオープンする
            m_hObject = ::OpenMutexW( MUTEX_ALL_ACCESS, false, pszObjectName );
            if ( nullptr == m_hObject ) {
                // 失敗！
                break;
            }

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

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

呼び出し関係図:

被呼び出し関係図:

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

privatedelete

メンバ詳解

wchar_t const *const LibCommon::CMutex::OBJECT_NAME_EXT = L".CMutex"

staticprotected

オブジェクト名拡張子

CMutex.h の 138 行目に定義があります。

参照元 Create(), Open().

DWORD LibCommon::CMutex::m_dwLockCount

protected

ロックカウント

CMutex.h の 143 行目に定義があります。

参照元 Close(), Lock(), Unlock().

---

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

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