Module Miou_sync.Trigger

create () allocates a new trigger in the initial state.

is_initial t determines whether the trigger t is in the initial state.

is_signaled t determines whether the trigger t is in the signaled state.

await t waits for the trigger to be signaled.

The return value is None in case the trigger was signaled before await or we resumed the underlying continuation normally. Otherwise, the return value is Some (exn, bt), which indicates that the underlying continuation has been cancelled and the caller should raise the exception. In either case, the caller is responsible for cleaning up. Usually this means making sure that no references to the trigger remain to avoid space leak.

• raises Invalid_argument

  if the trigger was in the awaiting state, which means that multiple concurrent calls of await are being made.

After signal t returns, the trigger has been put into the signaled state and any attached action (via on_signal) has been called.

Note that under normal circumstance, signal should never raise an exception. If an exception is raised by signal, it means that the attached action raised an error.

on_signal t x y fn attempts to attach the fn action to the trigger t and transition the trigger to the awaiting state. It must be safe to call fn t x y from any context that signal might be called from.

The return value is true in case the action was attached successfully. Otherwise, the return value is false, which means that the trigger was already in the signaled state.

• raises Invalid_argument

  if the trigger was in the awaiting state, which means that either the owner or creator of the trigger made concurrent calls to await or the handler called on_signal more than once.