os-condvar.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2016-2023 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can
 * be obtained from https://opensource.org/licenses/mit/.
 */
 
#ifndef CMSIS_PLUS_RTOS_OS_CONDVAR_H_
#define CMSIS_PLUS_RTOS_OS_CONDVAR_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#include <cmsis-plus/rtos/os-decls.h>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace rtos
  {
 
    // ========================================================================
 
    class condition_variable : public internal::object_named_system
    {
    public:
 
      // ======================================================================
 
      class attributes : public internal::attributes_clocked
      {
      public:
 
        constexpr
        attributes ();
 
        // The rule of five.
        attributes (const attributes&) = default;
        attributes (attributes&&) = default;
        attributes&
        operator= (const attributes&) = default;
        attributes&
        operator= (attributes&&) = default;
 
        ~attributes () = default;
 
      public:
 
        // Public members; no accessors and mutators required.
        // Warning: must match the type & order of the C file header.
        // Add more attributes here.
      }; /* class attributes */
 
      static const attributes initializer;
 
      // ======================================================================
 
      condition_variable (const attributes& attr = initializer);
 
      condition_variable (const char* name,
                          const attributes& attr = initializer);
 
      // The rule of five.
      condition_variable (const condition_variable&) = delete;
      condition_variable (condition_variable&&) = delete;
      condition_variable&
      operator= (const condition_variable&) = delete;
      condition_variable&
      operator= (condition_variable&&) = delete;
 
      ~condition_variable ();
 
      bool
      operator== (const condition_variable& rhs) const;
 
    public:
 
      result_t
      signal (void);
 
      result_t
      broadcast (void);
 
      result_t
      wait (mutex& mutex);
 
      // Neither POSIX nor ISO define a try_wait(), it makes no sense.
 
      result_t
      timed_wait (mutex& mutex, clock::duration_t timeout);
 
    protected:
 
#if !defined(OS_USE_RTOS_PORT_CONDITION_VARIABLE)
      internal::waiting_threads_list list_;
      // clock& clock_;
#endif
 
      // Add more internal data.
    };
 
  } /* namespace rtos */
} /* namespace os */
 
// ===== Inline & template implementations ====================================
 
namespace os
{
  namespace rtos
  {
    constexpr
    condition_variable::attributes::attributes ()
    {
    }
 
    // ========================================================================
 
    inline bool
    condition_variable::operator== (const condition_variable& rhs) const
    {
      return this == &rhs;
    }
 
  } /* namespace rtos */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_RTOS_OS_CONDVAR_H_ */