bslmt_recursivemuteximpl_win32.h

Go to the documentation of this file.

/// @file bslmt_recursivemuteximpl_win32.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslmt_recursivemuteximpl_win32.h                                   -*-C++-*-
#ifndef INCLUDED_BSLMT_RECURSIVEMUTEXIMPL_WIN32
#define INCLUDED_BSLMT_RECURSIVEMUTEXIMPL_WIN32
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslmt_recursivemuteximpl_win32 bslmt_recursivemuteximpl_win32
/// @brief  Provide a win32 implementation of `bslmt::RecursiveMutex`.
/// @addtogroup bsl
/// @{
/// @addtogroup bslmt
/// @{
/// @addtogroup bslmt_recursivemuteximpl_win32
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslmt_recursivemuteximpl_win32-purpose"> Purpose</a>
/// * <a href="#bslmt_recursivemuteximpl_win32-classes"> Classes </a>
/// * <a href="#bslmt_recursivemuteximpl_win32-description"> Description </a>
///   * <a href="#bslmt_recursivemuteximpl_win32-usage"> Usage </a>
///
/// # Purpose {#bslmt_recursivemuteximpl_win32-purpose}
/// Provide a win32 implementation of `bslmt::RecursiveMutex`.
///
/// # Classes {#bslmt_recursivemuteximpl_win32-classes}
///
/// -  bslmt::RecursiveMutexImpl<Win32Threads>: win32 specialization
///
/// @see  bslmt_recursivemutex
///
/// # Description {#bslmt_recursivemuteximpl_win32-description}
/// This component provides an implementation of
/// `bslmt::RecursiveMutex` for Windows (win32),
/// `bslmt::RecursiveMutexImpl<Win32Threads>`, via the template specialization:
/// @code
/// bslmt::RecursiveMutexImpl<Platform::Win32Threads>
/// @endcode
/// This template class should not be used (directly) by client code.  Clients
/// should instead use `bslmt::RecursiveMutex`.
///
/// ## Usage {#bslmt_recursivemuteximpl_win32-usage}
///
///
/// This component is an implementation detail of `bslmt` and is *not* intended
/// for direct client use.  It is subject to change without notice.  As such, a
/// usage example is not provided.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslmt
 * @{
 */
/** @addtogroup bslmt_recursivemuteximpl_win32
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bslmt_platform.h>
 
#ifdef BSLMT_PLATFORM_WIN32_THREADS
 
// Platform specific implementation starts here.
 
#include <bslmt_muteximpl_win32.h>
 
 
namespace bslmt {
 
template <class THREAD_POLICY>
class RecursiveMutexImpl;
 
             // ================================================
             // class RecursiveMutexImpl<Platform::Win32Threads>
             // ================================================
 
/// This class provides a full specialization of `RecursiveMutexImpl` for
/// Windows.  Since the Windows specialization of `MutexImpl` is recursive,
/// this type is effectively an alias for that one.
template <>
class RecursiveMutexImpl<Platform::Win32Threads>
: public MutexImpl<Platform::Win32Threads> {
};
 
}  // close package namespace
 
 
#endif  // BSLMT_PLATFORM_WIN32_THREADS
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2015 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */