bslmt_timedsemaphoreimpl_posixadv.h

Go to the documentation of this file.

/// @file bslmt_timedsemaphoreimpl_posixadv.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslmt_timedsemaphoreimpl_posixadv.h                                -*-C++-*-
#ifndef INCLUDED_BSLMT_TIMEDSEMAPHOREIMPL_POSIXADV
#define INCLUDED_BSLMT_TIMEDSEMAPHOREIMPL_POSIXADV
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslmt_timedsemaphoreimpl_posixadv bslmt_timedsemaphoreimpl_posixadv
/// @brief  Provide "advanced" POSIX implementation of `bslmt::TimedSemaphore`.
/// @addtogroup bsl
/// @{
/// @addtogroup bslmt
/// @{
/// @addtogroup bslmt_timedsemaphoreimpl_posixadv
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslmt_timedsemaphoreimpl_posixadv-purpose"> Purpose</a>
/// * <a href="#bslmt_timedsemaphoreimpl_posixadv-classes"> Classes </a>
/// * <a href="#bslmt_timedsemaphoreimpl_posixadv-description"> Description </a>
///   * <a href="#bslmt_timedsemaphoreimpl_posixadv-supported-clock-types"> Supported Clock-Types </a>
///   * <a href="#bslmt_timedsemaphoreimpl_posixadv-usage"> Usage </a>
///
/// # Purpose {#bslmt_timedsemaphoreimpl_posixadv-purpose}
/// Provide "advanced" POSIX implementation of `bslmt::TimedSemaphore`.
///
/// # Classes {#bslmt_timedsemaphoreimpl_posixadv-classes}
///
/// -  bslmt::TimedSemaphoreImpl<PosixAdvTimedSemaphore>: POSIXa specialization
///
/// @see  bslmt_timedsemaphore
///
/// # Description {#bslmt_timedsemaphoreimpl_posixadv-description}
/// This component provides an implementation of
/// `bslmt::TimedSemaphore`,
/// `bslmt::TimedSemaphoreImpl<PosixAdvTimedSemaphore>`, for conforming POSIX
/// platforms via the template specialization:
/// @code
/// bslmt::TimedSemaphoreImpl<Platform::PosixAdvTimedSemaphore>
/// @endcode
/// This template class should not be used (directly) by client code.  Clients
/// should instead use `bslmt::TimedSemaphore`.
///
/// This implementation of `bslmt::TimedSemaphore` is preferred over that
/// defined in @ref bslmt_timedsemaphoreimpl_pthread  on platforms that support
/// advanced realtime POSIX extensions (e.g., @ref sem_timedwait ).
///
/// ## Supported Clock-Types {#bslmt_timedsemaphoreimpl_posixadv-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_posixadv-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_posixadv
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bslmt_platform.h>
 
#ifdef BSLMT_PLATFORM_POSIXADV_TIMEDSEMAPHORE
 
// Platform-specific implementation starts here.
 
#include <bsls_assert.h>
#include <bsls_systemclocktype.h>
#include <bsls_timeinterval.h>
 
#include <semaphore.h>
 
 
namespace bslmt {
 
template <class TIMED_SEMAPHORE_POLICY>
class TimedSemaphoreImpl;
 
             // ================================================
             // class TimedSemaphoreImpl<PosixAdvTimedSemaphore>
             // ================================================
 
/// This class implements a timed semaphore in terms of POSIX operations. 
/// 
/// \note Note that   only certain platforms provide @ref sem_timedwait ; on those that
/// do not, `TimedSemaphoreImpl<PthreadTimedSemaphore>` is used.
template <>
class TimedSemaphoreImpl<Platform::PosixAdvTimedSemaphore> {
 
    // DATA
    sem_t                       d_sem;        // POSIX timed semaphore
 
    bsls::SystemClockType::Enum d_clockType;  // clock type used for 'absTime'
                                              // in 'timedWait'
 
  private:
    // NOT IMPLEMENTED
    TimedSemaphoreImpl(const TimedSemaphoreImpl&);
    TimedSemaphoreImpl& operator=(const TimedSemaphoreImpl&);
 
  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;
};
 
// ============================================================================
//                             INLINE DEFINITIONS
// ============================================================================
 
             // ------------------------------------------------
             // class TimedSemaphoreImpl<PosixAdvTimedSemaphore>
             // ------------------------------------------------
 
// CREATORS
inline
TimedSemaphoreImpl<bslmt::Platform::PosixAdvTimedSemaphore>::
    TimedSemaphoreImpl(bsls::SystemClockType::Enum clockType)
: d_clockType(clockType)
{
    int result = ::sem_init(&d_sem, 0, 0);  (void)result;
    BSLS_ASSERT_OPT(-1 != result);
}
 
inline
TimedSemaphoreImpl<bslmt::Platform::PosixAdvTimedSemaphore>::
    TimedSemaphoreImpl(int count, bsls::SystemClockType::Enum clockType)
: d_clockType(clockType)
{
    int result = ::sem_init(&d_sem, 0, count);  (void)result;
    BSLS_ASSERT_OPT(-1 != result);
}
 
inline
TimedSemaphoreImpl<bslmt::Platform::PosixAdvTimedSemaphore>::
    ~TimedSemaphoreImpl()
{
    ::sem_destroy(&d_sem);
}
 
// MANIPULATORS
inline
void TimedSemaphoreImpl<bslmt::Platform::PosixAdvTimedSemaphore>::post()
{
    ::sem_post(&d_sem);
}
 
inline
int TimedSemaphoreImpl<bslmt::Platform::PosixAdvTimedSemaphore>::
    tryWait()
{
    return ::sem_trywait(&d_sem);
}
 
// ACCESSORS
inline
bsls::SystemClockType::Enum
TimedSemaphoreImpl<bslmt::Platform::PosixAdvTimedSemaphore>::clockType() const
{
    return d_clockType;
}
 
}  // 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 ----------------------------------
 
/** @} */
/** @} */
/** @} */