要約
イベントに対して通知を行うメソッドを提供するモジュールです。
目次
- インスタンスメソッド
インスタンスメソッド
add_listener(channel_name, listener_key = NOTHING, &listener) -> String[permalink][rdoc]-
channel_name で指定したチャンネルに listener を登録します。
listener_key を省略した場合は listener 自身を listener を削除する時のキーとして登録します。
- [PARAM] channel_name:
- チャンネルの名前を文字列で指定します。
- [PARAM] listener_key:
- listener を削除する時のキーを文字列で指定します。
- [RETURN]
- listener_key を返します。
notify_listeners(channel_name, *arguments) -> Integer[permalink][rdoc]-
channel_name で指定したチャンネルにある全ての Proc を実行します。
arguments が指定されていた場合は Proc を call する時の引数に arguments を渡します。
- [PARAM] channel_name:
- チャンネルの名前を文字列で指定します。
- [PARAM] arguments:
- Proc に渡す引数を指定します。
- [RETURN]
- Proc を実行した数を返します。
remove_listener(channel_name, listener_key) -> Proc | nil[permalink][rdoc]-
listener_key で指定したキーで登録された listener を channel_name で指定したチャンネルから削除します。
- [PARAM] channel_name:
- チャンネルの名前を文字列で指定します。
- [PARAM] listener_key:
- listener を削除する時のキーを指定します。
- [RETURN]
- 削除に成功した場合は登録されていた Proc オブジェクトを返します。そうでない場合は nil を返します。