LibCommon::CMapping クラス

マッピングクラス [詳解]

#include "CMapping.h"

LibCommon::CMapping の継承関係図

LibCommon::CMapping 連携図

公開メンバ関数
	CMapping () noexcept
	コンストラクタ [詳解]
virtual	~CMapping () noexcept
	デストラクタ [詳解]
virtual HANDLE	GetHandle () const noexcept override
	マッピングハンドル取得関数 [詳解]
virtual LPVOID	GetView () const noexcept
	ビューポインタ取得関数 [詳解]
virtual void	Close () noexcept override
	クローズ関数 [詳解]
virtual bool	Create (DWORD dwSize, wchar_t const *pszObjectName=nullptr) noexcept
	作成関数 [詳解]
virtual bool	Open (wchar_t const *pszObjectName) noexcept override
	オープン関数 [詳解]
基底クラス LibCommon::CMutex に属する継承公開メンバ関数
	CMutex () noexcept
	コンストラクタ [詳解]
virtual	~CMutex () noexcept
	デストラクタ [詳解]
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
	作成関数 [詳解]
基底クラス LibCommon::CSync に属する継承公開メンバ関数
	CSync () noexcept
	コンストラクタ [詳解]
virtual	~CSync () noexcept
	デストラクタ [詳解]
virtual bool	IsCreate () const noexcept
	新規作成状態取得関数 [詳解]
virtual bool	Wait (DWORD dwTime=INFINITE) noexcept
	ウェイト関数 [詳解]

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

静的限定公開変数類
static wchar_t const *const	OBJECT_NAME_EXT = L".CMapping"
	オブジェクト名拡張子 [詳解]
基底クラス LibCommon::CMutex に属する継承静的限定公開変数類
static wchar_t const *const	OBJECT_NAME_EXT = L".CMutex"
	オブジェクト名拡張子 [詳解]

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

詳解

マッピングクラス

マッピングクラスです。

注意

なし

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

構築子と解体子

LibCommon::CMapping::CMapping ( )

explicitnoexcept

コンストラクタ

コンストラクタです。

引数

なし

戻り値

なし

注意

なし

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

        : CMutex()
        // メンバ変数初期化
        , m_hMapping( nullptr )
        , m_pView( nullptr )
    {}

LibCommon::CMapping::~CMapping ( )

virtualnoexcept

デストラクタ

デストラクタです。

引数

なし

戻り値

なし

注意

なし

CMapping.cpp の 39 行目に定義があります。

参照先 Close().

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

呼び出し関係図:

LibCommon::CMapping::CMapping ( CMapping const &  )

privatedelete

関数詳解

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

inlineoverridevirtualnoexcept

マッピングハンドル取得関数

マッピングハンドル取得関数です。

引数

なし

戻り値

マッピングハンドル

注意

オーバーライド関数です。

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

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

{ return m_hMapping; }

virtual LPVOID LibCommon::CMapping::GetView ( ) const

inlinevirtualnoexcept

ビューポインタ取得関数

ビューポインタ取得関数です。

引数

なし

戻り値

ビューポインタ

注意

なし

CMapping.h の 79 行目に定義があります。

参照元 LibLogOut::CLibLogOut::CLibLogOut(), LibNewDel::CLibNewDel::CLibNewDel().

{ return m_pView; }

被呼び出し関係図:

void LibCommon::CMapping::Close ( )

overridevirtualnoexcept

クローズ関数

クローズ関数です。

引数

なし

戻り値

なし

注意

オーバーライド関数です。

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

CMapping.cpp の 48 行目に定義があります。

参照先 LibCommon::CMutex::Close(), m_hMapping, m_pView.

