QSystemSemaphore Class

メンバー関数ドキュメント

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

指定されたkey に対してシステム・セマフォを要求する。パラメータinitialValue とmode は、システムに依存する以下の規則に従って使用される。

Unixでは、mode がOpen であり、システムがすでにkey で識別されるセマフォを持っている場合、そのセマフォが使用され、セマフォのリソースカウントは変更されない、つまりinitialValue は無視される。しかし、システムがkey で識別されるセマフォをまだ持っていない場合、そのキーのために新しいセマフォを作成し、そのリソースカウントをinitialValue に設定する。

Unixでは、mode がCreate であり、システムがすでにkey で識別されるセマフォを持っている場合、そのセマフォが使用され、そのリソースカウントがinitialValue に設定される。システムがまだkey で識別されるセマフォを持っていない場合、そのキー用に新しいセマフォを作成し、そのリソースカウントをinitialValue に設定する。

Windowsでは、mode は無視され、システムは常に指定されたkey に対してセマフォを作成しようとする。システムがまだkey として識別されるセマフォを持っていない場合、セマフォを作成し、そのリソースカウントをinitialValue に設定する。 しかし、システムがすでにkey として識別されるセマフォを持っている場合、そのセマフォを使用し、initialValue を無視する。

mode パラメーターは、セマフォがプロセス・クラッシュを生き延びた場合を処理する ために、Unixシステムでのみ使用される。この場合、次に同じkey でセマフォを割り当てるプロセスは、クラッシュを免れたセマフォを取得します。mode がCreate でない限り、リソースカウントはinitialValue にリセットされず、クラッシュしたプロセスから与えられた初期値が保持されます。

acquire() およびkey()も参照のこと 。

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

レガシー・キーkey で識別されるシステム・セマフォを要求する。

[noexcept] QSystemSemaphore::~QSystemSemaphore()

デストラクタはQSystemSemaphore オブジェクトを破壊するが、QSystemSemaphore のインスタンスがそのシステム・セマフォに対して存在する最後のものでない限り、基礎となるシステム・セマフォはシステムから削除されない。

デストラクタの2つの重要な副作用はシステムに依存する。Windowsでは、このセマフォに対してacquire() が呼び出され、release() が呼び出されていない場合、release() はデストラクタによって呼び出されず、プロセスが正常に終了したときにリソースが解放されることもない。これはプログラムのバグであり、同じリソースを取得しようとする他のプロセスのデッドロックの原因となる可能性がある。Unixでは、デストラクタが呼ばれる前に解放されなかった獲得リソースは、プロセスの終了時に自動的に解放されます。

bool QSystemSemaphore::acquire()

このセマフォによってガードされているリソースのうち、1つでも利用可能なものがあれば取得し、true を返す。このセマフォによって保護されているすべてのリソースがすでに獲得されている場合、同じキーのセマフォを持つ他のプロセスまたはスレッドによってその1つが解放されるまで、呼び出しはブロックされる。

false が返された場合、システム・エラーが発生した。どのエラーが発生したかを示すQSystemSemaphore::SystemSemaphoreError の値を取得するには、error()を呼び出す。

release()も参照のこと 。

QSystemSemaphore::SystemSemaphoreError QSystemSemaphore::error() const

エラーが発生したかどうか、発生した場合はどのエラーであったかを示す値を返す。

errorString()も参照 。

QString QSystemSemaphore::errorString() const

最後に発生したエラーの説明をテキストで返す。error() がerror value を返した場合、この関数を呼び出して、エラーを説明するテキスト文字列を取得する。

error()も参照 。

QString QSystemSemaphore::key() const

このシステム・セマフォに割り当てられているレガシー・キーを返します。キーは、他のプロセスからセマフォにアクセスできる名前です。

setKey()も参照 。

QNativeIpcKey QSystemSemaphore::nativeIpcKey() const

このシステム・セマフォに割り当てられているキーを返します。キーは、他のプロセスからセマフォにアクセスできる名前です。

ネイティブキーを使用すると、Qt によって作成されていないシステムセマフォにアクセスしたり、Qt 以外のアプリケーションにアクセスを許可したりすることができます。詳細はネイティブIPCキーを参照してください。

setNativeKey()も参照してください 。

bool QSystemSemaphore::release(int n = 1)

n セマフォによって保護されているリソースを解放する。システムエラーがない限り、true を返す。

例5つのリソースを持つシステム・セマフォを作成する。

QSystemSemaphore sem(QSystemSemaphore::platformSafeKey("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

すでに存在していた5つのリソースに加え、新たに10個のリソースがセマフォに守られるようになった。通常、この関数を使用してさらにリソースを作成することはない。

acquire()も参照のこと 。

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

この関数はコンストラクタと同じ働きをする。このQSystemSemaphore オブジェクトを再構築します。新しいkey が古いキーと異なる場合、この関数を呼び出すことは、古いキーを持つセマフォのデストラクタを呼び出し、次にコンストラクタを呼び出して新しいkey を持つ新しいセマフォを作成するようなものである。initialValue 、mode パラメータはコンストラクタで定義されているとおりである。

QSystemSemaphore() およびkey()も参照のこと 。

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

この関数はコンストラクタと同じ働きをする。このQSystemSemaphore オブジェクトを再構築します。新しいkey が古いキーと異なる場合、この関数を呼び出すことは、古いキーを持つセマフォのデストラクタを呼び出し、次にコンストラクタを呼び出して新しいkey を持つ新しいセマフォを作成するようなものである。initialValue 、mode パラメータはコンストラクタで定義されているとおりである。

この関数は、ネイティブ・キーが他のプロセスから共有された場合に便利です。詳細は「ネイティブIPCキー」を参照。

QSystemSemaphore() およびnativeIpcKey()も参照のこと 。