collectgarbage
ガベージコレクタを制御する
lua
collectgarbage ([opt [, arg]])
説明
この関数は、ガベージコレクタを制御するための汎用インターフェースです。最初の引数 opt
によって、さまざまな機能を実行します:
opt | 説明 |
---|---|
"collect" | 完全なガベージコレクションサイクルを実行します(これがデフォルトのオプションです)。 |
"stop" | ガベージコレクタを停止します。 |
"restart" | ガベージコレクタを再起動します。 |
"count" | Lua が使用している総メモリ量(キロバイト単位)を返します。 |
"step" | ガベージコレクションのステップを実行します。ステップの「サイズ」は arg によって制御され(値が大きいほど多くのステップを実行)、具体的な方法は指定されていません。ステップサイズを細かく制御したい場合は、arg の値を調整してください。コレクションサイクルが終了した場合は true を返します。 |
"setpause" | ガベージコレクタの一時停止パラメータを arg の値に設定し、以前の値を返します。 |
"setstepmul" | ガベージコレクタのステップ倍率を arg の値に設定し、以前の値を返します。 |
サンプルコード
lua
collectgarbage("collect")
この例では、ガベージコレクタが強制的に実行されます。
互換性
- Lua5.1