QSystemSemaphore Класс

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

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

Типы

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

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

Класс QSystemSemaphore предоставляет общий системный семафор со счётчиком.

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

Как и его более лёгкий аналог QSemaphore, QSystemSemaphore может быть доступен из нескольких потоков threads. В отличие от QSemaphore, QSystemSemaphore также может быть доступен из нескольких процессов processes. Это означает, что QSystemSemaphore — это гораздо более тяжёлый класс, поэтому если вашему приложению не требуется доступ к семафорам через несколько процессов, вы, вероятно, захотите использовать QSemaphore.

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

acquire() пытается захватить один ресурс. Если ресурс недоступен, вызов блокируется до тех пор, пока ресурс не станет доступным. Затем ресурс захватывается, и вызов возвращает значение.

release() освобождает один ресурс, чтобы его мог захватить другой процесс. Функция также может быть вызвана с параметром n > 1, который освобождает n ресурсов.

Системный семафор создаётся с строковым ключом, который другие процессы могут использовать для доступа к тому же семафору.

Пример: Создание системного семафора

QSystemSemaphore sem("market", 3, QSystemSemaphore::Create);
                             // resources available == 3
sem.acquire();               // resources available == 2
sem.acquire();               // resources available == 1
sem.acquire();               // resources available == 0
sem.release();               // resources available == 1
sem.release(2);              // resources available == 3

Типичное применение системных семафоров — управление доступом к круговой очереди, разделяемой процессом-производителем и процессом-потребителем.

Платформенно-специфическое поведение

При использовании этого класса обратите внимание на следующие различия между платформами:

Windows: QSystemSemaphore не владеет своим системным семафором. Им владеет Windows. Это означает, что когда все экземпляры QSystemSemaphore для определённого ключа были уничтожены, либо в результате вызова их деструкторов, либо из-за того, что один или несколько процессов упали, Windows удаляет базовый системный семафор.

Unix:

• QSystemSemaphore владеет базовым системным семафором в системах Unix. Это означает, что последний процесс, имеющий экземпляр QSystemSemaphore для определённого ключа, должен удалить базовый системный семафор в своём деструкторе. Если последний процесс аварийно завершается, не выполнив деструктор QSystemSemaphore, Unix не удаляет автоматически базовый системный семафор, и семафор сохраняется после сбоя. Последующий процесс, который создаёт QSystemSemaphore с тем же ключом, получит существующий системный семафор. В этом случае, если конструктор QSystemSemaphore указал режим доступа как Open, его начальное количество ресурсов не будет сброшено до заданного значения, а останется установленным в значение, полученное в аварийно завершившемся процессе. Чтобы защититься от этого, первый процесс, создающий семафор для определённого ключа (обычно сервер), должен указать режим доступа как Create, что заставит Unix сбросить счётчик ресурсов в базовом системном семафоре.
• Когда процесс, использующий QSystemSemaphore, завершается по любой причине, Unix автоматически отменяет эффект всех операций захвата, которые не были освобождены. Таким образом, если процесс захватывает ресурс и затем завершается без его освобождения, Unix освободит этот ресурс.

См. также QSharedMemory и QSemaphore.

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

перечисление QSystemSemaphore::AccessMode

Это перечисление используется в конструкторе и setKey(). Его назначение — решить проблему в реализациях семафоров Unix, которые сохраняются после сбоя. В Unix, когда семафор сохраняется после сбоя, нам нужен способ принудительно сбросить его счётчик ресурсов, когда система повторно использует семафор. В Windows, где семафоры не могут сохраняться после сбоя, это перечисление не имеет эффекта.

перечисление QSystemSemaphore::SystemSemaphoreError

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

QSystemSemaphore::QSystemSemaphore(const QString &key, int initialValue = 0, AccessMode mode = Open)

Запрашивает системный семафор для указанного ключа key. Параметры initialValue и mode используются в соответствии со следующими правилами, которые зависят от системы.

