bslmt_timedsemaphoreimpl_pthread.h

Go to the documentation of this file.

/// @file bslmt_timedsemaphoreimpl_pthread.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslmt_timedsemaphoreimpl_pthread.h                                 -*-C++-*-
#ifndef INCLUDED_BSLMT_TIMEDSEMAPHOREIMPL_PTHREAD
#define INCLUDED_BSLMT_TIMEDSEMAPHOREIMPL_PTHREAD
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslmt_timedsemaphoreimpl_pthread bslmt_timedsemaphoreimpl_pthread
/// @brief  Provide a POSIX implementation of `bslmt::TimedSemaphore`.
/// @addtogroup bsl
/// @{
/// @addtogroup bslmt
/// @{
/// @addtogroup bslmt_timedsemaphoreimpl_pthread
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslmt_timedsemaphoreimpl_pthread-purpose"> Purpose</a>
/// * <a href="#bslmt_timedsemaphoreimpl_pthread-classes"> Classes </a>
/// * <a href="#bslmt_timedsemaphoreimpl_pthread-description"> Description </a>
///   * <a href="#bslmt_timedsemaphoreimpl_pthread-supported-clock-types"> Supported Clock-Types </a>
///   * <a href="#bslmt_timedsemaphoreimpl_pthread-usage"> Usage </a>
///
/// # Purpose {#bslmt_timedsemaphoreimpl_pthread-purpose}
/// Provide a POSIX implementation of `bslmt::TimedSemaphore`.
///
/// # Classes {#bslmt_timedsemaphoreimpl_pthread-classes}
///
/// -  bslmt::TimedSemaphoreImpl<PthreadTimedSemaphore>: POSIX specialization
///
/// @see  bslmt_timedsemaphore
///
/// # Description {#bslmt_timedsemaphoreimpl_pthread-description}
/// This component provides an implementation of
/// `bslmt::TimedSemaphore`, `bslmt::TimedSemaphoreImpl<PthreadTimedSemaphore>`,
/// for POSIX threads ("pthreads") via the template specialization:
/// @code
/// bslmt::TimedSemaphoreImpl<Platform::PosixThreads>
/// @endcode
/// This template class should not be used (directly) by client code.  Clients
/// should instead use `bslmt::TimedSemaphore`.
///
/// ## Supported Clock-Types {#bslmt_timedsemaphoreimpl_pthread-supported-clock-types}
///
///
/// `bsls::SystemClockType` supplies the enumeration indicating the system clock
/// on which timeouts supplied to other methods should be based.  If the clock
/// type indicated at construction is `bsls::SystemClockType::e_REALTIME`, the
/// `absTime` argument passed to the `timedWait` method should be expressed as
/// an *absolute* offset since 00:00:00 UTC, January 1, 1970 (which matches the
/// epoch used in `bsls::SystemTime::now(bsls::SystemClockType::e_REALTIME)`.
/// If the clock type indicated at construction is
/// `bsls::SystemClockType::e_MONOTONIC`, the `absTime` argument passed to the
/// `timedWait` method should be expressed as an *absolute* offset since the
/// epoch of this clock (which matches the epoch used in
/// `bsls::SystemTime::now(bsls::SystemClockType::e_MONOTONIC)`.
///
/// ## Usage {#bslmt_timedsemaphoreimpl_pthread-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_timedsemaphoreimpl_pthread
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bslmt_platform.h>
 
#ifdef BSLMT_PLATFORM_POSIX_THREADS
 
// Platform specific implementation starts here.
 
#include <bsls_atomic.h>
#include <bsls_platform.h>
#include <bsls_systemclocktype.h>
#include <bsls_timeinterval.h>
 
#include <pthread.h>
 
 
namespace bslmt {
 
template <class TIMED_SEMAPHORE_POLICY>
class TimedSemaphoreImpl;
 
             // ===============================================
             // class TimedSemaphoreImpl<PthreadTimedSemaphore>
             // ===============================================
 
/// This class implements a portable semaphore type for thread
/// synchronization.
template<>
class TimedSemaphoreImpl<Platform::PthreadTimedSemaphore> {
 
