API reference - Class QReadWriteLock

Notation used in Ruby API documentation

Description: Binding of QReadWriteLock

Public constructors

new QReadWriteLocknewConstructor QReadWriteLock::QReadWriteLock()
new QReadWriteLocknew(const QReadWriteLock_RecursionMode recursionMode)Constructor QReadWriteLock::QReadWriteLock(QReadWriteLock::RecursionMode recursionMode)

Public methods

voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidlockForReadMethod void QReadWriteLock::lockForRead()
voidlockForWriteMethod void QReadWriteLock::lockForWrite()
booltryLockForReadMethod bool QReadWriteLock::tryLockForRead()
booltryLockForRead(int timeout)Method bool QReadWriteLock::tryLockForRead(int timeout)
booltryLockForWriteMethod bool QReadWriteLock::tryLockForWrite()
booltryLockForWrite(int timeout)Method bool QReadWriteLock::tryLockForWrite(int timeout)
voidunlockMethod void QReadWriteLock::unlock()

Public static methods and constants

QReadWriteLock_RecursionModeNonRecursiveEnum constant QReadWriteLock::NonRecursive
QReadWriteLock_RecursionModeRecursiveEnum constant QReadWriteLock::Recursive

Detailed description

[static] QReadWriteLock_RecursionMode NonRecursive

Description: Enum constant QReadWriteLock::NonRecursive

[static] QReadWriteLock_RecursionMode Recursive

Description: Enum constant QReadWriteLock::Recursive

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void lockForRead

Description: Method void QReadWriteLock::lockForRead()

void lockForWrite

Description: Method void QReadWriteLock::lockForWrite()

[static] new QReadWriteLock new

Description: Constructor QReadWriteLock::QReadWriteLock()

This method creates an object of class QReadWriteLock.

[static] new QReadWriteLock new(const QReadWriteLock_RecursionMode recursionMode)

Description: Constructor QReadWriteLock::QReadWriteLock(QReadWriteLock::RecursionMode recursionMode)

This method creates an object of class QReadWriteLock.

bool tryLockForRead

Description: Method bool QReadWriteLock::tryLockForRead()

bool tryLockForRead(int timeout)

Description: Method bool QReadWriteLock::tryLockForRead(int timeout)

bool tryLockForWrite

Description: Method bool QReadWriteLock::tryLockForWrite()

bool tryLockForWrite(int timeout)

Description: Method bool QReadWriteLock::tryLockForWrite(int timeout)

void unlock

Description: Method void QReadWriteLock::unlock()