Display the source code in core/sync/rwmutex.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

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.Reader/reader` - multiple declarations

Function ReadWriteMutex.reader

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



ReadWriteMutex.Reader reader() nothrow @property @safe;




shared(ReadWriteMutex.Reader) reader() nothrow @property @safe shared;

Returns

A reader sub-mutex.

Class ReadWriteMutex.Reader

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



class Reader

  : object.Object.Monitor
;

Constructors

Name	Description
`this` ()	Initializes a read/write mutex reader proxy object.

Methods

Name	Description
`lock` ()	Acquires a read lock on the enclosing mutex.
`tryLock` ()	Attempts to acquire a read 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 read 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 read 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 read 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 read lock on the enclosing mutex.

Authors

Sean Kelly

License

Boost License 1.0