    // DATA
    bsls::AtomicInt             d_resources;  // resources count
    bsls::AtomicInt             d_waiters;    // number of threads waiting
    pthread_mutex_t             d_lock;       // lock
    pthread_cond_t              d_condition;  // condition
    bsls::SystemClockType::Enum d_clockType;  // clock type
 
  private:
    // NOT IMPLEMENTED
    TimedSemaphoreImpl(const TimedSemaphoreImpl&);
    TimedSemaphoreImpl& operator=(const TimedSemaphoreImpl&);
 
    // PRIVATE MANIPULATORS
 
    /// Block until the count of this semaphore is potentially a positive
    /// value, or until the specified `absTime` timeout expires.  `absTime`
    /// is an *absolute* time represented as an interval from some epoch,
    /// which is determined by the clock indicated at construction (see
    /// {Supported Clock-Types} in the component documentation).  Return 0
    /// if the timeout did not expire, -1 if a timeout occurred, and -2 on
    /// error.
    int timedWaitImp(const bsls::TimeInterval& absTime);
 
  public:
    // TYPES
 
    /// The value `timedWait` returns when a timeout occurs.
    enum { e_TIMED_OUT = 1 };
 
    // CREATORS
 
    /// Create a timed semaphore initially having a count of 0.  Optionally
    /// specify a `clockType` indicating the type of the system clock
    /// against which the `bsls::TimeInterval` `absTime` timeouts passed to
    /// the `timedWait` method are to be interpreted (see {Supported
    /// Clock-Types} in the component documentation).  If `clockType` is not
    /// specified then the realtime system clock is used.  This method does
    /// not return normally unless there are sufficient system resources to
    /// construct the object.
    explicit
    TimedSemaphoreImpl(bsls::SystemClockType::Enum clockType
                                          = bsls::SystemClockType::e_REALTIME);
 
    /// Create a timed semaphore initially having the specified `count`.
    /// Optionally specify a `clockType` indicating the type of the system
    /// clock against which the `bsls::TimeInterval` `absTime` timeouts
    /// passed to the `timedWait` method are to be interpreted (see
    /// {Supported Clock-Types} in the component documentation).  If
    /// `clockType` is not specified then the realtime system clock is used.
    /// This method does not return normally unless there are sufficient
    /// system resources to construct the object.
    explicit
    TimedSemaphoreImpl(int                         count,
                       bsls::SystemClockType::Enum clockType
                                          = bsls::SystemClockType::e_REALTIME);
 
    /// Destroy this semaphore object.
    ~TimedSemaphoreImpl();
 
    // MANIPULATORS
 
    /// Atomically increment the count of the semaphore.
    void post();
 
    /// Atomically increment the count by the specified `number` of the semaphore.  
    /// 
    /// \pre The behavior is undefined   unless `number` is a positive
    /// value.
    void post(int number);
 
    /// Block until the count of this semaphore is a positive value, or
    /// until the specified `absTime` timeout expires.  `absTime` is an
    /// *absolute* time represented as an interval from some epoch, which is
    /// determined by the clock indicated at construction (see {Supported
    /// Clock-Types} in the component documentation).  If the `absTime`
    /// timeout did not expire before the count attained a positive value,
    /// atomically decrement the count and return 0; otherwise, return a
    /// non-zero value with no effect on the count.
    int timedWait(const bsls::TimeInterval& absTime);
 
    /// Decrement the count of this semaphore if it is positive and return
    /// 0.  Return a non-zero value otherwise.
    int tryWait();
 
    /// Block until the count is a positive value and atomically decrement
    /// it.
    void wait();
 
    // ACCESSORS
 
    /// Return the clock type used for timeouts.
    bsls::SystemClockType::Enum clockType() const;
};
 
}  // close package namespace
 
 
#endif  // BSLMT_PLATFORM_POSIX_THREADS
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2023 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */