Class: ActionCable::Connection::Subscriptions

Inherits:
Object
  • Object
show all
Defined in:
actioncable/lib/action_cable/connection/subscriptions.rb

Overview

Action Cable Connection Subscriptions

Collection class for all the channel subscriptions established on a given connection. Responsible for routing incoming commands that arrive on the connection to the proper channel.

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Subscriptions

Returns a new instance of Subscriptions.



12
13
14
15
 
# File 'actioncable/lib/action_cable/connection/subscriptions.rb', line 12

def initialize(connection)
  @connection = connection
  @subscriptions = {}
end

Instance Method Details

#add(data) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'actioncable/lib/action_cable/connection/subscriptions.rb', line 30

def add(data)
  id_key = data["identifier"]
  id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access

  return if subscriptions.key?(id_key)

  subscription_klass = id_options[:channel].safe_constantize

  if subscription_klass && ActionCable::Channel::Base > subscription_klass
    subscription = subscription_klass.new(connection, id_key, id_options)
    subscriptions[id_key] = subscription
    subscription.subscribe_to_channel
  else
    logger.error "Subscription class not found: #{id_options[:channel].inspect}"
  end
end

#execute_command(data) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'actioncable/lib/action_cable/connection/subscriptions.rb', line 17

def execute_command(data)
  case data["command"]
  when "subscribe"   then add data
  when "unsubscribe" then remove data
  when "message"     then perform_action data
  else
    logger.error "Received unrecognized command in #{data.inspect}"
  end
rescue Exception => e
  @connection.rescue_with_handler(e)
  logger.error "Could not execute command from (#{data.inspect}) [#{e.class} - #{e.message}]: #{e.backtrace.first(5).join(" | ")}"
end

#identifiers ⇒ Object 



61
62
63
 
# File 'actioncable/lib/action_cable/connection/subscriptions.rb', line 61

def identifiers
  subscriptions.keys
end

#perform_action(data) ⇒ Object 



57
58
59
 
# File 'actioncable/lib/action_cable/connection/subscriptions.rb', line 57

def perform_action(data)
  find(data).perform_action ActiveSupport::JSON.decode(data["data"])
end

#remove(data) ⇒ Object 



47
48
49
50
 
# File 'actioncable/lib/action_cable/connection/subscriptions.rb', line 47

def remove(data)
  logger.info "Unsubscribing from channel: #{data['identifier']}"
  remove_subscription find(data)
end

#remove_subscription(subscription) ⇒ Object 



52
53
54
55
 
# File 'actioncable/lib/action_cable/connection/subscriptions.rb', line 52

def remove_subscription(subscription)
  subscription.unsubscribe_from_channel
  subscriptions.delete(subscription.identifier)
end

#unsubscribe_from_all ⇒ Object 



65
66
67
 
# File 'actioncable/lib/action_cable/connection/subscriptions.rb', line 65

def unsubscribe_from_all
  subscriptions.each { |id, channel| remove_subscription(channel) }
end