Module: ActionCable::Channel::Callbacks
| Relationships & Source Files | |
| Namespace Children | |
| Modules: | |
| Extension / Inclusion / Inheritance Descendants | |
| Included In: | |
| Super Chains via Extension / Inclusion / Inheritance | |
| Class Chain: | |
| Instance Chain: | |
| Defined in: | actioncable/lib/action_cable/channel/callbacks.rb | 
Overview
Action Cable ::ActionCable::Channel provides callback hooks that are invoked during the life
cycle of a channel:
- before_subscribe
- after_subscribe (aliased as on_subscribe)
- before_unsubscribe
- after_unsubscribe (aliased as on_unsubscribe)
Example
class ChatChannel < ApplicationCable::Channel
  after_subscribe :, unless: :subscription_rejected?
  after_subscribe :track_subscription
  private
    def 
      broadcast_to(...)
    end
    def track_subscription
      # ...
    end
endConstant Summary
::ActiveSupport::Callbacks - Included
  
::ActiveSupport::Callbacks - Attributes & Methods
- .__callbacks rw
- #__callbacks readonly
- .__callbacks? ⇒ Boolean rw
- #__callbacks? ⇒ Boolean readonly
Class Method Summary
::ActiveSupport::DescendantsTracker - self
::ActiveSupport::Concern - Extended
| class_methods | Define class methods from given block. | 
| included | Evaluate given block in context of base class, so that you can write class macros here. | 
| prepended | Evaluate given block in context of base class, so that you can write class macros here. | 
Instance Method Summary
::ActiveSupport::Callbacks - Included
| #run_callbacks | Runs the callbacks for the given event. | 
DSL Calls
included
[ GitHub ]42 43 44 45
# File 'actioncable/lib/action_cable/channel/callbacks.rb', line 42
included do define_callbacks :subscribe define_callbacks :unsubscribe end
Class Attribute Details
.__callbacks (rw)
[ GitHub ]# File 'activesupport/lib/active_support/callbacks.rb', line 70
class_attribute :__callbacks, instance_writer: false, default: {}
    .__callbacks?  ⇒ Boolean  (rw)
  
  [ GitHub ]
# File 'activesupport/lib/active_support/callbacks.rb', line 70
class_attribute :__callbacks, instance_writer: false, default: {}
Instance Attribute Details
#__callbacks (readonly)
[ GitHub ]# File 'activesupport/lib/active_support/callbacks.rb', line 70
class_attribute :__callbacks, instance_writer: false, default: {}
    #__callbacks?  ⇒ Boolean  (readonly)
  
  [ GitHub ]
# File 'activesupport/lib/active_support/callbacks.rb', line 70
class_attribute :__callbacks, instance_writer: false, default: {}