Class: ActionCable::Server::Configuration
Relationships & Source Files | |
Inherits: | Object |
Defined in: | actioncable/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.
Class Method Summary
- .new ⇒ Configuration constructor
Instance Attribute Summary
- #allow_same_origin_as_host rw
- #allowed_request_origins rw
- #cable rw
- #connection_class rw
- #disable_request_forgery_protection rw
- #log_tags rw
- #logger rw
- #mount_path rw
- #url rw
- #worker_pool_size rw
Instance Method Summary
-
#pubsub_adapter
Returns constant of subscription adapter specified in config/cable.yml.
Constructor Details
.new ⇒ Configuration
# File 'actioncable/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 (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 10
attr_accessor :disable_request_forgery_protection, :allowed_request_origins, :allow_same_origin_as_host
#allowed_request_origins (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 10
attr_accessor :disable_request_forgery_protection, :allowed_request_origins, :allow_same_origin_as_host
#cable (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 11
attr_accessor :cable, :url, :mount_path
#connection_class (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 9
attr_accessor :connection_class, :worker_pool_size
#disable_request_forgery_protection (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 10
attr_accessor :disable_request_forgery_protection, :allowed_request_origins, :allow_same_origin_as_host
#log_tags (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 8
attr_accessor :logger, :
#logger (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 8
attr_accessor :logger, :
#mount_path (rw)
[ GitHub ]#url (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 11
attr_accessor :cable, :url, :mount_path
#worker_pool_size (rw)
[ GitHub ]# File 'actioncable/lib/action_cable/server/configuration.rb', line 9
attr_accessor :connection_class, :worker_pool_size
Instance Method Details
#pubsub_adapter
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.
# File 'actioncable/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.}", e.backtrace end end adapter = adapter.camelize adapter = "PostgreSQL" if adapter == "Postgresql" "ActionCable::SubscriptionAdapter::#{adapter}".constantize end