flock

PHP マニュアル
前のページ		次のページ

説明

bool flock ( resource handle, int operation [, int &wouldblock] )

PHP は、恣意的にファイルをロックする汎用の手段を提供します。 (これは、アクセスする全プログラムが同一のロックの方法を使用する必要があり、そうでない場合は動作しないことを意味します)

注意: flock() は、Windows 環境下では必須です。

flock() は、handle を用いて操作を行います。これは、オープンされたファイルポインタである必要があります。 operationは、次の値のどれかとなります。

共有ロック(読み手)とするには、operation に LOCK_SH (PHP 4.0.1 より前の場合は 1) をセットします。
排他的ロック(書き手)とするには、operation に LOCK_EX (PHP 4.0.1 より前の場合は 2) をセットします。
(共有または排他的)ロックを開放するには、 operation に LOCK_UN (PHP 4.0.1 より前の場合は 3) をセットします。
ロック中に flock() でブロックを行いたくない場合は、 operation に LOCK_NB (PHP 4.0.1 より前の場合は 4) を加えます。

flock()により、(ほとんどのUNIXやWindowsさえ含む) ほとんど全てのプラットフォームで使用可能な簡易な読み手/書き手モデルが実現されます。ロックをブロックモードとする場合(EWOULDBLOCK errno 条件)にオプションの3番目の引数にTRUEを設定します。ロックは fclose() でも解放されます (スクリプトが終了した場合も自動的にコールされます) 。

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例 1. flock() の例


<?php

$fp = fopen("/tmp/lock.txt", "w+");

if (flock($fp, LOCK_EX)) { // 排他ロックを行います
    fwrite($fp, "Write something here\n");
    flock($fp, LOCK_UN); // ロックを解放します
} else {
    echo "ファイルをロックできません!";
}

fclose($fp);

?>

注意: flock()は、ファイルポインタを必要とするため、 (fopen()へ引数"w"または"w+"を指定して)書き込みモードでオープンすることにより丸めるファイルにアクセス保護する特別なロックファイルを使用する必要があるかもしれません。

警告

flock() は NFS 及び他の多くのネットワークファイルシステムでは動作しません。詳細についてはオペレーティングシステムのドキュメントを確認ください。

いくつかのオーペレーティングシステムでflock() はプロセスレベルで実装されています。ISAPIのようなマルチスレッド型のサーバーAPIを使用している場合、同じサーバーインスタンスの並列スレッドで実行されている他のPHPスクリプトに対してファイルを保護する際に flock()を使用することはできません!

flock()はFATのような旧式のファイルシステムではサポートされていないため、そのような環境の場合は常にFALSEを返すことになります。（これは特にWindows98ユーザーにとって常に真です）

前のページ	ホーム	次のページ
filetype	上に戻る	fnmatch