Contents

# frozen_string_literal: true

# :markup: markdown

require "active_support/callbacks"

module ActionCable
  module Connection
    # # Action Cable Connection Callbacks
    #
    # The [before_command](rdoc-ref:ClassMethods#before_command),
    # [after_command](rdoc-ref:ClassMethods#after_command), and
    # [around_command](rdoc-ref:ClassMethods#around_command) callbacks are invoked
    # when sending commands to the client, such as when subscribing, unsubscribing,
    # or performing an action.
    #
    # #### Example
    #
    #     module ApplicationCable
    #       class Connection < ActionCable::Connection::Base
    #         identified_by :user
    #
    #         around_command :set_current_account
    #
    #         private
    #
    #         def set_current_account
    #           # Now all channels could use Current.account
    #           Current.set(account: user.account) { yield }
    #         end
    #       end
    #     end
    #
    module Callbacks
      extend  ActiveSupport::Concern
      include ActiveSupport::Callbacks

      included do
        define_callbacks :command
      end

      module ClassMethods
        def before_command(*methods, &block)
          set_callback(:command, :before, *methods, &block)
        end

        def after_command(*methods, &block)
          set_callback(:command, :after, *methods, &block)
        end

        def around_command(*methods, &block)
          set_callback(:command, :around, *methods, &block)
        end
      end
    end
  end
end

Version data entries

27 entries across 27 versions & 3 rubygems

Version	Path
actioncable-8.0.2	lib/action_cable/connection/callbacks.rb
actioncable-next-0.2.0	lib/action_cable/connection/callbacks.rb
actioncable-next-0.1.2	lib/action_cable/connection/callbacks.rb
actioncable-8.0.1	lib/action_cable/connection/callbacks.rb
actioncable-8.0.0.1	lib/action_cable/connection/callbacks.rb
actioncable-7.2.2.1	lib/action_cable/connection/callbacks.rb
actioncable-8.0.0	lib/action_cable/connection/callbacks.rb
actioncable-7.2.2	lib/action_cable/connection/callbacks.rb
actioncable-8.0.0.rc2	lib/action_cable/connection/callbacks.rb
actioncable-7.2.1.2	lib/action_cable/connection/callbacks.rb
actioncable-8.0.0.rc1	lib/action_cable/connection/callbacks.rb
actioncable-7.2.1.1	lib/action_cable/connection/callbacks.rb
actioncable-next-0.1.1	lib/action_cable/connection/callbacks.rb
actioncable-next-0.1.0	lib/action_cable/connection/callbacks.rb
actioncable-8.0.0.beta1	lib/action_cable/connection/callbacks.rb
omg-actioncable-8.0.0.alpha9	lib/action_cable/connection/callbacks.rb
omg-actioncable-8.0.0.alpha8	lib/action_cable/connection/callbacks.rb
omg-actioncable-8.0.0.alpha7	lib/action_cable/connection/callbacks.rb
omg-actioncable-8.0.0.alpha4	lib/action_cable/connection/callbacks.rb
omg-actioncable-8.0.0.alpha3	lib/action_cable/connection/callbacks.rb