latentprion/libspinscale
1
0
Fork 0
mirror of https://github.com/latentPrion/libspinscale.git synced 2026-06-23 19:48:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Nursery: Document intended usage form

Browse Source
This commit is contained in:
Hayodea Hekol
2026-06-09 21:25:25 -04:00
parent d33e70f14a
commit ebf0fa2921
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/spinscale/co/nonViralTaskNursery.h
+11
View File
@@ -1,6 +1,8 @@
#ifndef NON_VIRAL_TASK_NURSERY_H #ifndef NON_VIRAL_TASK_NURSERY_H
#define NON_VIRAL_TASK_NURSERY_H #define NON_VIRAL_TASK_NURSERY_H
#include <boostAsioLinkageFix.h>
#include <cstddef> #include <cstddef>
#include <exception> #include <exception>
#include <functional> #include <functional>
@@ -44,6 +46,15 @@ struct MemberInvoker : MemberInvokerBase
* callbacks, tracks unsettled slots, fans out cooperative cancel via per-slot * callbacks, tracks unsettled slots, fans out cooperative cancel via per-slot
* SyncCancelerForAsyncWork, and provides drain APIs. * SyncCancelerForAsyncWork, and provides drain APIs.
* *
* Each nursery member must be one complete, self-contained non-viral async
* flow. For an external HTTP request, that means one coroutine should shepherd
* the whole request from framework callback through all sscl component awaits
* to final response/commit/error handling. Do not use the nursery as a place
* to reserve a slot, perform partial setup elsewhere, and later return to
* fill the slot. Do not add each individual awaited operation as a separate
* nursery member. The external submitter should add the complete flow to the
* nursery and then return; the nursery owns that flow until the flow settles.
*
* Call closeAdmission() explicitly before asyncAwaitAllSettlements() or * Call closeAdmission() explicitly before asyncAwaitAllSettlements() or
* syncAwaitAllSettlements(). * syncAwaitAllSettlements().
* *