API reference - Class QWaitCondition

Notation used in Ruby API documentation

Description: Binding of QWaitCondition

Public constructors

new QWaitConditionnewConstructor QWaitCondition::QWaitCondition()

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
boolwait(QMutex ptr mutex,
unsigned long time = (2147483647L * 2UL + 1UL))
Method bool QWaitCondition::wait(QMutex *mutex, unsigned long int time)
boolwait(QReadWriteLock ptr readWriteLock,
unsigned long time = (2147483647L * 2UL + 1UL))
Method bool QWaitCondition::wait(QReadWriteLock *readWriteLock, unsigned long int time)
voidwakeAllMethod void QWaitCondition::wakeAll()
voidwakeOneMethod void QWaitCondition::wakeOne()

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 QWaitCondition new

Description: Constructor QWaitCondition::QWaitCondition()

This method creates an object of class QWaitCondition.

bool wait(QMutex ptr mutex,unsigned long time = (2147483647L * 2UL + 1UL))

Description: Method bool QWaitCondition::wait(QMutex *mutex, unsigned long int time)

bool wait(QReadWriteLock ptr readWriteLock,unsigned long time = (2147483647L * 2UL + 1UL))

Description: Method bool QWaitCondition::wait(QReadWriteLock *readWriteLock, unsigned long int time)

void wakeAll

Description: Method void QWaitCondition::wakeAll()

void wakeOne

Description: Method void QWaitCondition::wakeOne()