View source code
Display the source code in core/sync/rwmutex.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
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.

core.sync.rwmutex.ReadWriteMutex.Writer/writer - multiple declarations

Function ReadWriteMutex.writer

Gets an object representing the writer lock for the associated mutex.

ReadWriteMutex.Writer writer() nothrow @property @safe;

shared(ReadWriteMutex.Writer) writer() nothrow @property @safe shared;

Returns

A writer sub-mutex.

Class ReadWriteMutex.Writer

This class can be considered a mutex in its own right, and is used to negotiate a write lock for the enclosing mutex.

class Writer
  : object.Object.Monitor ;

Constructors

NameDescription
this () Initializes a read/write mutex writer proxy object.

Methods

NameDescription
lock () Acquires a write lock on the enclosing mutex.
tryLock () Attempts to acquire a write lock on the enclosing mutex. If one can be obtained without blocking, the lock is acquired and true is returned. If not, the lock is not acquired and false is returned.
tryLock (timeout) Attempts to acquire a write lock on the enclosing mutex. If one can be obtained without blocking, the lock is acquired and true is returned. If not, the function blocks until either the lock can be obtained or the time elapsed exceeds timeout, returning true if the lock was acquired and false if the function timed out.
tryLock () Attempts to acquire a write lock on the enclosing mutex. If one can be obtained without blocking, the lock is acquired and true is returned. If not, the lock is not acquired and false is returned.
tryLock (timeout) Attempts to acquire a write lock on the enclosing mutex. If one can be obtained without blocking, the lock is acquired and true is returned. If not, the function blocks until either the lock can be obtained or the time elapsed exceeds timeout, returning true if the lock was acquired and false if the function timed out.
unlock () Releases a write lock on the enclosing mutex.

Authors

Sean Kelly

License

Boost License 1.0