LibCommon::CSemaphore クラス

セマフォクラス [詳解]

#include "CSemaphore.h"

LibCommon::CSemaphore の継承関係図

LibCommon::CSemaphore 連携図

公開メンバ関数
	CSemaphore () noexcept
	コンストラクタ [詳解]
virtual	~CSemaphore () noexcept
	デストラクタ [詳解]
virtual bool	Release () noexcept override
	リリース関数 [詳解]
virtual bool	Create (wchar_t const *pszObjectName=nullptr) noexcept
	作成関数 [詳解]
virtual bool	Create (LONG nInitial, LONG nMax, wchar_t const *pszObjectName=nullptr) noexcept
	作成関数 [詳解]
virtual bool	Open (wchar_t const *pszObjectName) noexcept
	オープン関数 [詳解]
virtual bool	AddCount (long nCount, long &rnPrev) noexcept
	カウント加算関数 [詳解]
基底クラス 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	Lock (DWORD dwTime=INFINITE) noexcept
	ロック関数 [詳解]
virtual bool	Unlock () noexcept
	ロック解除関数 [詳解]

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

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

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

詳解

セマフォクラス

セマフォクラスです。

注意

なし

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

構築子と解体子

LibCommon::CSemaphore::CSemaphore ( )

explicitnoexcept

コンストラクタ

コンストラクタです。

引数

なし

戻り値

なし

注意

なし

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

        : CSync()
    {}

virtual LibCommon::CSemaphore::~CSemaphore ( )

inlinevirtualnoexcept

デストラクタ

デストラクタです。

引数

なし

戻り値

なし

注意

なし

CSemaphore.h の 54 行目に定義があります。

{}

LibCommon::CSemaphore::CSemaphore ( CSemaphore const &  )

privatedelete

関数詳解

bool LibCommon::CSemaphore::Release ( )

overridevirtualnoexcept

リリース関数

リリース関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

オーバライド関数です。

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

CSemaphore.cpp の 37 行目に定義があります。

参照先 AddCount().

                                      {
        // 処理ブロック
        bool result = false;
        do {
            // セマフォカウントを加算する
            long prev;
            result = AddCount( 1, prev );
        } while ( false );

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

呼び出し関係図:

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

virtualnoexcept

作成関数

作成関数です。

引数

[in]

pszObjectName

オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CSemaphore.cpp の 52 行目に定義があります。

                                                                   {
        // 引数を指定して作成する
        return Create( 1, 1, pszObjectName );
    }

bool LibCommon::CSemaphore::Create ( LONG  nInitial, LONG  nMax, wchar_t const *  pszObjectName = nullptr  )

virtualnoexcept

作成関数

作成関数です。

引数

[in]	nInitial	初期値
[in]	nMax	最大値
[in]	pszObjectName	オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

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

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

                                                                                             {
        // 処理ブロック
        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 = ::CreateSemaphoreW( nullptr, nInitial, nMax, pszObjectName );
            if ( nullptr == m_hObject ) {
                // 失敗！
                break;
            }
            // エラーコードを調べる
            else if ( ERROR_ALREADY_EXISTS != ::GetLastError() ) {
                // 新規作成フラグをセットする
                m_bIsCreate = true;
            }

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

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

呼び出し関係図:

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

virtualnoexcept

オープン関数

オープン関数です。

引数

[in]

pszObjectName

オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CSemaphore.cpp の 100 行目に定義があります。

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

                                                                 {
        // 処理ブロック
        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 = ::OpenSemaphoreW( SEMAPHORE_ALL_ACCESS, false, pszObjectName );
            if ( nullptr == m_hObject ) {
                // 失敗！
                break;
            }

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

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

呼び出し関係図:

bool LibCommon::CSemaphore::AddCount ( long  nCount, long &  rnPrev  )

virtualnoexcept

カウント加算関数

カウント加算関数です。

引数

[in]	nCount	加算カウント
[out]	rnPrev	直前のカウント参照

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CSemaphore.cpp の 138 行目に定義があります。

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

参照元 Release().

                                                                  {
        // 処理ブロック
        bool result = false;
        do {
            // セマフォカウントを加算する
            if ( 0 == ::ReleaseSemaphore( m_hObject, nCount, &rnPrev ) ) {
                // 失敗！
                break;
            }

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

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

被呼び出し関係図:

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

privatedelete

メンバ詳解

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

staticprotected

オブジェクト名拡張子

CSemaphore.h の 130 行目に定義があります。

参照元 AddCount(), Create(), Open().

---

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

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