aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support
diff options
context:
space:
mode:
authorGuo Xiang Tan <tgx_world@hotmail.com>2014-06-01 13:40:07 -0700
committerGuo Xiang Tan <tgx_world@hotmail.com>2014-06-01 13:48:24 -0700
commita67fdc0256a88eeabd6cef6743bb480c9889642f (patch)
tree475829c351285a93f2c6eac9332062b9838df7f5 /activesupport/lib/active_support
parent02ee081cd645b51cbdfb28cd305777d3257ad871 (diff)
downloadrails-a67fdc0256a88eeabd6cef6743bb480c9889642f.tar.gz
rails-a67fdc0256a88eeabd6cef6743bb480c9889642f.tar.bz2
rails-a67fdc0256a88eeabd6cef6743bb480c9889642f.zip
Update documentation to reflect unsubscription with name.
Diffstat (limited to 'activesupport/lib/active_support')
-rw-r--r--activesupport/lib/active_support/notifications.rb9
-rw-r--r--activesupport/lib/active_support/notifications/fanout.rb4
2 files changed, 9 insertions, 4 deletions
diff --git a/activesupport/lib/active_support/notifications.rb b/activesupport/lib/active_support/notifications.rb
index 7a96c66626..325a3d75dc 100644
--- a/activesupport/lib/active_support/notifications.rb
+++ b/activesupport/lib/active_support/notifications.rb
@@ -141,6 +141,11 @@ module ActiveSupport
#
# ActiveSupport::Notifications.unsubscribe(subscriber)
#
+ # You can also unsubscribe by passing the name of the subscriber object. Note
+ # that this will unsubscribe all subscriptions with the given name:
+ #
+ # ActiveSupport::Notifications.unsubscribe("render")
+ #
# == Default Queue
#
# Notifications ships with a queue implementation that consumes and publishes events
@@ -173,8 +178,8 @@ module ActiveSupport
unsubscribe(subscriber)
end
- def unsubscribe(args)
- notifier.unsubscribe(args)
+ def unsubscribe(subscriber_or_name)
+ notifier.unsubscribe(subscriber_or_name)
end
def instrumenter
diff --git a/activesupport/lib/active_support/notifications/fanout.rb b/activesupport/lib/active_support/notifications/fanout.rb
index 8f5fa646e8..5f0bc3dca0 100644
--- a/activesupport/lib/active_support/notifications/fanout.rb
+++ b/activesupport/lib/active_support/notifications/fanout.rb
@@ -25,9 +25,9 @@ module ActiveSupport
subscriber
end
- def unsubscribe(subscriber)
+ def unsubscribe(subscriber_or_name)
synchronize do
- @subscribers.reject! { |s| s.matches?(subscriber) }
+ @subscribers.reject! { |s| s.matches?(subscriber_or_name) }
@listeners_for.clear
end
end