GGLinnk/bees
1
0
Fork 0
mirror of https://github.com/Zygo/bees.git synced 2025-05-17 21:35:45 +02:00
Code Packages

task: fix try_lock argument description

Browse Source 
try_lock allows specification of a different Task to be run instead of
the current Task when the lock is busy.

Signed-off-by: Zygo Blaxell <bees@furryterror.org>
This commit is contained in:
Zygo Blaxell 2024-11-19 15:29:41 -05:00
parent 33cde5de97
commit a64603568b
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/crucible/task.h
View File

@ -163,9 +163,9 @@ namespace crucible {
/// (it is the ExclusionLock that owns the lock, so it can /// (it is the ExclusionLock that owns the lock, so it can
/// be passed to other Tasks or threads, but this is not /// be passed to other Tasks or threads, but this is not
/// recommended practice). /// recommended practice).
/// If not successful, current Task is appended to the /// If not successful, the argument Task is appended to the
/// task that currently holds the lock. Current task is /// task that currently holds the lock. Current task is
/// expected to release any other ExclusionLock /// expected to immediately release any other ExclusionLock
/// objects it holds, and exit its Task function. /// objects it holds, and exit its Task function.
ExclusionLock try_lock(const Task &task); ExclusionLock try_lock(const Task &task);