API reference - Class QSemaphore

Notation used in Ruby API documentation

Description: Binding of QSemaphore

Public constructors

new QSemaphorenew(int n = 0)Constructor QSemaphore::QSemaphore(int n)

Public methods

voidacquire(int n = 1)Method void QSemaphore::acquire(int n)
[const]intavailableMethod int QSemaphore::available()
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
voidrelease(int n = 1)Method void QSemaphore::release(int n)
booltryAcquire(int n = 1)Method bool QSemaphore::tryAcquire(int n)
booltryAcquire(int n,
int timeout)
Method bool QSemaphore::tryAcquire(int n, int timeout)

Detailed description

void acquire(int n = 1)

Description: Method void QSemaphore::acquire(int n)

[const] int available

Description: Method int QSemaphore::available()

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 QSemaphore new(int n = 0)

Description: Constructor QSemaphore::QSemaphore(int n)

This method creates an object of class QSemaphore.

void release(int n = 1)

Description: Method void QSemaphore::release(int n)

bool tryAcquire(int n = 1)

Description: Method bool QSemaphore::tryAcquire(int n)

bool tryAcquire(int n,int timeout)

Description: Method bool QSemaphore::tryAcquire(int n, int timeout)