123456789_123456789_123456789_123456789_123456789_

Module: ActionCable::Channel::Callbacks

Relationships & Source Files
Namespace Children
Modules:
ClassMethods
Extension / Inclusion / Inheritance Descendants
Included In:
Base
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveSupport::DescendantsTracker, ::ActiveSupport::Concern
Instance Chain:
self, ::ActiveSupport::Callbacks
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](ClassMethods#before_subscribe)

  • [after_subscribe](ClassMethods#after_subscribe) (aliased as [on_subscribe](ClassMethods#on_subscribe))

  • [before_unsubscribe](ClassMethods#before_unsubscribe)

  • [after_unsubscribe](ClassMethods#after_unsubscribe) (aliased as [on_unsubscribe](ClassMethods#on_unsubscribe))

Example

class ChatChannel < ApplicationCable::Channel
  after_subscribe :send_welcome_message, unless: :subscription_rejected?
  after_subscribe :track_subscription

  private
    def send_welcome_message
      broadcast_to(...)
    end

    def track_subscription
      # ...
    end
end

Constant Summary

::ActiveSupport::Callbacks - Included

CALLBACK_FILTER_TYPES

::ActiveSupport::Callbacks - Attributes & Methods

Class Method Summary

::ActiveSupport::DescendantsTracker - self

descendants, subclasses, clear, disable_clear!, reject!

::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.
append_features, prepend_features

Instance Method Summary

::ActiveSupport::Callbacks - Included

#run_callbacks

Runs the callbacks for the given event.
#halted_callback_hook

A hook invoked every time a before callback is halted.

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: {}