Класс QSemaphore

Класс QSemaphore предоставляет общий семафор подсчета. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются защищенными от одновременного доступа из нескольких потоков.

Открытые функции

Подробное описание

Семафор — это обобщение мьютекса. В то время как мьютекс может быть заблокирован только один раз, семафор можно получить многократно. Семафоры обычно используются для защиты определенного количества идентичных ресурсов.

Семафоры поддерживают две основные операции: acquire() и release():

• acquire(n) пытается получить n ресурсов. Если доступно недостаточно ресурсов, вызов будет заблокирован, пока это не изменится.
• release(n) освобождает n ресурсов.

Также есть функция tryAcquire(), которая возвращает значение немедленно, если невозможно получить ресурсы, и функция available(), которая возвращает количество доступных ресурсов в любой момент.

Пример:

QSemaphore sem(5);      // sem.available() == 5

sem.acquire(3);         // sem.available() == 2
sem.acquire(2);         // sem.available() == 0
sem.release(5);         // sem.available() == 5
sem.release(5);         // sem.available() == 10

sem.tryAcquire(1);      // sem.available() == 9, returns true
sem.tryAcquire(250);    // sem.available() == 9, returns false

Типичное применение семафоров — для управления доступом к кольцевому буферу, который совместно используется потоком-производителем и потоком-потребителем. Пример Semaphores Example показывает, как использовать QSemaphore для решения этой проблемы.

Невычислительный пример семафора — это обед в ресторане. Семафор инициализируется количеством стульев в ресторане. По мере прибытия людей они хотят сесть. По мере заполнения мест available() уменьшается. Когда люди уходят, available() увеличивается, позволяя зайти большему количеству людей. Если компания из 10 человек хочет занять места, но есть только 9 мест, эти 10 человек будут ждать, но компания из 4 человек сможет сесть (взяв доступные места до 5, что заставит ждать компанию из 10 человек дольше).

См. также QSemaphoreReleaser, QMutex, QWaitCondition, QThread и Semaphores Example.

Документация по функциям-членам

QSemaphore::QSemaphore(int n = 0)

Создает новый семафор и инициализирует количество ресурсов, которые он защищает, до n (по умолчанию 0).

См. также release() и available().

QSemaphore::~QSemaphore()

Удаляет семафор.

Предупреждение: Удаление семафора, который используется, может привести к неопределенному поведению.

void QSemaphore::acquire(int n = 1)

Пытается получить n ресурсов, защищенных семафором. Если n > available(), этот вызов будет заблокирован, пока не будет достаточно ресурсов.

См. также release(), available() и tryAcquire().

int QSemaphore::available() const

Возвращает количество ресурсов, в настоящее время доступных для семафора. Это число никогда не может быть отрицательным.

См. также acquire() и release().

void QSemaphore::release(int n = 1)

Освобождает n ресурсов, защищенных семафором.

Эта функция может использоваться для «создания» ресурсов. Например:

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 — это оболочка RAII для этой функции.

См. также acquire(), available() и QSemaphoreReleaser.

bool QSemaphore::tryAcquire(int n = 1)

Пытается получить n ресурсов, защищенных семафором, и возвращает true при успехе. Если available() < n, этот вызов немедленно возвращает false без получения каких-либо ресурсов.

Пример:

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

См. также acquire().

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

Пытается получить n ресурсов, защищенных семафором, и возвращает true при успехе. Если available() < n, этот вызов будет ждать не более timeout миллисекунд, пока ресурсы не станут доступными.

Примечание: Передача отрицательного числа в качестве timeout эквивалентна вызову acquire(), т. е. эта функция будет ждать бесконечно, пока ресурсы не станут доступными, если timeout отрицателен.

Пример:

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

См. также acquire().