Boost.Capy

    • Introduction
    • Quick Start
    • Introduction To C++20 Coroutines
      • Part I: Foundations
      • Part II: C++20 Syntax
      • Part III: Coroutine Machinery
      • Part IV: Advanced Topics
    • Introduction to I/O Awaitables
      • Concept Hierarchy
      • The Executor
      • The Stop Token
      • The Allocator
      • Launching Coroutines
    • Capy Library
      • The task<T> Type
      • Error Handling with io_result
      • Stream Concepts
      • Concurrent Composition
      • Cancellation
      • Synchronization Primitives
      • Executors and Strands
      • Frame Allocators
    • Buffers
      • Overview
      • Buffers and I/O
      • Buffer Types
      • Buffer Sequences
      • Buffer Algorithms
      • Dynamic Buffers
    • Testing Facilities
      • Overview
    • Reference
  • boost::capy::coro_lock::lock
arrow_upward

boost::capy::coro_lock::lock

Returns an awaiter that acquires the mutex.

Synopsis

Declared in <boost/capy/ex/coro_lock.hpp>

lock_awaiter
lock() noexcept;

Return Value

An awaiter that suspends if the mutex is locked, or completes immediately if unlocked.

Created with MrDocs