TerminateFlag
in package
バックグラウンド処理へ中止要求を伝えるフラグファイル
中止ボタンを押したリクエストが raise() でフラグを作り、実行中のプロセスが ループ内で isRaised() を見て自ら打ち切る。バックグラウンド処理は Response::backgroundRedirect() でレスポンスを返した後の同一プロセスで動き続けており、 別リクエストからそのプロセスへ直接指示を送る経路がないため、 ファイルの有無だけを見る形にしている。
Table of Contents
Properties
- $flagPath : string
Methods
- __construct() : mixed
- clear() : void
- 中止要求を取り消す
- isRaised() : bool
- 中止要求が立っているか判定
- raise() : void
- 中止要求を立てる
- value() : string|null
- 立てたときの値を返す。立っていなければ null
Properties
$flagPath
protected
string
$flagPath
Methods
__construct()
public
__construct(string $flagPath) : mixed
Parameters
- $flagPath : string
clear()
中止要求を取り消す
public
clear() : void
isRaised()
中止要求が立っているか判定
public
isRaised() : bool
Return values
boolraise()
中止要求を立てる
public
raise([string $value = 'terminate' ]) : void
Parameters
- $value : string = 'terminate'
-
どの実行への中止要求かを区別するための値（実行 ID 等）
value()
立てたときの値を返す。立っていなければ null
public
value() : string|null