..
    Copyright (C) 2022-2026 Dimitra Karatza
    Copyright (C) 2022-2026 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_suspend_hpx_suspend_api:

------------
hpx::suspend
------------

Defined in header :hpx-header:`libs/full/init_runtime/include,hpx/init.hpp`.

See :ref:`public_api` for a list of names and headers that are part of the public
|hpx| API.


See also:

   - :ref:`hpx::resume <modules_suspend_hpx_resume_api>`

.. doxygenfunction:: hpx::suspend
   :project: hpx