コンストラクタの概要

SharedResource (String application, Object businessKeys)
コンストラクタ

メソッドの概要

返却値の型 メソッド名
String getApplication ()
アプリケーションを取得します。
Object getBusinessKeys ()
業務キーを取得します。
String getKey ()
このSharedResourceを一意に表すキーを返却します。
void notifyUpdate ()
クライアントに対してリソースの更新が行われたことを通知します。
Boolean runAndNotify (Function function, Number timeout)
ロックを獲得した場合、引数 function に受け渡された処理を実行します。
Boolean run (Function function, Number timeout)
ロックを獲得した場合、引数 function に受け渡された処理を実行します。
Boolean tryLockAndNotify (Number timeout)
ロックを獲得します。
Boolean tryLock (Number timeout)
ロックを獲得します。
void unlockAndNotify ()
ロックの解放を行います。
void unlock ()
ロックの解放を行います。

コンストラクタの詳細

SharedResource (String application, Object businessKeys)
コンストラクタ
SharedResourceオブジェクトを生成します。
アプリケーションは任意の文字列を指定します。(例: "my_app")
ビジネスキーはリソースを一意に表すキー/バリュー形式の値を指定してくだだい。(例: {appId: "123", appVersion: "3"})
パラメータ
application : String
アプリケーション
businessKeys : Object
業務キー

メソッドの詳細

String getApplication ()
アプリケーションを取得します。
返却値
String
String アプリケーション
Object getBusinessKeys ()
業務キーを取得します。
返却値
Object
Object 業務キー
String getKey ()
このSharedResourceを一意に表すキーを返却します。
返却値
String
String 一意キー
void notifyUpdate ()
クライアントに対してリソースの更新が行われたことを通知します。
返却値
void
Boolean runAndNotify (Function function, Number timeout)
ロックを獲得した場合、引数 function に受け渡された処理を実行します。
実行完了後にはロックを開放します。
ロックを獲得/開放した場合、クライアントに通知を行います。
この振る舞いは、クライアントに対してリソースの更新通知は行いません、必要に応じて runnableの処理中において SharedResource#notifyUpdate()を呼び出しリソースの更新をクライアントに通知する必要があります。
パラメータ
function : Function
実行する処理
timeout : Number
タイムアウト(秒)
返却値
Boolean
Boolean ロック獲得及び実行に成功した場合true, ロック獲得に失敗した場合: false
Boolean run (Function function, Number timeout)
ロックを獲得した場合、引数 function に受け渡された処理を実行します。
実行完了後にはロックを開放します。
パラメータ
function : Function
実行する処理
timeout : Number
タイムアウト(秒)
返却値
Boolean
Boolean ロック獲得及び実行に成功した場合true, ロック獲得に失敗した場合: false
Boolean tryLockAndNotify (Number timeout)
ロックを獲得します。
ロックを獲得した場合、クライアント側に対してロック獲得を通知します。
timeout0 を指定した場合、ロックフラグが解除されるまで待機します。
パラメータ
timeout : Number
タイムアウト(秒)
返却値
Boolean
Boolean ロック獲得した場合: true, 失敗した場合: false
Boolean tryLock (Number timeout)
ロックを獲得します。
timeout0 を指定した場合、ロックフラグが解除されるまで待機します。
TimeUnit) を利用します。
パラメータ
timeout : Number
タイムアウト(秒)
返却値
Boolean
Boolean ロック獲得した場合: true, 失敗した場合: false
void unlockAndNotify ()
ロックの解放を行います。
このインスタンス以外で同一のリソースに対して獲得したロックに対しても開放を行います。
開放した際に、クライアントに対して通知が行われます。
返却値
void
void unlock ()
ロックの解放を行います。
このインスタンス以外で同一のリソースに対して獲得したロックに対しても開放を行います。
返却値
void