semaphore.hpp

新版本TR1的stl

/* /////////////////////////////////////////////////////////////////////////
 * File:        winstl/synch/semaphore.hpp
 *
 * Purpose:     Semaphore class, based on Win32 kernel semaphore object.
 *
 * Created:     30th May 2006
 * Updated:     23rd April 2007
 *
 * Home:        http://stlsoft.org/
 *
 * Copyright (c) 2006-2007, 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.
 *
 * ////////////////////////////////////////////////////////////////////// */


/** \file winstl/synch/semaphore.hpp
 *
 * \brief [C++ only] Definition of winstl::semaphore class
 *   (\ref group__library__synch "Synchronisation" Library).
 */

#ifndef WINSTL_INCL_WINSTL_SYNCH_HPP_SEMAPHORE
#define WINSTL_INCL_WINSTL_SYNCH_HPP_SEMAPHORE

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define WINSTL_VER_WINSTL_SYNCH_HPP_SEMAPHORE_MAJOR    1
# define WINSTL_VER_WINSTL_SYNCH_HPP_SEMAPHORE_MINOR    3
# define WINSTL_VER_WINSTL_SYNCH_HPP_SEMAPHORE_REVISION 1
# define WINSTL_VER_WINSTL_SYNCH_HPP_SEMAPHORE_EDIT     19
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Includes
 */

#ifndef WINSTL_INCL_WINSTL_H_WINSTL
# include <winstl/winstl.h>
#endif /* !WINSTL_INCL_WINSTL_H_WINSTL */
#ifndef STLSOFT_INCL_STLSOFT_SYNCH_HPP_CONCEPTS
# include <stlsoft/synch/concepts.hpp>
#endif /* !STLSOFT_INCL_STLSOFT_SYNCH_HPP_CONCEPTS */
#ifndef WINSTL_INCL_WINSTL_SYNCH_ERROR_HPP_EXCEPTIONS
# include <winstl/synch/error/exceptions.hpp>
#endif /* !WINSTL_INCL_WINSTL_SYNCH_ERROR_HPP_EXCEPTIONS */

/* /////////////////////////////////////////////////////////////////////////
 * 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 */

/* /////////////////////////////////////////////////////////////////////////
 * Classes
 */

// class semaphore
/** This class acts as an semaphore based on the Win32
 *   kernel semaphore object
 *
 * \ingroup group__library__synch
 */
class semaphore
    : public stlsoft_ns_qual(critical_section)< STLSOFT_CRITICAL_SECTION_ISNOT_RECURSIVE
                                            ,   STLSOFT_CRITICAL_SECTION_IS_TRYABLE
                                            >
    , public stlsoft_ns_qual(synchronisable_object_tag)
{
public:
    /// This type
    typedef semaphore       class_type;
    /// The synchronisation handle type
    typedef HANDLE          synch_handle_type;
    /// The Boolean type
    typedef ws_bool_t       bool_type;
    /// The count type
    typedef ws_size_t       count_type;
    /// The resource type
    typedef HANDLE          resource_type;

public:
    enum
    {
        maxCountValue   =   0x7fffffff  ///!< Borrowed from PThreads-win32
    };

/// \name Construction
/// @{
public:
    /// Conversion constructor
    semaphore(synch_handle_type sem, bool_type bTakeOwnership)
        : m_sem(sem)
        , m_maxCount(0)
        , m_bOwnHandle(bTakeOwnership)
    {
        WINSTL_ASSERT(NULL != sem);
    }
    /// Creates an instance of the semaphore
    ss_explicit_k semaphore(count_type initialCount, count_type maxCount = maxCountValue)
        : m_sem(create_semaphore_(NULL, initialCount, maxCount, static_cast<ws_char_a_t const*>(NULL)))
        , m_maxCount(maxCount)
        , m_bOwnHandle(true)
    {}
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
    // This disambiguates cases where the initial count is 0
    ss_explicit_k semaphore(int initialCount, count_type maxCount = maxCountValue)
        : m_sem(create_semaphore_(NULL, static_cast<count_type>(initialCount), maxCount, static_cast<ws_char_a_t const*>(NULL)))
        , m_maxCount(maxCount)
        , m_bOwnHandle(true)
    {}
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
    /// Creates an instance of the semaphore
    ss_explicit_k semaphore(ws_char_a_t const* name, count_type initialCount, count_type maxCount = maxCountValue)
        : m_sem(create_semaphore_(NULL, initialCount, maxCount, name))
        , m_maxCount(maxCount)
        , m_bOwnHandle(true)
    {}
    /// Creates an instance of the semaphore
    ss_explicit_k semaphore(ws_char_w_t const* name, count_type initialCount, count_type maxCount = maxCountValue)
        : m_sem(create_semaphore_(NULL, initialCount, maxCount, name))
        , m_maxCount(maxCount)
        , m_bOwnHandle(true)
    {}
    /// Creates an instance of the semaphore
    ss_explicit_k semaphore(ws_char_a_t const* name, LPSECURITY_ATTRIBUTES psa, count_type initialCount, count_type maxCount = maxCountValue)
        : m_sem(create_semaphore_(psa, initialCount, maxCount, name))
        , m_maxCount(maxCount)
        , m_bOwnHandle(true)
    {}
    /// Creates an instance of the semaphore
    ss_explicit_k semaphore(ws_char_w_t const* name, LPSECURITY_ATTRIBUTES psa, count_type initialCount, count_type maxCount = maxCountValue)
        : m_sem(create_semaphore_(psa, initialCount, maxCount, name))
        , m_maxCount(maxCount)
        , m_bOwnHandle(true)
    {}

    /// Destroys an instance of the semaphore
    ~semaphore() stlsoft_throw_0()
    {
        if( NULL != m_sem &&
            m_bOwnHandle)
        {
            ::CloseHandle(m_sem);
        }
    }
/// @}

/// \name Operations
/// @{
public:
    /// Acquires a lock on the semaphore, pending the thread until the lock is aquired
    void lock()
    {
        WINSTL_ASSERT(NULL != m_sem);

        DWORD   dwRes   =   ::WaitForSingleObject(m_sem, INFINITE);

        if(WAIT_OBJECT_0 != dwRes)
        {
#ifdef STLSOFT_CF_EXCEPTION_SUPPORT
            STLSOFT_THROW_X(synchronisation_exception("semaphore wait failed", ::GetLastError()));
#endif /* STLSOFT_CF_EXCEPTION_SUPPORT */
        }
    }
    /// Acquires a lock on the semaphore, pending the thread until the lock is aquired
    bool_type lock(ws_dword_t wait)
    {
        WINSTL_ASSERT(NULL != m_sem);

        DWORD   dwRes   =   ::WaitForSingleObject(m_sem, wait);

        if( WAIT_OBJECT_0 != dwRes &&
            WAIT_TIMEOUT != dwRes)
        {
#ifdef STLSOFT_CF_EXCEPTION_SUPPORT
            STLSOFT_THROW_X(synchronisation_exception("semaphore wait failed", ::GetLastError()));
#endif /* STLSOFT_CF_EXCEPTION_SUPPORT */
        }

        return (dwRes == WAIT_OBJECT_0);
    }
    /// Attempts to lock the semaphore
    ///
    /// \return <b>true</b> if the semaphore was aquired, or <b>false</b> if not
    bool_type try_lock()
    {
        return lock(0);
    }
    /// Releases an aquired lock on the semaphore, increasing the
    ///  semaphore's counter by one.
    ///
    /// \note Equivalent to \link winstl::semaphore::unlock(count_type) unlock()\endlink.
    void unlock()