mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
8305437385
* Properly indent code sample in ActionCable::Channel::Streams * Add a doc comment for #stop_all_streams * Reformat + add <tt> blocks around code references in ActionCable::Base docs * Clarify and a little better grammar on ActionCable::RemoteConnections * Correct indentation and clean up ActionCable::Server::Broadcasting code sample
66 lines
2.1 KiB
Ruby
66 lines
2.1 KiB
Ruby
module ActionCable
|
|
# If you need to disconnect a given connection, you can go through the
|
|
# RemoteConnections. You can find the connections you're looking for by
|
|
# searching for the identifier declared on the connection. For example:
|
|
#
|
|
# module ApplicationCable
|
|
# class Connection < ActionCable::Connection::Base
|
|
# identified_by :current_user
|
|
# ....
|
|
# end
|
|
# end
|
|
#
|
|
# ActionCable.server.remote_connections.where(current_user: User.find(1)).disconnect
|
|
#
|
|
# This will disconnect all the connections established for
|
|
# <tt>User.find(1)</tt> across all servers running on all machines, because
|
|
# it uses the internal channel that all these servers are subscribed to.
|
|
class RemoteConnections
|
|
attr_reader :server
|
|
|
|
def initialize(server)
|
|
@server = server
|
|
end
|
|
|
|
def where(identifier)
|
|
RemoteConnection.new(server, identifier)
|
|
end
|
|
|
|
private
|
|
# Represents a single remote connection found via <tt>ActionCable.server.remote_connections.where(*)</tt>.
|
|
# Exists for the solely for the purpose of calling #disconnect on that connection.
|
|
class RemoteConnection
|
|
class InvalidIdentifiersError < StandardError; end
|
|
|
|
include Connection::Identification, Connection::InternalChannel
|
|
|
|
def initialize(server, ids)
|
|
@server = server
|
|
set_identifier_instance_vars(ids)
|
|
end
|
|
|
|
# Uses the internal channel to disconnect the connection.
|
|
def disconnect
|
|
server.broadcast internal_channel, type: 'disconnect'
|
|
end
|
|
|
|
# Returns all the identifiers that were applied to this connection.
|
|
def identifiers
|
|
server.connection_identifiers
|
|
end
|
|
|
|
private
|
|
attr_reader :server
|
|
|
|
def set_identifier_instance_vars(ids)
|
|
raise InvalidIdentifiersError unless valid_identifiers?(ids)
|
|
ids.each { |k,v| instance_variable_set("@#{k}", v) }
|
|
end
|
|
|
|
def valid_identifiers?(ids)
|
|
keys = ids.keys
|
|
identifiers.all? { |id| keys.include?(id) }
|
|
end
|
|
end
|
|
end
|
|
end
|