module GC

要約

GC は Ruby インタプリタの「ゴミ集め(Garbage Collection)」を制御するモジュールです。

[SEE_ALSO] ObjectSpace

目次

特異メソッド

• count
• disable
• enable
• start
• stat
• stress
• stress=

インスタンスメソッド

• garbage_collect

特異メソッド

count -> Integer[permalink][rdoc]

プロセス開始からガーベージコレクトを実行した回数を Integer で返します。

disable -> bool[permalink][rdoc]

ガーベージコレクトを禁止します。

前回の禁止状態を返します(禁止されていたなら true, GC が有効であったなら、 false)。

[SEE_ALSO] GC.enable

enable -> bool[permalink][rdoc]

ガーベージコレクトを許可します。

前回の禁止状態を返します(禁止されていたなら true, GC が有効であったなら、 false)。

[SEE_ALSO] GC.disable

start -> nil[permalink][rdoc]

ガーベージコレクトを開始します。

GC#garbage_collect や ObjectSpace.#garbage_collect と同じ働きをします。 GC.disable により GC が禁止されている場合は何もしません。

nil を返します。

stat(result_hash = {}) -> {Symbol => Integer}[permalink][rdoc]

GC 内部の統計情報を Hash で返します。

[PARAM] result_hash:

戻り値のためのハッシュを指定します。省略した場合は新しくハッシュを作成します。result_hash の内容は上書きされます。

[RETURN]

GC 内部の統計情報をHash で返します。

GC.stat
# =>
{
  :count          => 18,
  :heap_used      => 77,
  :heap_length    => 77,
  :heap_increment => 0,
  :heap_live_num  => 23287,
  :heap_free_num  => 8115,
  :heap_final_num => 0,
}

戻り値のハッシュは処理系に依存します。これは将来変更になるかもしれません。

本メソッドは C Ruby 以外では動作しません。

stress -> bool[permalink][rdoc]

stress=(value)

GC.stress が真に設定されている間は、GC を行えるすべての機会に GC を行います。

[PARAM] value:

任意のオブジェクト。真偽値として解釈されます。

インスタンスメソッド

garbage_collect -> nil[permalink][rdoc]

ガーベージコレクトを開始します。

GC.start や ObjectSpace.#garbage_collect と同じ働きをします。 GC.disable により GC が禁止されている場合は何もしません。

nil を返します。