ObjectSpace

全てのオブジェクトを操作するためのモジュール。

モジュール関数:

ObjectSpace._id2ref(id)

オブジェクト ID(Object#id)からオブジェクトを得ます。対応するオブジェクトが存在しなければ例外 RangeError が発生します。

ObjectSpace.define_finalizer(obj, proc)

ObjectSpace.define_finalizer(obj) {|id| ...}

obj が解放されるときに実行されるファイナライザ proc を登録します。同じオブジェクトについて複数回呼ばれたときは置き換えではなく追加登録されます。

proc には、ファイナライザとして Proc オブジェクトを渡します。ブロックを指定した場合は、そのブロックが proc になります(しかし、後述の問題があるのでブロックでファイナライザを登録するのは難しいです)。

ファイナライザ proc には引数として obj の ID(Object#id) が渡されます。

以下は、define_finalizer の使い方の悪い例です。

class Foo
  def initialize
    ObjectSpace.define_finalizer(self) {
      puts "foo"
    }
  end
end
Foo.new
GC.start

これは、渡された proc の self が obj を参照しつづけるため。そのオブジェクトが GC の対象になりません。

[ruby-src:lib/tempfile.rb] は、ファイナライザの使い方の良い例になっています。これは、クラスのコンテキストで Proc を生成することで上記の問題を回避しています。

class Bar
  def Bar.callback
    proc {
      puts "bar"
    }
  end
  def initialize
    ObjectSpace.define_finalizer(self, Bar.callback)
  end
end
Bar.new
GC.start

proc の呼び出しで発生した大域脱出(exitや例外)は無視されます。これは、スクリプトのメイン処理が GC の発生によって非同期に中断されるのを防ぐためです。不安なうちは -d オプションで事前に例外の発生の有無を確認しておいた方が良いでしょう。

class Baz
  def initialize
    ObjectSpace.define_finalizer self, eval %q{
      proc {
        raise "baz" rescue puts $!
        raise "baz2"
        puts "baz3"
      }
    }, TOPLEVEL_BINDING
  end
end
Baz.new
GC.start

# => baz

ObjectSpace.each_object([class_or_module]) {|object| ...}

class_or_module と kind_of? の関係にある全てのオブジェクトに対して繰り返します。引数が省略された時には全てのオブジェクトに対して繰り返します。

class_or_module に Fixnum や Symbol を指定しても何も繰り返しません。

繰り返した数を返します。

ObjectSpace.garbage_collect

どこからもアクセスされなくなったオブジェクトを回収します。 GC#start と同じです。

nil を返します。

ObjectSpace.undefine_finalizer(obj)

obj に対するファイナライザをすべて解除します。

obj を返します。

以下は、ファイナライザの古いインタフェースです。使用すると警告メッセージが出力されます。

ObjectSpace.add_finalizer(proc) ((<obsolete>))

proc をファイナライザとして設定します。

call_finalizer で指定したオブジェクトが開放される時、そのオブジェクトの ID(c.f Object#id)を引数にファイナライザが評価されます。

proc を返します。

このメソッドは、obsolete です。代わりに ObjectSpace.define_finalizer を使用してください

ObjectSpace.call_finalizer(obj) ((<obsolete>))

obj をファイナライザの対象オブジェクトとして設定します。

obj を返します。

このメソッドは、obsolete です。

ObjectSpace.finalizers ((<obsolete>))

現在登録されているファイナライザの配列を返します。

このメソッドは、obsolete です。

ObjectSpace.remove_finalizer(proc) ((<obsolete>))

指定した proc をファイナライザから取り除きます。

proc を返します。

このメソッドは、obsolete です。代わりに ObjectSpace.undefine_finalizer を使用してください。