Skip to content

PythonQt.QtCore.QSemaphore · declarations 001

Back to PythonQt.QtCore.QSemaphore

acquire

acquire(n: int) -> None

X.acquire(n)

Supplemental documentation: Qt 5 reference:

void QSemaphore::acquire(int n \= 1)

Tries to acquire n resources guarded by the semaphore. If n > available(), this call will block until enough resources are available.

See also release(), available(), and tryAcquire().

Upstream PySide2 reference signatures (binding differences may apply):

acquire(self, n: int=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsemaphore.html#acquire

available

available() -> int

X.available() -> int

Supplemental documentation: Qt 5 reference:

int QSemaphore::available() const

Returns the number of resources currently available to the semaphore. This number can never be negative.

See also acquire() and release().

Upstream PySide2 reference signatures (binding differences may apply):

available(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsemaphore.html#available

release

release(n: int) -> None

X.release(n)

Supplemental documentation: Qt 5 reference:

void QSemaphore::release(int n \= 1)

Releases n resources guarded by the semaphore.

This function can be used to "create" resources as well. For example:

QSemaphore sem(5);      // a semaphore that guards 5 resources
sem.acquire(5);         // acquire all 5 resources
sem.release(5);         // release the 5 resources
sem.release(10);        // "create" 10 new resources

QSemaphoreReleaser is a RAII wrapper around this function.

See also acquire(), available(), and QSemaphoreReleaser.

Upstream PySide2 reference signatures (binding differences may apply):

release(self, n: int=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsemaphore.html#release

tryAcquire

tryAcquire(n: int, timeout: Any) -> bool

X.tryAcquire(n, timeout) -> bool

Supplemental documentation: Qt 5 reference:

bool QSemaphore::tryAcquire(int n \= 1)

Tries to acquire n resources guarded by the semaphore and returns true on success. If available() \< n, this call immediately returns false without acquiring any resources.

Example:

QSemaphore sem(5);      // sem.available() == 5
sem.tryAcquire(250);    // sem.available() == 5, returns false
sem.tryAcquire(3);      // sem.available() == 2, returns true

See also acquire().

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

Tries to acquire n resources guarded by the semaphore and returns true on success. If available() \< n, this call will wait for at most timeout milliseconds for resources to become available.

Note: Passing a negative number as the timeout is equivalent to calling acquire(), i.e. this function will wait forever for resources to become available if timeout is negative.

Example:

QSemaphore sem(5);            // sem.available() == 5
sem.tryAcquire(250, 1000);    // sem.available() == 5, waits 1000 milliseconds and returns false
sem.tryAcquire(3, 30000);     // sem.available() == 2, returns true without waiting

See also acquire().

Upstream PySide2 reference signatures (binding differences may apply):

tryAcquire(self, n: int, timeout: int) -> bool
tryAcquire(self, n: int=...) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qsemaphore.html#tryAcquire