View source code Display the source code in core/sync/semaphore.d from which this page was generated on github. Improve this page Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone. Page wiki View or edit the community-maintained wiki page associated with this page.

core.sync.semaphore.semaphore.wait - multiple declarations

Function Semaphore.wait

Wait until the current count is above zero, then atomically decrement the count by one and return.

Prototype

void wait();

Throws

SyncError on error.

Function Semaphore.wait

Suspends the calling thread until the current count moves above zero or until the supplied time period has elapsed. If the count moves above zero in this interval, then atomically decrement the count by one and return true. Otherwise, return false.

Prototype

bool wait(
  Duration period
);

Parameters

NameDescription
period The time to wait.

In

period must be non-negative.

Throws

SyncError on error.

Returns

true if notified before the timeout and false if not.

Authors

Sean Kelly

License

Boost License 1.0

Comments