struct stop_state

Declaration

struct stop_state { /* full declaration omitted */ };

Description

////////////////////////////////////////////////////////////////////

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:77

Method Overview

public bool add_callback(pika::detail::stop_callback_base * cb) noexcept
public void add_source_count()
public void lock() noexcept
public void remove_callback(pika::detail::stop_callback_base * cb) noexcept
public void remove_source_count()
public bool request_stop() noexcept
public bool stop_possible() const noexcept
public bool stop_requested() const noexcept
public stop_state()
public void unlock() noexcept

Methods

bool add_callback(
    pika::detail::stop_callback_base* cb) noexcept

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:127

Parameters

pika::detail::stop_callback_base* cb

void add_source_count()

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:115

void lock() noexcept

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:164

void remove_callback(
    pika::detail::stop_callback_base* cb) noexcept

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:128

Parameters

pika::detail::stop_callback_base* cb

void remove_source_count()

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:121

bool request_stop() noexcept

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:113

bool stop_possible() const noexcept

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:108

bool stop_requested() const noexcept

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:101

stop_state()

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:96

void unlock() noexcept

Declared at: libs/pika/synchronization/include/pika/synchronization/stop_token.hpp:166