---

winstl_thread_mutex.h

Go to the documentation of this file.

/* 
 * File:        winstl_thread_mutex.h (originally MWCrtSct.h, ::SynesisWin)
 *
 * Purpose:     Intra-process mutex, based on Windows CRITICAL_SECTION.
 *
 * Date:        17th December 1996
 * Updated:     11th September 2004
 *
 * Home:        http://stlsoft.org/
 *
 * Copyright (c) 2002-2004, Matthew Wilson and Synesis Software
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
 *   any contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * 



#ifndef WINSTL_INCL_H_WINSTL_THREAD_MUTEX
#define WINSTL_INCL_H_WINSTL_THREAD_MUTEX

#ifndef __STLSOFT_DOCUMENTATION_SKIP_SECTION
# define WINSTL_VER_H_WINSTL_THREAD_MUTEX_MAJOR     2
# define WINSTL_VER_H_WINSTL_THREAD_MUTEX_MINOR     0
# define WINSTL_VER_H_WINSTL_THREAD_MUTEX_REVISION  1
# define WINSTL_VER_H_WINSTL_THREAD_MUTEX_EDIT      25
#endif /* !__STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* 
 * Includes
 */

#ifndef WINSTL_INCL_H_WINSTL
# include "winstl.h"    // Include the WinSTL root header
#endif /* !WINSTL_INCL_H_WINSTL */

/* 
 * Namespace
 */

#ifndef _WINSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(__STLSOFT_DOCUMENTATION_SKIP_SECTION)
/* There is no stlsoft namespace, so must define ::winstl */
namespace winstl
{
# else
/* Define stlsoft::winstl_project */

namespace stlsoft
{

namespace winstl_project
{

# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_WINSTL_NO_NAMESPACE */

/* 
 * Spin-count support
 */

#ifdef __WINSTL_THREAD_MUTEX_SPIN_COUNT_SUPPORT
# undef __WINSTL_THREAD_MUTEX_SPIN_COUNT_SUPPORT
#endif /* __WINSTL_THREAD_MUTEX_SPIN_COUNT_SUPPORT */

#ifdef __WINSTL_THREAD_MUTEX_TRY_LOCK_SUPPORT
# undef __WINSTL_THREAD_MUTEX_TRY_LOCK_SUPPORT
#endif /* __WINSTL_THREAD_MUTEX_TRY_LOCK_SUPPORT */

#if defined(_WIN32_WINNT) && \
    _WIN32_WINNT >= 0x0403
# define __WINSTL_THREAD_MUTEX_SPIN_COUNT_SUPPORT
#endif /* _WIN32_WINNT >= 0x0403 */

#if defined(_WIN32_WINNT) && \
    _WIN32_WINNT >= 0x0400
# define __WINSTL_THREAD_MUTEX_TRY_LOCK_SUPPORT
#endif /* _WIN32_WINNT >= 0x0400 */

/* 
 * Classes
 */

// class thread_mutex
class thread_mutex
{
public:
    typedef thread_mutex class_type;

// Construction
public:
    thread_mutex() winstl_throw_0()
    {
        ::InitializeCriticalSection(&m_cs);
    }
#if defined(__WINSTL_THREAD_MUTEX_SPIN_COUNT_SUPPORT)
    thread_mutex(ws_dword_t spinCount) winstl_throw_0()
    {
        ::InitializeCriticalSectionAndSpinCount(&m_cs, spinCount);
    }
#endif /* __WINSTL_THREAD_MUTEX_SPIN_COUNT_SUPPORT */

    ~thread_mutex() winstl_throw_0()
    {
        ::DeleteCriticalSection(&m_cs);
    }

// Operations
public:
    void lock() winstl_throw_0()
    {
        ::EnterCriticalSection(&m_cs);
    }
#if defined(__WINSTL_THREAD_MUTEX_TRY_LOCK_SUPPORT)
    bool try_lock()
    {
        return ::TryEnterCriticalSection(&m_cs) != FALSE;
    }
#endif /* __WINSTL_THREAD_MUTEX_TRY_LOCK_SUPPORT */

    void unlock() winstl_throw_0()
    {
        ::LeaveCriticalSection(&m_cs);
    }

#if defined(__WINSTL_THREAD_MUTEX_SPIN_COUNT_SUPPORT)
    ws_dword_t set_spin_count(ws_dword_t spinCount) winstl_throw_0()
    {
        return ::SetCriticalSectionSpinCount(&m_cs, spinCount);
    }
#endif /* __WINSTL_THREAD_MUTEX_SPIN_COUNT_SUPPORT */

// Members
private:
    CRITICAL_SECTION    m_cs;   // critical section

// Not to be implemented
private:
    thread_mutex(class_type const &rhs);
    thread_mutex &operator =(class_type const &rhs);
};

/* 
 * Control shims
 */

#ifndef _WINSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(__STLSOFT_DOCUMENTATION_SKIP_SECTION)
} // namespace winstl
# else
} // namespace winstl_project
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_WINSTL_NO_NAMESPACE */





inline void lock_instance(winstl_ns_qual(thread_mutex) &mx)
{
    mx.lock();
}

inline void unlock_instance(winstl_ns_qual(thread_mutex) &mx)
{
    mx.unlock();
}


#ifndef _WINSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(__STLSOFT_DOCUMENTATION_SKIP_SECTION)
namespace winstl {
# else
namespace winstl_project {
#  if defined(__STLSOFT_COMPILER_IS_BORLAND)
using ::stlsoft::lock_instance;
using ::stlsoft::unlock_instance;
#  endif /* __STLSOFT_COMPILER_IS_BORLAND */
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_WINSTL_NO_NAMESPACE */

/* 
 * lock_traits (for the compilers that do not support Koenig Lookup)
 */

// class lock_traits
struct thread_mutex_lock_traits
{
public:
    typedef thread_mutex                lock_type;
    typedef thread_mutex_lock_traits    class_type;

// Operations
public:
    static void lock(thread_mutex &c)
    {
        lock_instance(c);
    }

    static void unlock(thread_mutex &c)
    {
        unlock_instance(c);
    }
};

// Unit-testing

#ifdef STLSOFT_UNITTEST

namespace unittest
{
    ss_bool_t test_winstl_thread_mutex(unittest_reporter *r)
    {
        using stlsoft::unittest::unittest_initialiser;

        ss_bool_t               bSuccess    =   true;

        unittest_initialiser    init(r, "WinSTL", "thread_mutex", __FILE__);

        thread_mutex   mx_r;

        mx_r.lock();
#if defined(__WINSTL_THREAD_MUTEX_TRY_LOCK_SUPPORT)
        if(!mx_r.try_lock())
        {
            r->report("process_mutex (recursive) could not lock recursively ", __LINE__);
            bSuccess = false;
        }
        else
        {
            mx_r.unlock();
        }
#endif /* __WINSTL_THREAD_MUTEX_TRY_LOCK_SUPPORT */
        mx_r.unlock();

        return bSuccess;
    }

    unittest_registrar    unittest_winstl_thread_mutex(test_winstl_thread_mutex);

} // namespace unittest

#endif /* STLSOFT_UNITTEST */

/* 

#ifndef _WINSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(__STLSOFT_DOCUMENTATION_SKIP_SECTION)
} // namespace winstl
# else
} // namespace winstl_project
} // namespace stlsoft
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_WINSTL_NO_NAMESPACE */

/* 

#endif /* !WINSTL_INCL_H_WINSTL_THREAD_MUTEX */

/* 

STLSoft Libraries documentation © Synesis Software Pty Ltd, 2001-2004