Struct finish_event

Struct Documentation

struct concore::v1::finish_event

A finish event.

This can be passed to various tasks that would notify this whenever the task is complete. Depending on how the event is configured, after certain number of tasks are completed this triggers an event. This can be used to join the execution of multiple tasks that can run in parallel.

The notify_done() function must be called whenever the task is done.

This is created via finish_task and finish_wait.

Once a finish even is triggered, it cannot be reused anymore.

See

finish_task, finish_wait

Public Functions

void notify_done() const

Called by other tasks to indicate their completion.

When the right number of tasks have called this, then the event is trigger; that is, executing a task or unblocking some wait call.