..
    Copyright (c) 2019-2022 The STE||AR-Group

    SPDX-License-Identifier: BSL-1.0
    Distributed under the Boost Software License, Version 1.0. (See accompanying
    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

.. _modules_synchronization:

===============
synchronization
===============

This module provides synchronization primitives which should be used rather than
the C++ standard ones in |hpx| threads:

* :cpp:class:`hpx::barrier`
* :cpp:class:`hpx::lcos::local::condition_variable`
* :cpp:class:`hpx::lcos::local::counting_semaphore`
* :cpp:class:`hpx::lcos::local::event`
* :cpp:class:`hpx::latch`
* :cpp:class:`hpx::lcos::local::mutex`
* :cpp:class:`hpx::lcos::local::no_mutex`
* :cpp:class:`hpx::lcos::local::once_flag`
* :cpp:class:`hpx::lcos::local::recursive_mutex`
* :cpp:class:`hpx::lcos::local::shared_mutex`
* :cpp:class:`hpx::lcos::local::sliding_semaphore`
* :cpp:class:`hpx::lcos::local::spinlock` (`std::mutex` compatible spinlock)
* :cpp:class:`hpx::lcos::local::spinlock_no_backoff` (`boost::mutex` compatible spinlock)
* :cpp:class:`hpx::lcos::local::spinlock_pool`

See :ref:`modules_lcos_local`, :ref:`modules_async_combinators`, and :ref:`modules_async`
for higher level synchronization facilities.

See the :ref:`API reference <modules_synchronization_api>` of this module for more
details.