CicFileMappingStatic Class Reference

#include <cicfmap.h>

Inheritance diagram for CicFileMappingStatic:

Collaboration diagram for CicFileMappingStatic:

Public Member Functions
	CicFileMappingStatic ()
	~CicFileMappingStatic ()
void	Init (LPCTSTR pszName, CicMutex *pMutex)
LPVOID	Create (LPSECURITY_ATTRIBUTES pSA, DWORD dwMaximumSizeLow, LPBOOL pbAlreadyExists)
LPVOID	Open ()
void	Close ()
BOOL	Enter ()
void	Leave ()
BOOL	Flush (SIZE_T dwNumberOfBytesToFlush)
void	Finalize ()

Protected Member Functions
LPVOID	_Map ()

Protected Attributes
LPCTSTR	m_pszName
LPVOID	m_pView
HANDLE	m_hMapping
BOOL	m_bCreated
BOOL	m_bHasMutex
CicMutex *	m_pMutex

Detailed Description

Definition at line 15 of file cicfmap.h.

Constructor & Destructor Documentation

CicFileMappingStatic()

CicFileMappingStatic::CicFileMappingStatic ( )

inline

Definition at line 28 of file cicfmap.h.

{ }

~CicFileMappingStatic()

CicFileMappingStatic::~CicFileMappingStatic ( )

inline

Definition at line 29 of file cicfmap.h.

{ }

Member Function Documentation

_Map()

LPVOID CicFileMappingStatic::_Map ( )

protected

Definition at line 84 of file cicfmap.cpp.

{
    m_pView = ::MapViewOfFile(m_hMapping, FILE_MAP_WRITE, 0, 0, 0);
    if (!m_pView)
    {
        Close();
        return NULL;
    }
    return m_pView;
}

Referenced by Create(), and Open().

Close()

void CicFileMappingStatic::Close

(

)

Definition at line 22 of file cicfmap.cpp.

{
    if (m_pView)
    {
        ::UnmapViewOfFile(m_pView);
        m_pView = NULL;
    }
 
    if (m_hMapping)
    {
        ::CloseHandle(m_hMapping);
        m_hMapping = NULL;
    }
 
    m_bCreated = FALSE;
}

Referenced by _Map(), Finalize(), and ProcessDetach().

Create()

LPVOID CicFileMappingStatic::Create	(	LPSECURITY_ATTRIBUTES	pSA,
		DWORD	dwMaximumSizeLow,
		LPBOOL	pbAlreadyExists
	)

Definition at line 50 of file cicfmap.cpp.

{
    if (!m_pszName)
        return NULL;
 
    m_hMapping = ::CreateFileMapping(INVALID_HANDLE_VALUE,
                                     pSA,
                                     PAGE_READWRITE,
                                     0,
                                     dwMaximumSizeLow,
                                     m_pszName);
    if (pbAlreadyExists)
        *pbAlreadyExists = (::GetLastError() == ERROR_ALREADY_EXISTS);
    if (!m_hMapping)
        return NULL;
 
    m_bCreated = TRUE;
    return _Map();
}

Enter()

BOOL CicFileMappingStatic::Enter

(

)

Definition at line 95 of file cicfmap.cpp.

{
    if (!m_bHasMutex)
        return TRUE;
    return m_pMutex->Enter();
}

Finalize()

void CicFileMappingStatic::Finalize

(

)

Definition at line 116 of file cicfmap.cpp.

{
    if (!m_bHasMutex)
        return;
 
    Close();
    Leave();
}

Referenced by ProcessDetach(), and CicFileMapping::~CicFileMapping().

Flush()

BOOL CicFileMappingStatic::Flush

(

SIZE_T

dwNumberOfBytesToFlush

)

Definition at line 109 of file cicfmap.cpp.

{
    if (!m_pView)
        return FALSE;
    return ::FlushViewOfFile(m_pView, dwNumberOfBytesToFlush);
}

Init()

void CicFileMappingStatic::Init	(	LPCTSTR	pszName,
		CicMutex *	pMutex
	)

Definition at line 39 of file cicfmap.cpp.

{
    if (pMutex)
        m_pMutex = pMutex;
 
    m_bCreated = FALSE;
    m_pszName = pszName;
    m_bHasMutex = (pMutex != NULL);
}

Leave()

void CicFileMappingStatic::Leave

(

)

Definition at line 102 of file cicfmap.cpp.

{
    if (!m_bHasMutex)
        return;
    m_pMutex->Leave();
}

Referenced by Finalize().

Open()

LPVOID CicFileMappingStatic::Open

(

)

Definition at line 73 of file cicfmap.cpp.

{
    if (!m_pszName)
        return NULL;
    m_hMapping = ::OpenFileMapping(FILE_MAP_ALL_ACCESS, FALSE, m_pszName);
    if (!m_hMapping)
        return NULL;
 
    return _Map();
}

Member Data Documentation

m_bCreated

BOOL CicFileMappingStatic::m_bCreated

protected

Definition at line 21 of file cicfmap.h.

Referenced by CicFileMapping::CicFileMapping(), Close(), Create(), and Init().

m_bHasMutex

BOOL CicFileMappingStatic::m_bHasMutex

protected

Definition at line 22 of file cicfmap.h.

Referenced by CicFileMapping::CicFileMapping(), Enter(), Finalize(), Init(), and Leave().

m_hMapping

HANDLE CicFileMappingStatic::m_hMapping

protected

Definition at line 20 of file cicfmap.h.

Referenced by _Map(), CicFileMapping::CicFileMapping(), Close(), Create(), and Open().

m_pMutex

CicMutex* CicFileMappingStatic::m_pMutex

protected

Definition at line 23 of file cicfmap.h.

Referenced by CicFileMapping::CicFileMapping(), Enter(), Init(), and Leave().

m_pszName

LPCTSTR CicFileMappingStatic::m_pszName

protected

Definition at line 18 of file cicfmap.h.

Referenced by CicFileMapping::CicFileMapping(), Create(), Init(), and Open().

m_pView

LPVOID CicFileMappingStatic::m_pView

protected

Definition at line 19 of file cicfmap.h.

Referenced by _Map(), CicFileMapping::CicFileMapping(), Close(), and Flush().

---

The documentation for this class was generated from the following files:

• sdk/lib/cicero/cicfmap.h
• sdk/lib/cicero/cicfmap.cpp