..
    Copyright (c) 2019 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_lcos_local:

==========
lcos_local
==========

This module provides the following local :term:`LCO`\ s:

* :hpx:class:`hpx::lcos::local::and_gate`
* :hpx:class:`hpx::lcos::local::channel`
* :hpx:class:`hpx::lcos::local::one_element_channel`
* :hpx:class:`hpx::lcos::local::receive_channel`
* :hpx:class:`hpx::lcos::local::send_channel`
* :hpx:class:`hpx::lcos::local::guard`
* :hpx:class:`hpx::lcos::local::guard_set`
* :hpx:func:`hpx::lcos::local::run_guarded`
* :hpx:class:`hpx::lcos::local::conditional_trigger`
* :hpx:class:`hpx::packaged_task`
* :hpx:class:`hpx::promise`
* :hpx:class:`hpx::lcos::local::receive_buffer`
* :hpx:class:`hpx::lcos::local::trigger`

See :ref:`modules_lcos_distributed` for distributed LCOs. Basic synchronization
primitives for use in |hpx| threads can be found in :ref:`modules_synchronization`.
:ref:`modules_async_combinators` contains useful utility functions for combining
futures.

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