参照元 LibLogOut::CLibLogOut::CLibLogOut(), LibNewDel::CLibNewDel::CLibNewDel(), Create(), Open(), ~CMapping().

                                  {
        // ビューマップを解放する
        ::UnmapViewOfFile( m_pView );

        // マッピングをクローズする
        ::CloseHandle( m_hMapping );

        // メンバ変数を初期化する
        m_hMapping = nullptr;
        m_pView    = nullptr;

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

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CMapping::Create ( DWORD  dwSize, wchar_t const *  pszObjectName = nullptr  )

virtualnoexcept

作成関数

作成関数です。

引数

[in]	dwSize	共有メモリサイズ
[in]	pszObjectName	オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CMapping.cpp の 65 行目に定義があります。

参照先 LibCommon::CMutex::Close(), Close(), LibCommon::CMutex::Create(), LibCommon::CSync::m_bIsCreate, m_hMapping, m_pView, OBJECT_NAME_EXT.

参照元 LibLogOut::CLibLogOut::CLibLogOut(), LibNewDel::CLibNewDel::CLibNewDel().

                                                                               {
        // 処理ブロック
        bool result = false;
        do {
            // マッピングハンドルを調べる
            if ( nullptr != m_hMapping ) {
                // クローズする
                Close();
            }
            // ミューテックスを作成する
            else if ( !CMutex::Create( pszObjectName ) ) {
                // 失敗！
                break;
            }
            // 同期処理ブロック
            else do {
                CSyncAuto cSyncAuto( *this );

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

                // マッピングを作成する
                m_hMapping = ::CreateFileMappingW( nullptr, nullptr, PAGE_READWRITE, 0, dwSize, pszObjectName );
                if ( nullptr == m_hMapping ) {
                    // 失敗！
                    break;
                }

                // ビューメモリをマップする
                m_pView = ::MapViewOfFile( m_hMapping, FILE_MAP_ALL_ACCESS, 0, 0, 0 );
                if ( nullptr == m_pView ) {
                    // マッピングをクローズする
                    ::CloseHandle( m_hMapping );
                    m_hMapping = nullptr;

                    // 失敗！
                    break;
                }
                // 新規作成フラグを調べる
                else if ( m_bIsCreate ) {
                    // メモリをクリアする
                    ::memset( m_pView, 0, dwSize );
                }

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

            // 実行結果を調べる
            if ( !result ) {
                // ミューテックスをクローズする
                CMutex::Close();
            }
        } while ( false );

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

呼び出し関係図:

被呼び出し関係図:

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

overridevirtualnoexcept

オープン関数

オープン関数です。

引数

[in]

pszObjectName

オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

オーバーライド関数です。

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

CMapping.cpp の 132 行目に定義があります。

参照先 LibCommon::CMutex::Close(), Close(), m_hMapping, m_pView, OBJECT_NAME_EXT, LibCommon::CMutex::Open().

                                                               {
        // 処理ブロック
        bool result = false;
        do {
            // オブジェクト名を調べる
            if ( nullptr == pszObjectName ) {
                // 失敗！
                break;
            }
            // マッピングハンドルを調べる
            else if ( nullptr != m_hMapping ) {
                // クローズする
                Close();
            }
            // ミューテックスをオープンする
            else if ( !CMutex::Open( pszObjectName ) ) {
                // 失敗！
                break;
            }
            // 同期処理ブロック
            else do {
                CSyncAuto cSyncAuto( *this );

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

                // マッピングをオープンする
                m_hMapping = ::OpenFileMappingW( FILE_MAP_ALL_ACCESS, false, pszObjectName );
                if ( nullptr == m_hMapping ) {
                    // 失敗！
                    break;
                }

                // ビューメモリをマップする
                m_pView = ::MapViewOfFile( m_hMapping, FILE_MAP_ALL_ACCESS, 0, 0, 0 );
                if ( nullptr == m_pView ) {
                    // マッピングをクローズする
                    ::CloseHandle( m_hMapping );
                    m_hMapping = nullptr;

                    // 失敗！
                    break;
                }

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

            // 実行結果を調べる
            if ( !result ) {
                // ミューテックスをクローズする
                CMutex::Close();
            }
        } while ( false );

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

呼び出し関係図:

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

privatedelete

メンバ詳解

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

staticprotected

オブジェクト名拡張子

CMapping.h の 125 行目に定義があります。

参照元 Create(), Open().

HANDLE LibCommon::CMapping::m_hMapping

protected

マッピングハンドル

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

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

LPVOID LibCommon::CMapping::m_pView

protected

ビューポインタ

CMapping.h の 131 行目に定義があります。

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

---

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

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