跳到内容 跳到搜索

Action Cable Server Base

可以通过 ActionCable.server 访问单例 ActionCable::Server 实例。它由启动 Action Cable 服务器的 Rack 进程使用，但也由用户用于访问 RemoteConnections 对象，该对象用于查找和断开所有服务器上的连接。

此外，这是用于广播的服务器实例。有关更多信息，请参阅 Broadcasting。

方法
C
D
E
L
N
P
R
W
包含的模块

属性

[R] config
[R] mutex

类公共方法

logger()

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 26
def self.logger; config.logger; end

new(config: self.class.config)

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 31
def initialize(config: self.class.config)
  @config = config
  @mutex = Monitor.new
  @remote_connections = @event_loop = @worker_pool = @pubsub = nil
end

实例公共方法

call(env)

由 Rack 调用以设置服务器。

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 38
def call(env)
  return config.health_check_application.call(env) if env["PATH_INFO"] == config.health_check_path
  setup_heartbeat_timer
  config.connection_class.call.new(self, env).process
end

connection_identifiers()

与该服务器关联的连接类应用的所有标识符。

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 102
def connection_identifiers
  config.connection_class.call.identifiers
end

disconnect(identifiers)

通过 RemoteConnections 断开此服务器或任何其他服务器上由 identifiers 标识的所有连接。

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 46
def disconnect(identifiers)
  remote_connections.where(identifiers).disconnect
end

event_loop()

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 71
def event_loop
  @event_loop || @mutex.synchronize { @event_loop ||= ActionCable::Connection::StreamEventLoop.new }
end

pubsub()

用于所有流/广播的适配器。

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 96
def pubsub
  @pubsub || @mutex.synchronize { @pubsub ||= config.pubsub_adapter.new(self) }
end

remote_connections()

到 RemoteConnections 的网关。有关详细信息，请参阅该类。

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 67
def remote_connections
  @remote_connections || @mutex.synchronize { @remote_connections ||= RemoteConnections.new(self) }
end

restart()

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 50
def restart
  connections.each do |connection|
    connection.close(reason: ActionCable::INTERNAL[:disconnect_reasons][:server_restart])
  end

  @mutex.synchronize do
    # Shutdown the worker pool
    @worker_pool.halt if @worker_pool
    @worker_pool = nil

    # Shutdown the pub/sub adapter
    @pubsub.shutdown if @pubsub
    @pubsub = nil
  end
end

worker_pool()

工作池是我们在其中运行连接回调和通道操作的地方。我们在服务器的主线程上尽可能少做。工作池是一个执行器服务，它由一组从任务队列中工作的线程支持。线程池大小默认情况下最大为 4 个工作线程。使用 config.action_cable.worker_pool_size 自行调整大小。

在你的通道操作中使用 Active Record、Redis 等意味着你将从工作池中的每个线程获得一个单独的连接。相应地规划你的部署：5 台服务器，每台服务器运行 5 个 Puma 工作线程，每个工作线程运行一个 8 线程工作池，这意味着至少 200 个数据库连接。

此外，确保你的数据库连接池大小至少与你的工作池大小一样大。否则，工作线程可能会过度订阅数据库连接池并在等待其他工作线程释放连接时阻塞。改用较小的工作池或较大的数据库连接池。

源代码: 显示 | 在 GitHub 上

# File actioncable/lib/action_cable/server/base.rb, line 91
def worker_pool
  @worker_pool || @mutex.synchronize { @worker_pool ||= ActionCable::Server::Worker.new(max_size: config.worker_pool_size) }
end