Skip to content

Commit 44cf707

Browse files
committed
runtime: additional docs for barrier managers
1 parent b9d1298 commit 44cf707

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

runtime/include/alaska/BarrierManager.hpp

+4
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ namespace alaska {
1313
// core runtime's capabilities.
1414
//
1515
// This class also records some statistics about barrier events as they occur.
16+
// The only requirement of this class is that when `::begin()` returns, all pinned handles must
17+
// be marked as such, and when `::end()` returns they should be released. The core runtime relies
18+
// on this to be the case for safe operation. If the user of the core runtime does not need to
19+
// pin any handles, the barrier does not need to do anything.
1620
struct BarrierManager {
1721
virtual ~BarrierManager() = default;
1822
virtual void begin(void) = 0;

0 commit comments

Comments
 (0)