- Inheritance
This is a utility class that allows anything mixing it in to notify a set of listeners about interesting events.
Constants
| Name | Description | |
|---|---|---|
| NOTHING | = "NOTHING/#{__id__}" | We use this for defaults since nil might mean something |
Methods
Instance
| Visibility | Signature |
|---|---|
| public | add_listener (channel_name, listener_key=NOTHING) {|value| ...} |
| public | notify_listeners (channel_name, *arguments) |
| public | remove_listener (channel_name, listener_key) |
Instance Method Detail
add_listener(channel_name, listener_key=NOTHING) {|value| ...}
Adds the passed proc as a listener on the channel indicated by channel_name. listener_key is used to remove the listener later; if none is specified, the proc itself is used.
Whatever is used as the listener_key is returned, making it very easy to use the proc itself as the listener_key:
listener = add_listener("Channel") { ... }
remove_listener("Channel", listener)
notify_listeners(channel_name, *arguments)
Calls all the procs registered on the channel indicated by channel_name. If value is specified, it is passed in to the procs, otherwise they are called with no arguments.
remove_listener(channel_name, listener_key)
Removes the listener indicated by listener_key from the channel indicated by channel_name. Returns the registered proc, or nil if none was found.