tango.core.sync.Semaphore

License:

Author:

class Semaphore ¶#

This class represents a general counting semaphore as concieved by Edsger Dijkstra. As per Mesa type monitors however, "signal" has been replaced with "notify" to indicate that control is not transferred to the waiter when a notification is sent.

this(uint count = 0) ¶#

Initializes a semaphore object with the specified initial count.

Params:

count

The initial count for the semaphore.

Throws:

SyncException on error.

void wait() ¶#

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

Throws:

SyncException on error.

bool wait(double period) ¶#

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. The supplied period may be up to a maximum of (uint.max - 1) milliseconds.

Params:

period

The number of seconds to wait.

In:

period must be less than (uint.max - 1) milliseconds.

Returns:

true if notified before the timeout and false if not.

Throws:

SyncException on error.

void notify() ¶#

Atomically increment the current count by one. This will notify one waiter, if there are any in the queue.

Throws:

SyncException on error.

bool tryWait() ¶#

If the current count is equal to zero, return. Otherwise, atomically decrement the count by one and return true.

Returns:

true if the count was above zero and false if not.

Throws:

SyncException on error.