API reference - Class QReadLocker

Notation used in Ruby API documentation

Description: Binding of QReadLocker

Public constructors

new QReadLockernew(QReadWriteLock ptr readWriteLock)Constructor QReadLocker::QReadLocker(QReadWriteLock *readWriteLock)

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
[const]QReadWriteLock ptrreadWriteLockMethod QReadWriteLock *QReadLocker::readWriteLock()
voidrelockMethod void QReadLocker::relock()
voidunlockMethod void QReadLocker::unlock()

Detailed description

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.

[static] new QReadLocker new(QReadWriteLock ptr readWriteLock)

Description: Constructor QReadLocker::QReadLocker(QReadWriteLock *readWriteLock)

This method creates an object of class QReadLocker.

[const] QReadWriteLock ptr readWriteLock

Description: Method QReadWriteLock *QReadLocker::readWriteLock()

void relock

Description: Method void QReadLocker::relock()

void unlock

Description: Method void QReadLocker::unlock()