メインコンテンツへ移動

キューを空にする (LCC.kvdb.queue.clear)

宣言​

values, err = LCC.kvdb.queue.clear(name, timeout?)

引数​

  • name
    文字列。キュー名です（空文字列は不可、最大 256 バイト）
  • timeout
    任意の数値。リクエストのタイムアウト（秒）です。既定値は 60 です

戻り値​

  • values
    テーブル。消去前のすべての要素です。キューがもともと空の場合も空の配列を返し、失敗時は nil になります
  • err
    文字列または nil。失敗時のエラー説明です

説明​

キューを空にし、それまでの要素のスナップショットを返します。
状態の一括リセットやデータ移行に適しています。

例​

local removed, err = LCC.kvdb.queue.clear("処理待ち")
if removed then
    LCC.log(1, "キューを空にしました", #removed)
end