メソッドの概要

返却値の型 メソッド名
Boolean lockRequestScope (String name) static
リクエストに紐付くアプリケーションロックを開始します。
Boolean lock (String name) static
アプリケーションロックを開始します。
Boolean run (String name, Function function, Number timeout) static
アプリケーションロックを開始して、指定の関数を実行します。
Boolean tryLockRequestScope (String name, Number timeout) static
リクエストに紐付くアプリケーションロックの開始要求を行ないます。
Boolean tryLock (String name, Number timeout) static
アプリケーションロックの開始要求を行ないます。
Boolean unlock (String name) static
アプリケーションロックを開放します。

メソッドの詳細

Boolean lockRequestScope (String name) static
リクエストに紐付くアプリケーションロックを開始します。

この関数はNewLock#lock(String)関数と同様の機能を提供しますが、 現在のリクエストが終了する際(=レスポンスを返却する際)にロックを自動的に開放します。

この関数を利用すると、ロックが開始されるまですっと処理が止まってしまうため、通常はNewLock#tryLockRequestScope関数を利用することを推奨します。
パラメータ
name : String
ロックカテゴリキーワード
返却値
Boolean
Boolean true : ロック開始成功 / false : ロック開始失敗
Boolean lock (String name) static
アプリケーションロックを開始します。

指定のカテゴリキーワードにてロックを開始します。
既に同じカテゴリキーワードでロックされている場合は、ロックが開放されるまで待機します。

この関数を利用すると、ロックが開始されるまですっと処理が止まってしまうため、通常はNewLock#tryLock関数を利用することを推奨します。
パラメータ
name : String
ロックカテゴリキーワード
返却値
Boolean
Boolean true : ロック開始成功 / false : ロック開始失敗
Boolean run (String name, Function function, Number timeout) static
アプリケーションロックを開始して、指定の関数を実行します。

指定したカテゴリキーワードでのロック開始後に、指定された処理関数を実行します。
処理関数の実行が終了した後、自動的にロックは開放されます。
パラメータ
name : String
ロックカテゴリキーワード
function : Function
ロック中に行う処理関数
timeout : Number
ロック開始要求の待ち時間 (秒)
返却値
Boolean
Boolean true : ロック中の処理が正常に終了 / false : ロック開始失敗もしくはロック中の処理で例外が発生
Boolean tryLockRequestScope (String name, Number timeout) static
リクエストに紐付くアプリケーションロックの開始要求を行ないます。

この関数はNewLock#tryLock関数と同様の機能を提供しますが、 現在のリクエストが終了する際(=レスポンスを返却する際)にロックを自動的に開放します。
パラメータ
name : String
ロックカテゴリキーワード
timeout : Number
ロック開始要求の待ち時間 (秒)
返却値
Boolean
Boolean true : ロック開始成功 / false : ロック開始失敗
Boolean tryLock (String name, Number timeout) static
アプリケーションロックの開始要求を行ないます。

指定したカテゴリキーワードでのロック開始要求を行ないます。
既に同じカテゴリキーワードでロックされている場合は、ロック開始要求の待ち時間に指定した秒数の間、ロックの開始を待ちます。
ロック開始要求の待ち時間内にロックが開始できなかった場合はfalseを返却します。

timeout0 を指定した場合、ロックフラグが解除されるまで待機します。
パラメータ
name : String
ロックカテゴリキーワード
timeout : Number
ロック開始要求の待ち時間 (秒)
返却値
Boolean
Boolean true : ロック開始成功 / false : ロック開始失敗
Boolean unlock (String name) static
アプリケーションロックを開放します。

指定のカテゴリキーワードにてロックの開放処理をします。
指定のカテゴリキーワードがロック中である場合も、ロック中でない 場合もロック開放処理を行います。
パラメータ
name : String
ロックカテゴリキーワード
返却値
Boolean
Boolean true : ロック解放成功 / false : ロック解放失敗