Class: ActionCable::Server::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/action_cable/server/configuration.rb

Overview

An instance of this configuration object is available via ActionCable.server.config, which allows you to tweak Action Cable configuration in a Rails config initializer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.

[View source]

13
14
15
16
17
18
19
20
21
 
# File 'lib/action_cable/server/configuration.rb', line 13

def initialize
  @log_tags = []

  @connection_class = -> { ActionCable::Connection::Base }
  @worker_pool_size = 4

  @disable_request_forgery_protection = false
  @allow_same_origin_as_host = true
end

Instance Attribute Details

#allow_same_origin_as_host ⇒ Object

Returns the value of attribute allow_same_origin_as_host.


10
11
12
 
# File 'lib/action_cable/server/configuration.rb', line 10

def allow_same_origin_as_host
  @allow_same_origin_as_host
end

#allowed_request_origins ⇒ Object

Returns the value of attribute allowed_request_origins.


10
11
12
 
# File 'lib/action_cable/server/configuration.rb', line 10

def allowed_request_origins
  @allowed_request_origins
end

#cable ⇒ Object

Returns the value of attribute cable.


11
12
13
 
# File 'lib/action_cable/server/configuration.rb', line 11

def cable
  @cable
end

#connection_class ⇒ Object

Returns the value of attribute connection_class.


9
10
11
 
# File 'lib/action_cable/server/configuration.rb', line 9

def connection_class
  @connection_class
end

#disable_request_forgery_protection ⇒ Object

Returns the value of attribute disable_request_forgery_protection.


10
11
12
 
# File 'lib/action_cable/server/configuration.rb', line 10

def disable_request_forgery_protection
  @disable_request_forgery_protection
end

#log_tags ⇒ Object

Returns the value of attribute log_tags.


8
9
10
 
# File 'lib/action_cable/server/configuration.rb', line 8

def log_tags
  @log_tags
end

#logger ⇒ Object

Returns the value of attribute logger.


8
9
10
 
# File 'lib/action_cable/server/configuration.rb', line 8

def logger
  @logger
end

#mount_path ⇒ Object

Returns the value of attribute mount_path.


11
12
13
 
# File 'lib/action_cable/server/configuration.rb', line 11

def mount_path
  @mount_path
end

#url ⇒ Object

Returns the value of attribute url.


11
12
13
 
# File 'lib/action_cable/server/configuration.rb', line 11

def url
  @url
end

#worker_pool_size ⇒ Object

Returns the value of attribute worker_pool_size.


9
10
11
 
# File 'lib/action_cable/server/configuration.rb', line 9

def worker_pool_size
  @worker_pool_size
end

Instance Method Details

#pubsub_adapter ⇒ Object

Returns constant of subscription adapter specified in config/cable.yml. If the adapter cannot be found, this will default to the Redis adapter. Also makes sure proper dependencies are required.

[View source]

26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/action_cable/server/configuration.rb', line 26

def pubsub_adapter
  adapter = (cable.fetch("adapter") { "redis" })

  # Require the adapter itself and give useful feedback about
  #   1. Missing adapter gems and
  #   2. Adapter gems' missing dependencies.
  path_to_adapter = "action_cable/subscription_adapter/#{adapter}"
  begin
    require path_to_adapter
  rescue LoadError => e
    # We couldn't require the adapter itself. Raise an exception that
    # points out config typos and missing gems.
    if e.path == path_to_adapter
      # We can assume that a non-builtin adapter was specified, so it's
      # either misspelled or missing from Gemfile.
      raise e.class, "Could not load the '#{adapter}' Action Cable pubsub adapter. Ensure that the adapter is spelled correctly in config/cable.yml and that you've added the necessary adapter gem to your Gemfile.", e.backtrace

    # Bubbled up from the adapter require. Prefix the exception message
    # with some guidance about how to address it and reraise.
    else
      raise e.class, "Error loading the '#{adapter}' Action Cable pubsub adapter. Missing a gem it depends on? #{e.message}", e.backtrace
    end
  end

  adapter = adapter.camelize
  adapter = "PostgreSQL" if adapter == "Postgresql"
  "ActionCable::SubscriptionAdapter::#{adapter}".constantize
end