KLayout Manual: Main Index » Class Index » API reference - Class QMutex

API reference - Class QMutex

Notation used in Ruby API documentation

Description: Binding of QMutex

Public constructors

new QMutexnewConstructor QMutex::QMutex(QMutex::RecursionMode mode)
new QMutexnew(const QMutex_RecursionMode mode)Constructor QMutex::QMutex(QMutex::RecursionMode mode)

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
voidlockMethod void QMutex::lock()
booltryLockMethod bool QMutex::tryLock()
booltryLock(int timeout)Method bool QMutex::tryLock(int timeout)
voidunlockMethod void QMutex::unlock()

Public static methods and constants

QMutex_RecursionModeNonRecursiveEnum constant enum QMutex::NonRecursive
QMutex_RecursionModeRecursiveEnum constant enum QMutex::Recursive

Detailed description

[static] QMutex_RecursionMode NonRecursive

Description: Enum constant enum QMutex::NonRecursive

[static] QMutex_RecursionMode Recursive

Description: Enum constant enum QMutex::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 lock

Description: Method void QMutex::lock()

[static] new QMutex new

Description: Constructor QMutex::QMutex(QMutex::RecursionMode mode)

This method creates an object of class QMutex.

[static] new QMutex new(const QMutex_RecursionMode mode)

Description: Constructor QMutex::QMutex(QMutex::RecursionMode mode)

This method creates an object of class QMutex.

bool tryLock

Description: Method bool QMutex::tryLock()

bool tryLock(int timeout)

Description: Method bool QMutex::tryLock(int timeout)

void unlock

Description: Method void QMutex::unlock()