В Unix, если mode равен Open, а системный семафор с ключом key уже существует, этот семафор используется, и счётчик ресурсов семафора не изменяется, т.е. initialValue игнорируется. Но если системный семафор с ключом key не существует, создаётся новый семафор с этим ключом, и его счётчик ресурсов устанавливается в initialValue.

В Unix, если режим равен Создать, а в системе уже есть семафор, идентифицированный по ключу, используется этот семафор, и его счетчик ресурсов устанавливается в начальное значение. Если в системе ещё нет семафора, идентифицированного по ключу, создаётся новый семафор для этого ключа и его счетчик ресурсов устанавливается в начальное значение.

В Windows, режим игнорируется, и система всегда пытается создать семафор для указанного ключа. Если в системе ещё нет семафора, идентифицированного как ключ, семафор создаётся, и его счетчик ресурсов устанавливается в начальное значение. Но если семафор с идентификатором ключ уже существует, используется этот семафор, а начальное значение игнорируется.

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

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

QSystemSemaphore::~QSystemSemaphore()

Деструктор уничтожает объект QSystemSemaphore, но подлежащий семафор системы не удаляется из системы, пока этот экземпляр QSystemSemaphore является последним, существующим для этого семафора системы.

Два важных побочных эффекта деструктора зависят от системы. В Windows, если для этого семафора был вызван acquire(), но не вызван release(), release() не будет вызван деструктором, и ресурс не будет освобождён при нормальном завершении процесса. Это будет ошибка программы, которая может стать причиной тупиковой ситуации в другом процессе, пытающемся получить тот же ресурс. В Unix, полученные ресурсы, которые не были освобождены до вызова деструктора, автоматически освобождаются при завершении процесса.

bool QSystemSemaphore::acquire()

Получает один из ресурсов, защищённых этим семафором, если он доступен, и возвращает true. Если все ресурсы, защищённые этим семафором, уже получены, вызов блокируется до тех пор, пока один из них не будет освобождён другим процессом или потоком, имеющим семафор с тем же ключом.

Если возвращается false, произошла системная ошибка. Вызовите error(), чтобы получить значение QSystemSemaphore::SystemSemaphoreError, которое указывает, какая ошибка произошла.

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

SystemSemaphoreError QSystemSemaphore::error() const

Возвращает значение, указывающее, произошла ли ошибка, и, если да, то какая именно.

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

QString QSystemSemaphore::errorString() const

Возвращает текстовое описание последней произошедшей ошибки. Если error() возвращает значение ошибки, вызовите эту функцию, чтобы получить текстовую строку, описывающую ошибку.

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

QString QSystemSemaphore::key() const

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

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

bool QSystemSemaphore::release(int n = 1)

Освобождает n ресурсов, защищённых семафором. Возвращает true за исключением случаев системных ошибок.

Пример: Создайте семафор системы с пятью ресурсами; получите все из них, а затем освободите все.

QSystemSemaphore sem("market", 5, QSystemSemaphore::Create);
for (int i = 0; i < 5; ++i)  // acquire all 5 resources
    sem.acquire();
sem.release(5);              // release the 5 resources

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

sem.release(10);          // "create" 10 new resources

Теперь семафор защищает десять новых ресурсов в дополнение к уже существующим пяти. Обычно вы не будете использовать эту функцию для создания дополнительных ресурсов.

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

void QSystemSemaphore::setKey(const QString &key, int initialValue = 0, AccessMode mode = Open)

Эта функция работает так же, как конструктор. Она перестраивает этот объект QSystemSemaphore. Если новый ключ отличается от старого ключа, вызов этой функции аналогичен вызову деструктора семафора со старым ключом, а затем вызову конструктора для создания нового семафора с новым ключом. Параметры initialValue и mode определены так же, как и для конструктора.

См. также QSystemSemaphore() и key().